Skip to main content

Documentation Index

Fetch the complete documentation index at: https://jetemail.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

jetemail inbound covers everything under /inbound/…. Authentication uses your api_… key. 
inbound
├── account
│   ├── allowlist     list | get | create | update | delete
│   ├── blocklist     list | get | create | update | delete
│   └── logs          GET /inbound/account/logs (supports --tail)
├── domains
│   ├── list
│   ├── create        (alias: add)
│   ├── delete <uuid>
│   ├── check <uuid>
│   └── forward-rules list | add | get | update | delete
├── filters
│   ├── allowlist     list | get | create | update | delete
│   └── blocklist     list | get | create | update | delete
├── destinations      list | verify <token> | resend <uuid>
├── logs              GET /inbound/logs (supports --tail)
├── quarantine release <uid>
└── settings          get <uuid> | update <uuid>

​
inbound domains

jetemail inbound domains list
jetemail inbound domains create --domain inbox.example.com --delivery-type forward
jetemail inbound domains check <uuid>
jetemail inbound domains delete <uuid>

​
create flags

FlagDescription
--domain <name>Domain to add (e.g. inbox.example.com).
--delivery-type <type>smtp, webhook, or forward.
--smtp-server <host:port>Destination server. Repeatable. (smtp only)
--webhook-url <url>Endpoint to deliver to.
--webhook-method <verb>POST (default), PUT, etc.
--webhook-header 'Name: Value'Custom request header. Repeatable.
--webhook-timeout <secs>Per-request timeout.
--webhook-retry-count <n>Retry attempts.
--webhook-auth-header <h>Authorization header value.
--body-json <src> / --field k=vRaw body access. See Body escape hatches.
jetemail inbound domains create \
  --domain inbox.example.com \
  --delivery-type webhook \
  --webhook-url https://api.example.com/inbound \
  --webhook-header 'Authorization: Bearer xyz' \
  --webhook-timeout 30

​
inbound domains forward-rules

Per-domain forwarding rules. 
jetemail inbound domains forward-rules list <domain-uuid>

jetemail inbound domains forward-rules add <domain-uuid> \
  --localpart sales \
  --destination 'sales-team@yourcompany.com' \
  --active true

jetemail inbound domains forward-rules get <domain-uuid> <rule-uuid>
jetemail inbound domains forward-rules update <domain-uuid> <rule-uuid> --destination new@example.com
jetemail inbound domains forward-rules delete <domain-uuid> <rule-uuid>
See Forwarding.

​
inbound account (account-level rules and logs)

Account-scoped allowlist and blocklist rules apply across every inbound domain you own. 
jetemail inbound account allowlist list
jetemail inbound account allowlist create --name "trusted-vendor" --sender '*@vendor.com'
jetemail inbound account allowlist get <rule-uuid>
jetemail inbound account allowlist update <rule-uuid> --enabled false
jetemail inbound account allowlist delete <rule-uuid>

# Same shape for blocklist:
jetemail inbound account blocklist list
jetemail inbound account blocklist create --name "spam-domain" --sender '*@phishy.example'

​
Rule body flags

These apply to both create and update:
FlagDescription
--name <str>Human-readable rule name. Required for create.
--description <str>Optional notes.
--enabled <bool>Toggle the rule (update only).
--sender <pattern>Repeatable.
--recipient <pattern>Repeatable.
--subject <pattern>Repeatable.
--body <pattern>Repeatable.
--header <pattern>Repeatable. Free-form.
--ip <pattern>Repeatable.
--attachment <pattern>Repeatable.
--body-json / --field k=vSee Body escape hatches.

​
Account logs

jetemail inbound account logs --limit 50
jetemail inbound account logs --logtype spam --date-from 1715126400
jetemail inbound account logs --tail
Supports the same filter flags as the account logs API (--logtype, --from, --to, --subject, --ip, --date-from, --date-to, --spamscore-min, --spamscore-max, --host, --port, --mode, plus --limit/--offset/--page/--sort-by/--sort-order). --tail opens the live TUI. See Live log tail.

​
inbound filters (per-domain allow/blocklist)

Domain-scoped equivalents of the account rules. The shape is identical, plus the list and create actions take --domain, --subdomain-id, or --subdomain-uuid to scope to a domain. 
jetemail inbound filters allowlist list --domain example.com
jetemail inbound filters allowlist create --domain example.com \
  --name "ship-from-shopify" --sender 'noreply@shopify.com'
jetemail inbound filters allowlist update <rule-uuid> --enabled false
jetemail inbound filters allowlist delete <rule-uuid>

jetemail inbound filters blocklist list --domain example.com
See Inbound rules.

​
inbound destinations

Forwarding destinations (the addresses you forward verified mail to). 
jetemail inbound destinations list
jetemail inbound destinations verify <token>          # consumes the verification token from the email link
jetemail inbound destinations resend <uuid>           # re-send the verification email
See Destination verification.

​
inbound logs

jetemail inbound logs --limit 50
jetemail inbound logs --uuid <domain-uuid> --logtype spam
jetemail inbound logs --tail
jetemail inbound logs --tail --logtype spam --poll-secs 10
Supported filters: --uuid, --subdomain-id, --uid, --logtype, --subject, --from, --to, --spamscore-min, --spamscore-max, --host, --ip, --date-from, --date-to, plus pagination (--limit, --offset, --page, --sort-by, --sort-order). --tail flags: --poll-secs N (default 5), --buffer N (default 500).

​
inbound quarantine release

Release a quarantined message by UID. 
jetemail inbound quarantine release <uid>
See Release from quarantine.

​
inbound settings

Per-domain inbound settings. 
jetemail inbound settings get <domain-uuid>

jetemail inbound settings update <domain-uuid> \
  --status active \
  --delivery-type smtp \
  --smtp-server mx.example.com:25

​
update flags

FlagDescription
--status <state>active or disabled.
--delivery-type <type>smtp, webhook, or forward.
--smtp-server <host:port>Repeatable (smtp).
--webhook-url <url>Endpoint to deliver to (webhook).
--webhook-method <verb>HTTP method.
--webhook-header 'Name: Value'Repeatable.
--webhook-timeout <secs>Per-request timeout.
--webhook-retry-count <n>Retry attempts.
--webhook-auth-header <h>Auth header value.
--body-json / --field k=vSee Body escape hatches.