Email API Quickstart for Ruby

Be sure to perform the following prerequisites to complete this tutorial. You can skip ahead if you've already completed these tasks.

1. Sign up for a SendGrid account.
2. Enable Two-factor authentication.
3. Create and store a SendGrid API Key with Mail Send > Full Access permissions.
4. Complete Domain Authentication.
5. Install Ruby.

Skip the prerequisites

When you sign up for a free SendGrid account, you'll be able to send 100 emails per day forever. For more account options, see our pricing page.

Twilio SendGrid requires customers to enable Two-factor authentication (2FA). You can enable 2FA with SMS or by using the Authy app. See the 2FA section of our authentication documentation for instructions.

Unlike a username and password — credentials that allow access to your full account — an API key is authorized to perform a limited scope of actions. If your API key is compromised, you can also cycle it (delete and create another) without changing your other account credentials.

Visit our API Key documentation for instructions on creating an API key and storing an API key in an environment variable. To complete this tutorial, you can create a Restricted Access API key with Mail Send > Full Access permissions only, which will allow you to send email and schedule emails to be sent later. You can edit the permissions assigned to an API key later to work with additional services.

Once your API key is assigned to an environment variable — this quickstart uses SENDGRID_API_KEY — you can proceed to the next step.

export SENDGRID_API_KEY=<Your API Key>

To ensure our customers maintain the best possible sender reputations and to uphold legitimate sending behavior, we require customers to verify their Sender Identities by completing Domain Authentication. A Sender Identity represents your 'From' email address—the address your recipients see as the sender of your emails.

Before installing Ruby, you can see if you already have a version on your machine.

Check your Ruby version by opening your terminal (also known as a command line or console) and typing the following command.

ruby -v

If you have Ruby installed, the terminal will print something like the following output.

ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]

If you do not already have a version of Ruby installed, visit the Ruby website to download and install a version appropriate for your operating system.

Using a Twilio SendGrid helper library is the fastest way to deliver your first email.

Start by creating a project folder for this app. The following examples will use a folder called send_mail.

mkdir send_mail

Next, navigate into the send_mail directory where you will complete the rest of the tutorial.

cd send_mail

The RubyGems package manager is included when installing Ruby. You can use RubyGems to install the Twilio SendGrid helper library and save it as a project dependency. If you want to verify that RubyGems is installed, you can type the following into the terminal.

gem -v

The terminal should print something like the following output.

3.1.4

To install the Twilio SendGrid helper library, type the following command into the terminal.

gem install sendgrid-ruby

The terminal will output something like the following output.

1
Fetching ruby_http_client-3.5.2.gem
2
Fetching sendgrid-ruby-6.4.0.gem
3
Successfully installed ruby_http_client-3.5.2
4
Successfully installed sendgrid-ruby-6.4.0
5
Parsing documentation for ruby_http_client-3.5.2
6
Installing ri documentation for ruby_http_client-3.5.2
7
Parsing documentation for sendgrid-ruby-6.4.0
8
Installing ri documentation for sendgrid-ruby-6.4.0
9
Done installing documentation for ruby_http_client, sendgrid-ruby after 0 seconds
10
2 gems installed

You're now ready to write some code. First, create a send_mail.rb file in your project directory.

The following Ruby block contains all the code needed in your send_mail.rb file to successfully deliver a message with the SendGrid Mail Send API. You can copy this code, modify the to and from variables, and run the code if you like. We'll break down each piece of this code in the following sections.

1
require 'sendgrid-ruby'
2
include SendGrid
3

4
from = SendGrid::Email.new(email: 'test@example.com', name: "Test") # Change to your verified sender
5
to = SendGrid::Email.new(email: 'test@example.com', name: "Test") # Change to your recipient
6
subject = 'Sending with Twilio SendGrid is Fun'
7
content = SendGrid::Content.new(type: 'text/html', value: 'and easy to do anywhere, even with <strong>Ruby</strong>.')
8
mail = SendGrid::Mail.new(from, subject, to, content)
9

