sowemail 0.0.1

SoWeMail library for Python 3

This library allows you to quickly and easily use the SoWeMail Rest API via Python.

Table of Contents

• Installation

• Quick Start

• Common Use Cases

• General Usage

• Processing Inbound Email

• Announcements

• Roadmap

• How to Contribute

• Troubleshooting

• About

• License

Installation

Prerequisites

• Python version 3.6+

• You will need a SoWeMail account, signup

Setup Environment Variables

Mac

Update the development environment with your SOWEMAIL_API_KEY, for example:

echo "export SOWEMAIL_API_KEY='YOUR_API_KEY'" > sowemail.env
echo "sowemail.env" >> .gitignore
source ./sowemail.env

SoWeMail also supports local environment file .env. Copy or rename .env_sample into .env and update SOWEMAIL_API_KEY with your key.

Windows

Temporarily set the environment variable (accessible only during the current CLI session):

set SOWEMAIL_API_KEY=YOUR_API_KEY

Permanently set the environment variable (accessible in all subsequent CLI sessions):

setx SOWEMAIL_API_KEY "YOUR_API_KEY"

Install Package

pip install sowemail

Dependencies

• sowerest

Quick Start

Hello Email

The following is the minimum needed code to send an email with the /mail/send Helper (here is a full example):

With Mail Helper Class

import os
from sowemail import SoWeMailAPIClient
from sowemail.helpers.mail import Mail

message = Mail(
    from_email='[e-mail]',
    to_emails='[e-mail]',
    subject='Hello from SoWeMail',
    html_content='<strong>Simple email sending example using python\'s sowerest library</strong>')
try:
    sow_client = SoWeMailAPIClient(os.environ.get('SOWEMAIL_API_KEY'))
    response = sow_client.send(message)
    print(response.status_code)
    print(response.body)
    print(response.headers)
except Exception as e:
    print(str(e))

The Mail constructor creates a personalization object for you. Here is an example of how to add it.

Without Mail Helper Class

The following is the minimum needed code to send an email without the /mail/send Helper (here is a full example):

import os
from sowemail import SoWeMailAPIClient

message = {
    'personalizations': [
        {
            'to': [
                {
                    'email': '[e-mail]'
                }
            ],
            'subject': 'Hello from SoWeMail'
        }
    ],
    'from': {
        'email': '[e-mail]'
    },
    'content': [
        {
            'type': 'text/plain',
            'value': 'Simple email sending example using python\'s sowerest library'
        }
    ]
}
try:
    sow_client = SoWeMailAPIClient(os.environ.get('SOWEMAIL_API_KEY'))
    response = sow_client.send(message)
    print(response.status_code)
    print(response.body)
    print(response.headers)
except Exception as e:
    print(str(e))

Thanks

This work were inspired and based on the awesome work done on sendgrid-python.

License

The MIT License (MIT)