Skip to content

sendgrid/smtpapi-ruby

 
 

Repository files navigation

SendGrid Logo

Build Status Gem Version MIT licensed Twitter Follow GitHub contributors

This ruby gem allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.

Announcements

All updates to this library is documented in our CHANGELOG.

Table of Contents

Installation

Prerequisites

  • Ruby version >= 2.4
  • The SendGrid service, starting at the free level

Install Package

Add this line to your application's Gemfile:

gem 'smtpapi'

And then execute:

bundle

Or install it yourself as:

gem install smtpapi

Setup Environment Variables

Environment Variable

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

Quick Start

header = Smtpapi::Header.new
header.add_to('test@example.com')
print header.to_json

Usage

How to Contribute

We encourage contribution to our libraries, please see our CONTRIBUTING guide for details.

Quick links:

Credits

This library was created by Wataru Sato and is now maintained by SendGrid.

About

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

# Support

If you need with SendGrid, please check the Twilio SendGrid Support Help Center.

License

The MIT License (MIT)

About

Twilio SendGrid's SMTP API library in Ruby

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 99.2%
  • Makefile 0.8%