Skip to main content

Generated Python client for the Sendmux Mailbox API.

Project description

sendmux-mailbox

PyPI version Python versions PyPI downloads Licence

Generated Python client for the Sendmux Mailbox API.

Documentation

Requirements

  • Python 3.10 or newer.
  • A mailbox-scoped Sendmux API key with the smx_mbx_* prefix.

Installation

pip install sendmux-mailbox

Usage

import os

from sendmux_mailbox import MailboxAPIApi, create_mailbox_client

client = create_mailbox_client(api_key=os.environ["SENDMUX_MAILBOX_API_KEY"])
api = MailboxAPIApi(client)

messages = api.mailbox_list_messages(limit=25)

for message in messages.data:
    print(message.id, message.subject)

The package exports every generated Mailbox model and API class plus:

  • create_mailbox_client
  • configure_mailbox
  • SendmuxMailboxApiClient

Pagination

Use iter_cursor_pages from sendmux-core with list operations that return cursor pagination.

import os

from sendmux_core import iter_cursor_pages
from sendmux_mailbox import MailboxAPIApi, create_mailbox_client

client = create_mailbox_client(api_key=os.environ["SENDMUX_MAILBOX_API_KEY"])
api = MailboxAPIApi(client)

for message in iter_cursor_pages(lambda cursor: api.mailbox_list_messages(cursor=cursor, limit=50)):
    print(message.id)

Support

Open an issue in Sendmux/sendmux-sdk with the package name, version, and request ID from any API error.

Licence

MIT. See the licence file.

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

sendmux_mailbox-1.0.4.tar.gz (70.7 kB view details)

Uploaded Source

Built Distribution

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

sendmux_mailbox-1.0.4-py3-none-any.whl (227.5 kB view details)

Uploaded Python 3

File details

Details for the file sendmux_mailbox-1.0.4.tar.gz.

File metadata

  • Download URL: sendmux_mailbox-1.0.4.tar.gz
  • Upload date:
  • Size: 70.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for sendmux_mailbox-1.0.4.tar.gz
Algorithm Hash digest
SHA256 01fc1475de1a1ead3ee0ca59af9976dc7abbff2d7898f3d07e12751cd45963b3
MD5 e21532c6b001623dde9c9877c7b36bb5
BLAKE2b-256 af63782de088b49867eff629d6b2458875a36ae29ebd720655bf8b29aa541705

See more details on using hashes here.

Provenance

The following attestation bundles were made for sendmux_mailbox-1.0.4.tar.gz:

Publisher: release-please.yml on Sendmux/sendmux-sdk

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

File details

Details for the file sendmux_mailbox-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: sendmux_mailbox-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 227.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for sendmux_mailbox-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 690ea9199d224091f81fed70b97a17da1685aff162b6e7c4dc49f2d60b987077
MD5 efaf367967af7ef8106d316faeb511cb
BLAKE2b-256 30563148aca9d2580093a2f230754b91d436a8c5f16fa9b13825afeacc82847e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sendmux_mailbox-1.0.4-py3-none-any.whl:

Publisher: release-please.yml on Sendmux/sendmux-sdk

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