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.1.tar.gz (15.5 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.1-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcs_driver_mailread-0.2.1.tar.gz
  • Upload date:
  • Size: 15.5 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.1.tar.gz
Algorithm Hash digest
SHA256 04729a91d28030b197032a65de178d7cf597d2c09cf09e2282ceed89e1156baf
MD5 f398fc37c4da06565dcb5077621b92a7
BLAKE2b-256 35accda94d38c37bc501c19471d72c9ab49c47ae032234b609d39a82444090b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcs_driver_mailread-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 02aa71e53bd7a293ab6fa75a52a781b0ba55775beac3cf378df979b6428e62bc
MD5 0f5ef998859258c3a68c1c7f883950c5
BLAKE2b-256 28664950a1eabf0bbfd5a7efd207922e1dd4acbce12d21d56d29ad6aa235d8ae

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