Skip to main content

IMAP IDLE band plugin for Docketeer

Project description

docketeer-imap

IMAP IDLE band plugin for Docketeer. Monitors IMAP mailboxes for new messages using IDLE (push-style notifications) and produces Signal objects for the antenna system.

Install docketeer-imap alongside docketeer and the band is automatically available.

Configuration

All connection details come from a vault secret — no global environment variables needed. Each tuning specifies its own secret, so you can monitor multiple IMAP accounts independently.

The vault secret must be a JSON object:

{
  "host": "imap.gmail.com",
  "port": 993,
  "username": "me@gmail.com",
  "password": "your-app-password"
}

For Gmail, use an App Password rather than your account password.

Signals

Each new email produces a signal with:

  • signal_id — IMAP UID (used for catch-up on reconnect)
  • topic — the mailbox name (e.g. INBOX)
  • payload{from, to, cc, subject, date, message_id, body, headers}
  • summary"From: sender — Subject: subject line"

The headers dict contains all message headers, so you can filter on anything:

{path: "payload.headers.X-GitHub-Event", op: "eq", value: "pull_request"}
{path: "payload.from", op: "contains", value: "github.com"}
{path: "payload.subject", op: "icontains", value: "deploy"}

Filtering

All filtering is client-side for v1. remote_filter_hints() returns an empty list.

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

docketeer_imap-0.0.17.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

docketeer_imap-0.0.17-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file docketeer_imap-0.0.17.tar.gz.

File metadata

  • Download URL: docketeer_imap-0.0.17.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for docketeer_imap-0.0.17.tar.gz
Algorithm Hash digest
SHA256 f25a9ae479fae20c30be2238ceee0738c512f52e4af3f31ca961a99bb30bcdb2
MD5 16889c6270b4d9ad870f6175e0e763c3
BLAKE2b-256 15a2a9fae7bd9240bc228b2843456d0a3722122c2ecdd51d520897f309a5622b

See more details on using hashes here.

Provenance

The following attestation bundles were made for docketeer_imap-0.0.17.tar.gz:

Publisher: publish.yml on chrisguidry/docketeer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docketeer_imap-0.0.17-py3-none-any.whl.

File metadata

File hashes

Hashes for docketeer_imap-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 4326617e46a6b065b543bee073cd837cfe000be13bcc5edcd0afd5dd5aea8734
MD5 254db12131f1ac20bde7044c796f14e7
BLAKE2b-256 f9a50efcaa9e34d1ce7c5cfdaaa91f837ee0991ce7ceb8ac4b5146e21e826cd8

See more details on using hashes here.

Provenance

The following attestation bundles were made for docketeer_imap-0.0.17-py3-none-any.whl:

Publisher: publish.yml on chrisguidry/docketeer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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