Skip to main content

The Official Postmark Python SDK.

Project description

postmark-python

Python Versions License: MIT Tests
Postmark Python SDK

The official (Beta) Python SDK for Postmark — send emails, manage bounces, templates, webhooks, and more.

For tutorials and detailed usage, check out the wiki.

For details about the Postmark API in general, see the Postmark developer docs.

Requirements

  • Python 3.10+

Installation

Install from PyPI as postmark-python (the Python package you import is still postmark):

pip install postmark-python

Quick Start

The SDK is async-first — all API calls return awaitables. As of v0.3.0, a synchronous wrapper is also available for use in non-async contexts.

Async:

import asyncio
import os

import postmark

# Tokens are read from the environment here. Optionally: pip install python-dotenv,
# then use load_dotenv() to populate os.environ from a .env file.

async def main():
    async with postmark.ServerClient(os.environ["POSTMARK_SERVER_TOKEN"]) as client:
        response = await client.outbound.send({
            "sender": "sender@example.com",
            "to": "recipient@example.com",
            "subject": "Hello from Postmark",
            "text_body": "Sent with the Postmark Python SDK.",
        })
        print(f"Sent: {response.message_id}")

asyncio.run(main())

Sync (v0.3.0+):

import os

import postmark.sync

with postmark.sync.ServerClient(os.environ["POSTMARK_SERVER_TOKEN"]) as client:
    response = client.outbound.send({
        "sender": "sender@example.com",
        "to": "recipient@example.com",
        "subject": "Hello from Postmark",
        "text_body": "Sent with the Postmark Python SDK.",
    })
    print(f"Sent: {response.message_id}")

Why sender, not from? from is a reserved keyword in Python, so the SDK uses sender for the sending address. Everything else matches the Postmark API field names directly.

Two Client Types

Client Token Use for
ServerClient Server API token Sending email, bounces, templates, stats, webhooks, streams
AccountClient Account API token Domains, sender signatures, managing servers, data removals
import postmark

# Use as async context managers to ensure connections are closed
async with postmark.ServerClient(os.environ["POSTMARK_SERVER_TOKEN"]) as client:
    ...

async with postmark.AccountClient(os.environ["POSTMARK_ACCOUNT_TOKEN"]) as account:
    ...

# Or call close() explicitly when done
client = postmark.ServerClient(os.environ["POSTMARK_SERVER_TOKEN"])
await client.close()

Development

git clone https://github.com/ActiveCampaign/postmark-python.git
cd postmark-python
poetry install
poetry run pre-commit install
# Run tests
poetry run pytest

# Lint and type-check
poetry run pre-commit run --all-files

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for your changes
  4. Ensure all checks pass (poetry run pre-commit run --all-files)
  5. Open a Pull Request

Support

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postmark_python-0.3.5.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

postmark_python-0.3.5-py3-none-any.whl (55.4 kB view details)

Uploaded Python 3

File details

Details for the file postmark_python-0.3.5.tar.gz.

File metadata

  • Download URL: postmark_python-0.3.5.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for postmark_python-0.3.5.tar.gz
Algorithm Hash digest
SHA256 b67119278c6b2175bd1f628a5e6cf2ca8a2eeb59374bbd6f3859c8ac682e692b
MD5 b2ca6cf5eaf02868c3eb5a933efa7fbb
BLAKE2b-256 fb868c89982276032e283b7ccdba24b563d40ed59b045c6348993cea8f8f7fbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for postmark_python-0.3.5.tar.gz:

Publisher: publish.yml on ActiveCampaign/postmark-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file postmark_python-0.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for postmark_python-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 27e2754a85ae0cfa5fbd906a27936ae9311dcfb0268b6aa356d59a22047a944a
MD5 7ee2884c288ac245af1e0e538b109826
BLAKE2b-256 cc49ec2591383caea2f4799925831a74a2256a929bfe5648c0fcd495058022fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for postmark_python-0.3.5-py3-none-any.whl:

Publisher: publish.yml on ActiveCampaign/postmark-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page