Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kortirso/emailbutler
Simple email tracker for Ruby on Rails applications. Emailbutler allows you to track sending params and delivery status of emails, resend them if required.
https://github.com/kortirso/emailbutler
action-mailer email rails ruby tracking
Last synced: 2 days ago
JSON representation
Simple email tracker for Ruby on Rails applications. Emailbutler allows you to track sending params and delivery status of emails, resend them if required.
- Host: GitHub
- URL: https://github.com/kortirso/emailbutler
- Owner: kortirso
- License: mit
- Created: 2022-09-01T16:59:31.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T11:27:21.000Z (3 months ago)
- Last Synced: 2025-01-16T18:20:57.109Z (9 days ago)
- Topics: action-mailer, email, rails, ruby, tracking
- Language: Ruby
- Homepage:
- Size: 182 KB
- Stars: 21
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Emailbutler
Simple email tracker for Ruby on Rails applications.
Emailbutler allows you to track delivery status of emails sent by your app through Sendgrid, SMTP2GO, Resend, Mailjet.
There are situations when you need to check whether a certain letter or certain type of letters was successfully sent from the application, and through the UI of some providers you can try to find such a letter by the recipient or the subject of the letter, but sometimes it's not enough.
Emailbutler allows you to monitor the sending of letters, collects notifications from providers about the success of delivery and adds an UI for monitoring deliveries with filtering by recipients, mailers and actions.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'emailbutler'
gem 'pagy'
```
And then execute:
```bash
$ bundle install
$ rails g emailbutler:active_record
$ rails db:migrate
```
## Engine configuration
### Initializer
Add configuration line to config/initializers/emailbutler.rb:
#### For ActiveRecord
```ruby
require 'emailbutler/adapters/active_record'
Emailbutler.configure do |config|
config.adapter = Emailbutler::Adapters::ActiveRecord.new # required
config.providers = %w[sendgrid smtp2go resend mailjet mailtrap mandrill] # optional
config.ui_username = 'username' # optional
config.ui_password = 'password' # optional
config.ui_secured_environments = ['production'] # optional
end
```
### Routes
Add this line to config/routes.rb
```ruby
mount Emailbutler::Engine => '/emailbutler'
```
#### Custom routes
If you need some custom behaviour you can specify your own route and use custom controller, something like
```ruby
class SendgridController < ApplicationController
skip_before_action :basic_authentication
skip_before_action :verify_authenticity_token
def create
... you can add some logic here
Emailbutler::Container.resolve(:webhooks_receiver).call(
mapper: Emailbutler::Container.resolve(:sendgrid_mapper),
payload: receiver_params
)
head :ok
end
private
def receiver_params
params.permit('event', 'sendtime', 'message-id').to_h
end
end
```
### Mailers
Update you application mailer
```ruby
class ApplicationMailer < ActionMailer::Base
include Emailbutler::Mailers::Helpers
end
```
### Email provider webhooks settings
#### Sendgrid
- go to [Mail settings](https://app.sendgrid.com/settings/mail_settings),
- turn on Event Webhook,
- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/sendgrid),
- select all deliverability data,
- save settings.
#### SMTP2GO
- go to [Mail settings](https://app-eu.smtp2go.com/settings/webhooks),
- turn on Webhooks,
- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/smtp2go),
- select all deliverability data,
- save settings.
#### Resend
- go to [Mail settings](https://resend.com/webhooks),
- add Webhook,
- in the Endpoint URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/resend),
- select all deliverability data,
- save settings.
## Usage
1. Each event with sending email will create new record with message params in database.
2. Each webhook event will update status of message in database.
### UI
Emailbutler provides UI with rendering email tracking statistics - /emailbutler/ui, with opportunity to search, resend and/or destroy emails.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Sponsors
[
](https://evrone.com/?utm_source=emailbutler)