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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f25a9ae479fae20c30be2238ceee0738c512f52e4af3f31ca961a99bb30bcdb2
|
|
| MD5 |
16889c6270b4d9ad870f6175e0e763c3
|
|
| BLAKE2b-256 |
15a2a9fae7bd9240bc228b2843456d0a3722122c2ecdd51d520897f309a5622b
|
Provenance
The following attestation bundles were made for docketeer_imap-0.0.17.tar.gz:
Publisher:
publish.yml on chrisguidry/docketeer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docketeer_imap-0.0.17.tar.gz -
Subject digest:
f25a9ae479fae20c30be2238ceee0738c512f52e4af3f31ca961a99bb30bcdb2 - Sigstore transparency entry: 1083172082
- Sigstore integration time:
-
Permalink:
chrisguidry/docketeer@34ea31823f6cab8f6bf1312ee3b0829f2f3b2b9f -
Branch / Tag:
refs/tags/0.0.17 - Owner: https://github.com/chrisguidry
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@34ea31823f6cab8f6bf1312ee3b0829f2f3b2b9f -
Trigger Event:
release
-
Statement type:
File details
Details for the file docketeer_imap-0.0.17-py3-none-any.whl.
File metadata
- Download URL: docketeer_imap-0.0.17-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4326617e46a6b065b543bee073cd837cfe000be13bcc5edcd0afd5dd5aea8734
|
|
| MD5 |
254db12131f1ac20bde7044c796f14e7
|
|
| BLAKE2b-256 |
f9a50efcaa9e34d1ce7c5cfdaaa91f837ee0991ce7ceb8ac4b5146e21e826cd8
|
Provenance
The following attestation bundles were made for docketeer_imap-0.0.17-py3-none-any.whl:
Publisher:
publish.yml on chrisguidry/docketeer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docketeer_imap-0.0.17-py3-none-any.whl -
Subject digest:
4326617e46a6b065b543bee073cd837cfe000be13bcc5edcd0afd5dd5aea8734 - Sigstore transparency entry: 1083172165
- Sigstore integration time:
-
Permalink:
chrisguidry/docketeer@34ea31823f6cab8f6bf1312ee3b0829f2f3b2b9f -
Branch / Tag:
refs/tags/0.0.17 - Owner: https://github.com/chrisguidry
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@34ea31823f6cab8f6bf1312ee3b0829f2f3b2b9f -
Trigger Event:
release
-
Statement type: