sendpost

Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.

Requirements.

Python >=3.7

Installation & Usage

pip install

pip install sendpost

Or you can install directly from git using:

pip install git+https://github.com/sendpost/sendpost_python_sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/sendpost/sendpost_python_sdk.git)

Then import the package:

import sendpost_python_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sendpost_python_sdk

Getting Started

Please follow the installation procedure and then run the following:

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import email_api

# Enter a context with an instance of the API client
with sendpost_python_sdk.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = email_api.EmailApi(api_client)
    x_sub_account_api_key = "your_api_key" # str | Sub-Account API Key
    email = {
      "from": {
            "email": "richard@piedpiper.com",
      },
      "to": [
        {
          "email": "gavin@hooli.com",
        }
      ],
      "subject": "Hello World",
      "htmlBody": "<strong>it works!</strong>",
      "ippool": "PiedPiper",
    }
    try:
        api_response = api_instance.send_email(header_params={ "X-SubAccount-ApiKey": x_sub_account_api_key}, body=email)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print("Exception when calling EmailApi->send_email: %s\n" % e)

Example with cc, bcc and template:

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import email_api

# Enter a context with an instance of the API client
with sendpost_python_sdk.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = email_api.EmailApi(api_client)
    x_sub_account_api_key = "your_api_key" # str | Sub-Account API Key
    email = {
      "from": {
            "email": "richard@piedpiper.com",
      },
      "to": [
        {
          "email": "gavin@hooli.com",
          "cc": [{ "email": "dinesh@bachmanity.com" }],
          "bcc": [{ "email": "jian@bachmanity.com" }],
        }
      ],
      "template": "Welcome Mail",
      "subject": "Hello World",
      "htmlBody": "<strong>it works!</strong>",
      "ippool": "PiedPiper",
    }
    try:
        api_response = api_instance.send_email_with_template(header_params={ "X-SubAccount-ApiKey": x_sub_account_api_key}, body=email)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print("Exception when calling EmailApi->send_email: %s\n" % e)

Create Suppressions

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import suppression_api
from sendpost_python_sdk.model import r_suppression

with sendpost_python_sdk.ApiClient() as api_client:
    api_instance = suppression_api.SuppressionApi(api_client)
    x_sub_account_api_key = "your_api_key"

    hardBounce = [{ "email": "richard@piedpiper_fake.com" }]


    # fields are optional, but you have to send at least one of them.
    # manual = [{ "email": "richard@piedpiper_fake2.com" }]
    # spamComplaint = [{ "email": "richard@piedpiper_fake3.com" }]
    # unsubscribe = [{ "email": "richard@piedpiper_fake4.com" }]

    r_suppression = r_suppression.RSuppression(
      hardBounce = hardBounce
    )

    # example with all fields
    # r_suppression = r_suppression.RSuppression(
    #   hardBounce = hardBounce,
    #   manual = manual,
    #   spamComplaint = spamComplaint,
    #   unsubscribe = unsubscribe
    # )

    try:
        api_response = api_instance.create_suppressions(header_params={ "X-SubAccount-ApiKey": x_sub_account_api_key}, body=r_suppression)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print("Exception when calling SuppressionApi->create_suppressions: %s\n" % e)

Get Suppressions

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import suppression_api

with sendpost_python_sdk.ApiClient() as api_client:
    api_instance = suppression_api.SuppressionApi(api_client)
    x_sub_account_api_key = "your_api_key"

    options = {
        "offset": 0,
        "limit": 10,
        "from": "2023-06-07",
        "to": "2023-08-03"
    }

    try:
        api_response = api_instance.get_suppressions(header_params={ "X-SubAccount-ApiKey": x_sub_account_api_key}, query_params=options)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print("Exception when calling SuppressionApi->get_suppressions: %s\n" % e)

Delete Suppression

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import suppression_api
from sendpost_python_sdk.model import rd_suppression

with sendpost_python_sdk.ApiClient() as api_client:
    api_instance = suppression_api.SuppressionApi(api_client)
    x_sub_account_api_key = "your_api_key"

    suppressions = [{"email": "richard@piedpiper_fake.com"}]

    rd_suppression = rd_suppression.RDSuppression(suppressions=suppressions)

    try:
        api_response = api_instance.delete_suppression(
            header_params={"X-SubAccount-ApiKey": x_sub_account_api_key},
            body=rd_suppression)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print(
            "Exception when calling SuppressionApi->delete_suppression: %s\n" %
            e)

Count Suppressions

import sendpost_python_sdk
from pprint import pprint
from sendpost_python_sdk.apis.tags import suppression_api

with sendpost_python_sdk.ApiClient() as api_client:
    api_instance = suppression_api.SuppressionApi(api_client)
    x_sub_account_api_key = "your_api_key"

    options = {
        "from": "2023-06-07",
        "to": "2023-08-03"
    }

    try:
        api_response = api_instance.count(header_params={ "X-SubAccount-ApiKey": x_sub_account_api_key}, query_params=options)
        pprint(api_response)
    except sendpost_python_sdk.ApiException as e:
        print("Exception when calling SuppressionApi->count: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.sendpost.io/api/v1

Class	Method	HTTP request	Description
EmailApi	send_email	post /subaccount/email/
EmailApi	send_email_with_template	post /subaccount/email/template
SuppressionApi	count	get /subaccount/suppression/count
SuppressionApi	create_suppressions	post /subaccount/suppression/
SuppressionApi	delete_suppression	delete /subaccount/suppression/
SuppressionApi	get_suppressions	get /subaccount/suppression/

Documentation For Models

• Attachment
• City
• CopyTo
• CountStat
• DeleteResponse
• Device
• EmailMessage
• EmailResponse
• EventMetadata
• ModelFrom
• Os
• QEmailMessage
• QEvent
• RDSuppression
• RSuppression
• ReplyTo
• Suppression
• SuppressionEmail
• To
• UserAgent
• WebhookEvent

Documentation For Authorization

Endpoints do not require authorization.

Author

dev@sendpost.io