SendGrids smtpapi library in Ruby
Clone or download
Pull request Compare This branch is 111 commits ahead of eddiezane:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
examples
lib
test
use_cases
.codeclimate.yml
.env_sample
.gitignore
.rubocop.yml
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
LICENSE.txt
README.md
Rakefile
TROUBLESHOOTING.md
smtpapi.gemspec

README.md

SendGrid Logo

Build Status Gem Version Email Notifications Badge Gem Version MIT licensed Twitter Follow GitHub contributors

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

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 :)

All updates to this library is documented in our CHANGELOG.

Table of Contents

Installation

Prerequisites

  • Ruby version 2.2
  • 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

Roadmap

If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

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

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

License

The MIT License (MIT)