sendgrid / Sendgrid Ruby
Programming Languages
Projects that are alternatives of or similar to Sendgrid Ruby
NEW: Subscribe to email notifications for releases and breaking changes.
The default branch name for this repository has been changed to main
as of 07/27/2020.
This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Ruby.
Version 3.X.X+ of this library provides full support for all Twilio SendGrid Web API v3 endpoints, including the new v3 /mail/send.
This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or simply upvote or comment on existing issues or pull requests.
Please browse the rest of this README for further details.
We appreciate your continued support, thank you!
Table of Contents
- Announcements
- Installation
- Quick Start
- Processing Inbound Email
- Usage
- Use Cases
- Announcements
- How to Contribute
- Troubleshooting
- About
- License
Installation
Prerequisites
- Ruby version >= 2.4 (except version 2.6.0)
- The Twilio SendGrid service, starting at the free level
Setup Environment Variables
Update the development environment with your SENDGRID_API_KEY, for example:
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
Install Package
Add this line to your application's Gemfile:
gem 'sendgrid-ruby'
And then execute:
bundle
Or install it yourself using:
gem install sendgrid-ruby
Dependencies
Quick Start
Hello Email
The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):
With Mail Helper Class
require 'sendgrid-ruby'
include SendGrid
from = SendGrid::Email.new(email: '[email protected]')
to = SendGrid::Email.new(email: '[email protected]')
subject = 'Sending with Twilio SendGrid is Fun'
content = SendGrid::Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
mail = SendGrid::Mail.new(from, subject, to, content)
sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
response = sg.client.mail._('send').post(request_body: mail.to_json)
puts response.status_code
puts response.body
puts response.parsed_body
puts response.headers
For more complex scenarios, please do not use the above constructor and instead build your own personalization object as demonstrated here.
Without Mail Helper Class
The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):
require 'sendgrid-ruby'
include SendGrid
data = JSON.parse('{
"personalizations": [
{
"to": [
{
"email": "[email protected]"
}
],
"subject": "Sending with Twilio SendGrid is Fun"
}
],
"from": {
"email": "[email protected]"
},
"content": [
{
"type": "text/plain",
"value": "and easy to do anywhere, even with Ruby"
}
]
}')
sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
response = sg.client.mail._("send").post(request_body: data)
puts response.status_code
puts response.body
puts response.parsed_body
puts response.headers
General v3 Web API Usage (With Fluent Interface)
require 'sendgrid-ruby'
sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
response = sg.client.suppression.bounces.get()
puts response.status_code
puts response.body
puts response.parsed_body
puts response.headers
General v3 Web API Usage (Without Fluent Interface)
require 'sendgrid-ruby'
sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
response = sg.client._("suppression/bounces").get()
puts response.status_code
puts response.body
puts response.parsed_body
puts response.headers
Processing Inbound Email
Please see our helper for utilizing our Inbound Parse webhook.
Usage
- Twilio SendGrid Docs
- Library Usage Docs
- Example Code
- How-to: Migration from v2 to v3
- v3 Web API Mail Send Helper - build a request object payload for a v3 /mail/send API call.
- Settings Helper
Use Cases
Examples of common API use cases, such as how to send an email with a transactional template.
Announcements
Please see our announcement regarding breaking changes. Your support is appreciated!
All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email release notifications for releases and breaking changes.
How to Contribute
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Troubleshooting
Please see our troubleshooting guide for common library issues.
About
sendgrid-ruby is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of Twilio SendGrid, Inc.
If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!