This library allows you to quickly and easily use the SendGrid Web API v3 via Ruby.
Version 3.X.X+ of this library provides full support for all SendGrid Web API v3 endpoints, including the new v3 /mail/send.
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and 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 detail.
We appreciate your continued support, thank you!
- Ruby version 2.2
- The SendGrid service, starting at the free level
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.envAdd this line to your application's Gemfile:
gem 'sendgrid-ruby'And then execute:
bundleOr install it yourself using:
gem install sendgrid-rubyThe following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):
require 'sendgrid-ruby'
include SendGrid
from = Email.new(email: '[email protected]')
subject = 'Hello World from the SendGrid Ruby Library!'
to = Email.new(email: '[email protected]')
content = Content.new(type: 'text/plain', value: 'Hello, Email!')
mail = 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.headersFor more complex scenarios, please do not use the above constructor and instead build your own personalization object as demonstrated here.
The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):
data = JSON.parse('{
"personalizations": [
{
"to": [
{
"email": "[email protected]"
}
],
"subject": "Hello World from the SendGrid Ruby Library!"
}
],
"from": {
"email": "[email protected]"
},
"content": [
{
"type": "text/plain",
"value": "Hello, Email!"
}
]
}')
response = sg.client.mail._("send").post(request_body: data)
puts response.status_code
puts response.body
puts response.headersrequire '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.headersrequire '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.headers- 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.
All updates to this library is documented in our CHANGELOG and releases.
If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
sendgrid-ruby is guided and supported by the SendGrid Developer Experience Team.
sendgrid-ruby is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of SendGrid, Inc.
![SendGrid Logo] (https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
