Skip to main content

A Python package for retrieving, parsing, and sending emails

Project description

mailsuite

PyPI PyPI - Downloads

A Python package for retrieving, parsing, and sending emails.

Features

  • Simplified IMAP client
    • Retrieve email from any folder
    • Create new folders
    • Move messages to other folders
    • Delete messages
    • Monitor folders for new messages using the IMAP IDLE command
    • Always use / as the folder hierarchy separator, and convert to the server's hierarchy separator in the background
    • Always remove folder name characters that conflict with the server's hierarchy separators
    • Prepend the namespace to the folder path when required
    • Automatically reconnect when needed
    • Work around quirks in Gmail, Microsoft 365, Exchange, Dovecot, and DavMail
  • Consistent email parsing
    • SHA256 hashes of attachments
    • Parsed Authentication-Results and DKIM-Signature headers
    • Parse Microsoft Outlook .msg files using msgconvert
  • Simplified email creation and sending
    • Easily add attachments, plain text, and HTML
    • Uses opportunistic encryption (STARTTLS) with SMTP by default
  • DKIM signing and verification
    • Generate RSA keypairs and the matching DNS TXT record
    • Sign outbound mail with a sensible default header set (with From, To, Cc, Subject oversigned)
    • Verify one or many DKIM-Signature headers on a received message
  • Provider-agnostic mailbox abstraction (mailsuite.mailbox)
    • Single MailboxConnection interface for IMAP, Microsoft Graph, Gmail, and on-disk Maildir
    • Unified send_message() on backends that support sending (Microsoft Graph, Gmail) — IMAP and Maildir users send through mailsuite.smtp.send_email

Installation

Base install (IMAP, SMTP, DKIM, Maildir, parsing):

pip install mailsuite

The Microsoft Graph and Gmail backends are optional extras — the cloud SDKs aren't pulled in unless you ask for them:

pip install "mailsuite[msgraph]"   # Microsoft Graph (msgraph-sdk + azure-identity)
pip install "mailsuite[gmail]"     # Gmail (google-api-python-client + google-auth-oauthlib)
pip install "mailsuite[all]"       # both

Importing mailsuite.mailbox never requires the extras. Referencing MSGraphConnection or GmailConnection without the matching extra installed raises an ImportError pointing at the right install command.

Microsoft Graph notes

MSGraphConnection defaults to the worldwide cloud (https://graph.microsoft.com). To target a sovereign cloud or any other Graph endpoint, pass graph_url:

MSGraphConnection(..., graph_url="https://graph.microsoft.us")

The azure-identity token cache lives under name="mailsuite" by default. Applications migrating from a previous installation that used a different cache name can pass it through token_cache_name= so existing cached AuthenticationRecords and tokens continue to work — for example, token_cache_name="parsedmarc" keeps users authenticated across the migration.

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

mailsuite-2.0.1.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

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

mailsuite-2.0.1-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

Details for the file mailsuite-2.0.1.tar.gz.

File metadata

  • Download URL: mailsuite-2.0.1.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for mailsuite-2.0.1.tar.gz
Algorithm Hash digest
SHA256 8997524711e1fc35ddcd4bb92cdf3e9ea423d0eae2b39b8575cb30abeeac9e63
MD5 334bd64366bae17defe3f0ef176bb059
BLAKE2b-256 06c68477a12f59a48e5c6eef75b8fb1704d126bdba63255376afd582c62e6728

See more details on using hashes here.

File details

Details for the file mailsuite-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: mailsuite-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 38.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

File hashes

Hashes for mailsuite-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e28e7ddb43c4257e2a9f4bbd57441fdd0c2da3141f1c11cd40de5a630934b098
MD5 98c0aadac8585407a2f86f96964100b3
BLAKE2b-256 d8efbae23ddcfed0f22586de54cd23127219b16b074c596b81099ba0bef68807

See more details on using hashes here.

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