diegous / smtpapi-ruby

It's Hacktoberfest!! SendGrid is giving out shirts if you make pull requests!

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
• Quick Start
• Usage
• Roadmap
• How to Contribute
• About
• License

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('[email protected]')
print header.to_json

Usage

• SendGrid Docs
• Example Code

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:

• Feature Request
• Bug Reports
• Sign the CLA to Create a Pull Request
• Improvements to the Codebase

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)