10
sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
11
response = sg.client.mail._('send').post(request_body: mail.to_json)
12
puts response.status_code
13
puts response.headers

Your API call must have the following components.

• A host (the host for Web API v3 requests is always https://api.sendgrid.com/v3/)
• An API key passed in an Authorization Header
• A request (when submitting data to a resource via POST or PUT, you must submit your request body in JSON format)

In your send_mail.rb file, require the SendGrid helper library, and include the SendGrid module. The library will handle setting the Host, https://api.sendgrid.com/v3/, for you.

1
require 'sendgrid-ruby'
2
include SendGrid

Now you're ready to set up the from, to, subject, and message body content. These values are passed to the API in a Personalizations object when using the v3 Mail Send API. You can assign each of these values to variables, and the SendGrid library will handle creating a personalizations object for you.

The subject variable is a string. However, you will set the from and to variables using the helper library's Email method. The Email method takes two arguments: an optional name and an email address. Be sure to set the to value to an address with an inbox you can access.

The content variable is set with the Content method. The Content method takes a type, which can be either text/plain or text/html, and a value, which is a string of the content you wish to send in the message body.

1
from = SendGrid::Email.new(email: 'test@example.com', name: "Test") # Change to your verified sender
2
to = SendGrid::Email.new(email: 'test@example.com', name: "Test") # Change to your recipient
3
subject = 'Sending with Twilio SendGrid is Fun'
4
content = SendGrid::Content.new(type: 'text/html', value: 'and easy to do anywhere, even with <strong>Ruby</strong>.')

To properly construct the message, pass each of the previous variables into the SendGrid library's Mail method. You can assign this to a variable named mail.

mail = SendGrid::Mail.new(from, subject, to, content)

Next, use the API key you set up earlier. Remember, the API key is stored in an environment variable, so you can use Ruby's ENV class to access it. Assign the key to a variable named sg using the helper library's API method. The helper library will pass your key to the v3 API in an Authorization Header using Bearer token authentication.

sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])

Lastly, you need to make a request to the SendGrid Mail Send API to deliver your message.

The helper library uses SendGrid's ruby-http-client library to construct the request URL by chaining together portions of your desired path. The path to the SendGrid v3 Mail Send endpoint is https://api.sendgrid.com/v3/mail/send. The helper library sets the client for you, so the https://api.sendgrid.com/v3 portion is taken care of by typing sg.client. The next parts of the path are /mail and /send. You can chain the words mail and send onto client to build the rest of the URL.

With the URL built, ruby-http-client then allows you to chain on the type of HTTP request you wish to make with a method matching the name of the HTTP verb appropriate for your desired endpoint. To send a message, you should make an HTTP POST request, so you can use post(). The post() method takes a request_body, which you should set to a JSON version of your message. You can assign this full call to a variable named response. You can also print the response status code and headers.

1
# Send an HTTP POST request to /mail/send
2
response = sg.client.mail._('send').post(request_body: mail.to_json)
3
puts response.status_code
4
puts response.headers

With all this code in place, you can run your mail_send.rb file in your terminal to send the email.

ruby mail_send.rb

If you receive a 202 status code printed to the console, your message was sent successfully. Check the inbox of the to address, and you will see your demo message.

If you don't see the email, you may need to check your spam folder.

If you receive an error message, you can reference our response message documentation for clues about what may have gone wrong.

All responses are returned in JSON format. We specify this by sending the Content-Type header. The Web API v3 provides a selection of response codes, content-type headers, and pagination options to help you interpret the responses to your API requests.

This is just the beginning of what you can do with our APIs. To learn more, check the resources below.

• API Reference
• Sending Email with Dynamic Transactional Templates
• Getting Started with the Event Webhook
• The Email Activity Feed
• Sender Authentication
• Twilio SendGrid helper library for Ruby