Simple wrapper to use SendGrid SMTP API
Project description
This module helps build SendGrid’s SMTP API headers.
Learn more about the SMTP API at SendGrid documentation.
Announcements
The default branch name for this repository has been changed to `main` as of 07/27/2020.
All the updates to this module are documented in our CHANGELOG.
Table of Contents
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
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 projects, please see our CONTRIBUTING guide for more details.
Quick links:
Local Setup of the Project
The simplest local development workflow is by using Docker.
Steps:
Install [Docker](https://www.docker.com/)
Run docker-compose build (this builds the container)
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.