Skip to content

gmail_imap

gmail_imap

Gmail IMAP connector — reads email via IMAP with app password.

Simpler alternative to the OAuth-based Gmail connector. Uses Python's built-in imaplib + email modules (no dependencies).

Setup: generate an app password at https://myaccount.google.com/apppasswords

Classes

GmailIMAPConnector 

GmailIMAPConnector(
    email_address: str = "",
    app_password: str = "",
    credentials_path: str = "",
    *,
    imap_host: str = "",
    max_messages: Optional[int] = None,
)

Bases: BaseConnector

Gmail connector using IMAP + app password.

No OAuth needed — just an email address and app password.

Source code in src/diapason/connectors/gmail_imap.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def __init__(
    self,
    email_address: str = "",
    app_password: str = "",
    credentials_path: str = "",
    *,
    imap_host: str = "",
    max_messages: Optional[int] = None,
) -> None:
    self._email = email_address
    self._password = app_password
    self._credentials_path = credentials_path or _DEFAULT_CREDENTIALS_PATH
    self._imap_host = imap_host or self._default_imap_host
    # ``None`` means "no cap" — the full inbox is indexed. A positive
    # value is still honored for tests that want a bounded scan.
    self._max_messages = max_messages
    self._items_synced = 0
    self._items_total = 0

Functions: