Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fluke/google-http-actionmailer
Google HTTP API support for Actionmailer
https://github.com/fluke/google-http-actionmailer
actionmailer gmail-api google-api rails
Last synced: 2 months ago
JSON representation
Google HTTP API support for Actionmailer
- Host: GitHub
- URL: https://github.com/fluke/google-http-actionmailer
- Owner: fluke
- License: mit
- Created: 2018-04-17T02:40:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-16T08:31:18.000Z (over 3 years ago)
- Last Synced: 2024-09-18T16:21:09.545Z (4 months ago)
- Topics: actionmailer, gmail-api, google-api, rails
- Language: Ruby
- Size: 15.6 KB
- Stars: 15
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GoogleHttpActionmailer
An ActionMailer adapter to send email using Google's HTTPS Web API (instead of SMTP).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'google-http-actionmailer'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install google-http-actionmailer
## Usage
Set up your `authorization` as described in the [Google API Client](https://github.com/google/google-api-ruby-client/#authorization) (the easiest method is to pass a valid access token), edit `config/application.rb` or `config/environments/$ENVIRONMENT.rb` and add/change the following to the ActionMailer configuration:
```ruby
config.action_mailer.delivery_method = :google_http_actionmailer
config.action_mailer.google_http_actionmailer_settings = {
authorization: ...,
client_options: {
application_name: ...,
application_version: ...,
},
request_options: {
retries: ...,
header: ...,
},
message_options: {
fields: ...,
content_type: ...,
},
delivery_options: {
before_send: ...,
after_send: ...,
}
}
```
### Options
| option | details |
| ------ | ------- |
| authorization | This is the authorization, it could be a access token, etc as described in the [Google API Client](https://github.com/google/google-api-ruby-client/#authorization) |
| client_options | General client options as described in the [Google API Client options code](https://github.com/googleapis/google-api-ruby-client/blob/0.26.0/lib/google/apis/options.rb#L38). |
| request_options | General request options as described in the [Google API Client options code](https://github.com/googleapis/google-api-ruby-client/blob/0.26.0/lib/google/apis/options.rb#L62). |
| message_options | [Specific options](https://github.com/googleapis/google-api-ruby-client/blob/0.26.0/generated/google/apis/gmail_v1/service.rb#L1075) for that message such as fields, content_type, upload_source and quota_user. |
| delivery_options | This currently contains hooks for before the message is sent and after the message is sent. |
For client and request options, you can look [here](https://github.com/google/google-api-ruby-client/blob/master/lib/google/apis/options.rb). And for message options, you can look at the `send_user_message` method [here](https://github.com/google/google-api-ruby-client/blob/master/generated/google/apis/gmail_v1/service.rb#L1150).
For dynamic setting of delivery method (this may be required given the access tokens usually expire):
```ruby
mail.delivery_method(
GoogleHttpActionmailer::DeliveryMethod, {
authorization: ...
})
```
Normal ActionMailer usage will now transparently be sent using Google's HTTPS API.
To use the delivery options pass a proc that takes two parameters mail (the object created by ActionMailer) and message (the object created by the Gmail API).
```ruby
GoogleHttpActionmailer::DeliveryMethod, {
authorization: access_token,
client_options: {
application_name: ...,
application_version: ...,
},
delivery_options: {
after_send: ->(mail, message) {
StorePostSendDetails.call(user: self, mail: mail, message: message)
},
before_send: ->(mail, message) {
StorePreSendDetails.call(user: self, mail: mail, message: message)
}
}
}
```
If you want to set the threadId to your outgoing mail, just add the header 'Thread-ID' with the appropriate value.
```ruby
mail to: email, subject: subject, "Thread-ID": thread_id
```
## 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 the version number in `version.rb`, and then 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 on GitHub at https://github.com/[USERNAME]/google_http_actionmailer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the GoogleHttpActionmailer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/google_http_actionmailer/blob/master/CODE_OF_CONDUCT.md).