https://github.com/mailtoolbox/mail_plugger

Plug in required mailer(s) with MailPlugger.
https://github.com/mailtoolbox/mail_plugger

api aws-ses-api delivery deliverymethod email mailer mailgun-api mailing mandrill-api postmark-api rails ruby ruby-on-rails ruby-script sendgrid-api smtp sparkpost-api

Last synced: 4 months ago
JSON representation

Plug in required mailer(s) with MailPlugger.

• Host: GitHub
• URL: https://github.com/mailtoolbox/mail_plugger
• Owner: MailToolbox
• License: mit
• Created: 2020-12-25T18:06:26.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T22:53:45.000Z (about 1 year ago)
• Last Synced: 2025-02-08T13:37:41.533Z (about 1 year ago)
• Topics: api, aws-ses-api, delivery, deliverymethod, email, mailer, mailgun-api, mailing, mandrill-api, postmark-api, rails, ruby, ruby-on-rails, ruby-script, sendgrid-api, smtp, sparkpost-api
• Language: Ruby
• Homepage:
• Size: 572 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# MilPlugger

[![Gem Version](https://badge.fury.io/rb/mail_plugger.svg)](https://badge.fury.io/rb/mail_plugger)

[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen)](https://github.com/MailToolbox/mail_plugger/blob/main/LICENSE.txt)

[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)

[![MailPlugger CI](https://github.com/MailToolbox/mail_plugger/actions/workflows/mail_plugger_ci.yml/badge.svg)](https://github.com/MailToolbox/mail_plugger/actions/workflows/mail_plugger_ci.yml)

[![Maintainability](https://qlty.sh/gh/MailToolbox/projects/mail_plugger/maintainability.svg)](https://qlty.sh/gh/MailToolbox/projects/mail_plugger)

[![Code Coverage](https://qlty.sh/gh/MailToolbox/projects/mail_plugger/coverage.svg)](https://qlty.sh/gh/MailToolbox/projects/mail_plugger)

**MailPlugger** helps you to use one or more mail providers. You can send emails via SMTP and API as well.

Also, it can help:

- move between mail providers

- load balancing

- cost management

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'mail_plugger'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install mail_plugger

## Documentation

### What is MailPlugger?

It is a Ruby library that provides a specialized mail delivery method with various configuration options. It can be utilized with Ruby on Rails as well as other solutions.

### Why should I use MailPlugger?

- It supports more mail providers.

- It has built-in sending strategies, such as `plugged_in_first`, `random`, and `round_robin`, which are useful if you have multiple mail providers.

- Your code for the mailers can remain simple and clean.

- Switching mail providers can be a quick and easy process.

### How Tos

- [How to use MailPlugger.configure method](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_configure_method.md)

- [How to use MailPlugger.plug_in method](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_plug_in_method.md)

- [How to use MailPlugger::DeliveryMethod class](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_delivery_method.md)

- [How to use MailPlugger in a Ruby script or IRB console](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_in_script_or_console.md)

- [How to use MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_in_ruby_on_rails.md)

  - [How to use MailPlugger.configure method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_configure_method_in_ruby_on_rails.md)

  - [How to use more SMTP delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_more_smtp_delivery_systems_in_ruby_on_rails.md)

  - [How to combine SMTP and API delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_smtp_and_api_delivery_systems_in_ruby_on_rails.md)

  - [How to add API specific options to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_api_specific_options_in_ruby_on_rails.md)

  - [How to use the API delivery system that adds attachments to the mailer method in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_api_attachments_in_ruby_on_rails.md)

  - [How to use more API delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_more_api_delivery_systems_in_ruby_on_rails.md)

  - [How to use one API delivery system with more send methods in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_one_api_delivery_system_with_more_send_methods_in_ruby_on_rails.md)

  - [How to use one API delivery system with different configuration options in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_one_api_delivery_system_with_different_configuration_options_in_ruby_on_rails.md)

  - [How to use AWS SES API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_aws_ses_api_in_ruby_on_rails.md)

  - [How to use SparkPost API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sparkpost_api_in_ruby_on_rails.md)

  - [How to use SendGrid API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_sendgrid_api_in_ruby_on_rails.md)

  - [How to use Mandrill API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mandrill_api_in_ruby_on_rails.md)

  - [How to use Postmark API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_postmark_api_in_ruby_on_rails.md)

  - [How to use Mailgun API with MailPlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_mailgun_api_in_ruby_on_rails.md)

# FkePlugger

**FakePlugger** is a delivery method to mock **MailPlugger**. It works similarly to **MailPlugger**, but it won't send any emails (if we would like to, it is possible to send the email, but we should do it manually). Also, it can write out debug information, or we can manipulate the response with it. Another option that we can use **[MailGrabber](https://github.com/MailToolbox/mail_grabber)** web interface if the delivery method is `:fake_plugger`.

## Documentation

### How Tos

- [How to use FakePlugger::DeliveryMethod class](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_delivery_method.md)

- [How to use FakePlugger in a Ruby script or IRB console](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_in_script_or_console.md)

- [How to use FakePlugger in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_in_ruby_on_rails.md)

  - [How to use FakePlugger with more delivery systems in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_with_more_delivery_systems_in_ruby_on_rails.md)

  - [How to use FakePlugger with MailGrabber in Ruby on Rails](https://github.com/MailToolbox/mail_plugger/blob/main/docs/usage_of_fake_plugger_with_mail_grabber_in_ruby_on_rails.md)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

To release a new version:

- Update [CHANGELOG.md](https://github.com/MailToolbox/mail_plugger/blob/main/CHANGELOG.md)

- Update the version number in `version.rb` manually or use the `gem-release` gem and run `gem bump -v major|minor|patch|rc|beta`.

- Build gem with `bundle exec rake build`.

- Run `bundle install` and `bundle exec appraisal install` to update gemfiles and commit the changes.

- Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome. Please read [CONTRIBUTING.md](https://github.com/MailToolbox/mail_plugger/blob/main/CONTRIBUTING.md) if you would like to contribute to this project.

## Inspiration

- [T-mailer](https://github.com/100Starlings/t-mailer)

- [Mandrill DM](https://github.com/kshnurov/mandrill_dm)

- [SparkPost Rails](https://github.com/the-refinery/sparkpost_rails)

- and other solutions regarding in this topic

## License

The gem is available as open source under the terms of the [MIT License](https://github.com/MailToolbox/mail_plugger/blob/main/LICENSE.txt).