Skip to main content

Mail-reading driver for the Model Context Standard -- lets an LLM read and organise e-mail.

Project description

mcs-driver-mailread

Mail-reading driver for the Model Context Standard (MCS).

Provides tools for listing folders, reading messages, searching, moving, and organising e-mail. The actual I/O is delegated to a pluggable adapter, making the same driver work with IMAP, Gmail API, Microsoft Graph, or any future backend.

Installation

pip install mcs-driver-mailread

# With IMAP adapter
pip install mcs-driver-mailread[imap]

Quick start

from mcs.driver.mailread import MailreadToolDriver

# IMAP (default adapter)
td = MailreadToolDriver(
    adapter="imap",
    host="imap.example.com",
    user="alice@example.com",
    password="...",
)

tools = td.list_tools()       # 7 tools
result = td.execute_tool("list_folders", {})

Tools

Tool Description
list_folders List all mailbox folders
list_messages List message summaries in a folder
fetch_message Fetch a full message by UID
search_messages Search messages by criteria
move_message Move a message to another folder
set_flags Add or remove flags on a message
create_folder Create a new mailbox folder

Adapter protocol

The driver defines a MailboxPort typing protocol. Any object that implements the seven methods above satisfies the contract -- no inheritance required.

Links

License

Apache-2.0

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

mcs_driver_mailread-0.2.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

mcs_driver_mailread-0.2.0-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file mcs_driver_mailread-0.2.0.tar.gz.

File metadata

  • Download URL: mcs_driver_mailread-0.2.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for mcs_driver_mailread-0.2.0.tar.gz
Algorithm Hash digest
SHA256 eeeb26cbf1c49e669696de4bb60fdb033eb49670c9174143dd86be8f3096c43b
MD5 672511439f4111168a8d0a989d933c43
BLAKE2b-256 04377ddf5192ae166bb291c38b28c9802681a3b1a334534c83e1b2c247737079

See more details on using hashes here.

File details

Details for the file mcs_driver_mailread-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcs_driver_mailread-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2c8da274fd954c4eb1f36e925a89f9863ce405567950801b664303e2a5acf57
MD5 7e4b820e75d49e4728483d996b4f531d
BLAKE2b-256 0100f2b3d6509cdfb562e74d1443d5d7c5c2f5f4bff521647e1f1253aca6b18e

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