Skip to main content

A Python mail connector library

Project description

mail_connector

Gmail connector for Python — read, modify, and organize emails via OAuth2.

Installation

pip install mes-courriels

Setup

  1. Create a Google Cloud project and enable the Gmail API
  2. Create an OAuth2 Client ID (type Desktop)
  3. Copy .env.example to .env and fill in GMAIL_CLIENT_ID and GMAIL_CLIENT_SECRET
  4. Run the auth script to get a refresh token:
uv run python scripts/auth.py

Usage

from mail_connector import GmailConnector

gmail = GmailConnector()

gmail.list_labels()
gmail.list_messages(query="from:alice@example.com")
gmail.get_message("msg_id")

gmail.mark_as_read("msg_id")
gmail.mark_as_unread("msg_id")
gmail.archive("msg_id")
gmail.trash("msg_id")
gmail.modify_message("msg_id", add_label_ids=["STARRED"])

gmail.send_message("to@example.com", "Subject", "Body text")

CLI

mes-courriels alice@example.com              # 10 derniers messages
mes-courriels alice@example.com -n 3         # les 3 derniers
mes-courriels alice@example.com -w           # surveiller en continu (60s)
mes-courriels alice@example.com -w -i 30     # surveiller toutes les 30s

Development

  • Python >= 3.12, uv
uv sync
uv run pytest

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

mes_courriels-0.0.7.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

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

mes_courriels-0.0.7-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file mes_courriels-0.0.7.tar.gz.

File metadata

  • Download URL: mes_courriels-0.0.7.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mes_courriels-0.0.7.tar.gz
Algorithm Hash digest
SHA256 126e9d7bcfe4dadb851c46469d6d3fad4366bdc72578b4042a23798e449eef65
MD5 3854de247b8dd6f6ea7fa4136328bf6e
BLAKE2b-256 c4e9f58db3f92759a6aadbeb52164659b767acf0caea29ed4363a87a478d0d4a

See more details on using hashes here.

File details

Details for the file mes_courriels-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: mes_courriels-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mes_courriels-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 640b08ad7430a9267b668c73a1e2758054c4dc87a3779fda101b08dcc98134ef
MD5 2a7679e5fcf6bcf7db500d26165ab0fd
BLAKE2b-256 7981e13014f82cf598b29856177bf546cc40cc17e6f31088cedeaae42550a90c

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