Skip to content
The Official Twilio SendGrid Led, Community Driven Ruby API Library
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github hyphens Jun 3, 2019
docker Add Dockerfile, README for it Oct 4, 2017
examples Twilio branding updates, CLA updates Jun 2, 2019
gemfiles Test against two major versions of Sinatra May 2, 2017
lib Version Bump v6.0.0: Remove sinatra dependency + features and fixes Jun 4, 2019
spec Adding an IpManagement helper? Feb 13, 2018
test Version Bump v6.0.0: Remove sinatra dependency + features and fixes Jun 4, 2019
.codeclimate.yml updated from comments on review Nov 17, 2017
.env_sample Add a .env_sample file, update README.md Oct 27, 2017
.gitignore revert .gitignore Oct 28, 2016
.travis.yml Merge branch 'master' into update-ruby-versions May 2, 2017
CHANGELOG.md Version Bump v6.0.0: Remove sinatra dependency + features and fixes Jun 4, 2019
CODE_OF_CONDUCT.md hyphens Jun 3, 2019
CONTRIBUTING.md hyphens Jun 3, 2019
Gemfile Fixes merge conflicts Apr 13, 2017
LICENSE.txt Twilio branding updates, CLA updates Jun 2, 2019
README.md Typos and formatting Jun 3, 2019
Rakefile [#197] Make SendGrid permissions management easy Nov 9, 2017
TROUBLESHOOTING.md Typos and formatting Jun 3, 2019
UPGRADE.md Version Bump v6.0.0: Remove sinatra dependency + features and fixes Jun 4, 2019
USAGE.md Twilio branding updates, CLA updates Jun 2, 2019
USE_CASES.md Typos and formatting Jun 3, 2019
config.ru Add inbound parser Oct 24, 2016
mail_helper_v3.md Twilio branding updates, CLA updates Jun 2, 2019
sendgrid-ruby.gemspec Twilio branding updates, CLA updates Jun 2, 2019

README.md

Twilio SendGrid Logo

Travis Badge Gem Version Email Notifications Badge MIT licensed Twitter Follow GitHub contributors Open Source Helpers

NEW: Subscribe to email notifications for releases and breaking changes.

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

NEW: If you're a software engineer who is passionate about #DeveloperExperience and/or #OpenSource, this is an incredible opportunity to join our #DX team as a Developer Experience Engineer and work with @thinkingserious and @aroach! Tell your friends :)

Installation

Prerequisites

  • Ruby version >= 2.2 (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: 'test@example.com')
to = SendGrid::Email.new(email: 'test@example.com')
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": "test@example.com"
        }
      ],
      "subject": "Sending with Twilio SendGrid is Fun"
    }
  ],
  "from": {
    "email": "test@example.com"
  },
  "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

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.

Roadmap

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.

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 guided and supported by the Developer Experience Team.

sendgrid-ruby is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of SendGrid, Inc.

License

The MIT License (MIT)

You can’t perform that action at this time.