This module helps build SendGrid's SMTP API headers.

Learn more about the SMTP API at SendGrid documentation.

Announcements

All the updates to this module are documented in our CHANGELOG.

Table of Contents

• Installation
• Quick Start
• Usage
• How to Contribute
• Local Setup of the Project
• About
• License

Installation

Prerequisites

• Python version 2.7 or 3.4+
• The SendGrid service, starting at the free level

Install Package

pip install smtpapi

Setup Environment Variables

Update the development environment with your SENDGRID_API_KEY, for example:

cp .env_sample .env

In .env set SENDGRID_API_KEY to your own API key.

You can add your environment variables to your environment by sourcing the file:

source .env

Quick Start

from smtpapi import SMTPAPIHeader

header = SMTPAPIHeader()
header.add_to('email@email.com')
print(header.json_string())

Usage

• SendGrid documentation
• Example Code

How to Contribute

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

Quick links:

• Improvements to the Codebase
• Review Pull Requests

Local Setup of the Project

The simplest local development workflow is by using Docker.

Steps:

1. Install [Docker](https://www.docker.com/)
2. Run docker-compose build (this builds the container)
3. Run docker-compose up (this runs tests by default)

About

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

License

The MIT License (MIT)