sendgrid/sendgrid-ruby


The Official Twilio SendGrid Led, Community Driven Ruby API Library

https://sendgrid.com

License: MIT

Language: Ruby

Keywords: email, ruby, sendgrid, transactional-emails


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)

Project Statistics

Sourcerank 13
Repository Size 713 KB
Stars 457
Forks 263
Watchers 197
Open issues 87
Dependencies 9
Contributors 59
Tags 52
Created
Last updated
Last pushed

Top Contributors See all

Dan Chan Elmer Thomas Eddie Zaneski Robin J Matt Bernier Wataru Sato Jake Yesbeck Kyle Kern SendGrid's DX Team twilio-ci Gustavo Caso Manjiri Tapaswi Billy Watson Mike de Bock Ryunosuke Sato thepriefy Alan Unruh Anshul Singhal Chandler Weiner Dylan

Packages Referencing this Repo

sendgrid-ruby
Official Twilio SendGrid Gem to Interact with Twilio SendGrids API in native Ruby
Latest release 6.2.0 - Updated - 457 stars

Recent Tags See all

6.2.0 April 29, 2020
6.1.4 April 15, 2020
6.1.3 April 01, 2020
6.1.2 March 18, 2020
6.1.1 March 04, 2020
6.1.0 February 20, 2020
6.0.4 January 22, 2020
6.0.3 January 22, 2020
6.0.2 January 08, 2020
6.0.1 January 03, 2020
6.0.0 January 03, 2020
99.99.99 January 03, 2020
v6.0.0 June 04, 2019
v5.3.0 October 12, 2018
v5.2.0 October 31, 2017

Something wrong with this page? Make a suggestion

Last synced: 2018-10-12 16:53:06 UTC

Login to resync this repository