Skip to content

CLI reference

ry mail

Markdown

Transactional email: sending domains, log, inbox, suppressions.

ry mail [options] [command]

The domains you send from.

ry mail domains [options] [command]

Show your sending domains with status.

ry mail domains list [options]

Example:

ry mail domains list

Claim a sending domain and print the DNS records to set.

ry mail domains add [options] <domain>

Example:

ry mail domains add mail.example.com

The records of a domain with what DNS shows, and the receiving side.

ry mail domains show [options] <domain>

Example:

ry mail domains show mail.example.com

Look DNS up now and verify the domain if the required records are there.

ry mail domains check [options] <domain>

Example:

ry mail domains check mail.example.com

Give a sending domain back - waiting messages, its log and its inbox go with it (not within 14 days of its last send).

ry mail domains remove [options] <domain>

Options:

  • -y, --yes: Skip confirmation (required for automation).

Example:

ry mail domains remove mail.example.com

Your sent messages, newest first, with their delivery status.

ry mail log [options]

Options:

  • -n, --limit <n>: How many entries (control plane caps at 500). Default: 50.

Example:

ry mail log

One message and every event the deliverer recorded for it.

ry mail show [options] <id>

Example:

ry mail show msg-1a2b3c4d

What arrived at your receiving addresses.

ry mail inbox [options] [command]

Received messages, newest first.

ry mail inbox list [options]

Options:

  • -n, --limit <n>: How many entries. Default: 50.
  • -d, --domain <domain>: Only this receiving domain.

Example:

ry mail inbox list

One received message: headers and the text part.

ry mail inbox show [options] <id>

Options:

  • --raw: Print the raw message instead of the text part.

Example:

ry mail inbox show inb-1a2b3c4d

Addresses you will not send to again.

ry mail suppressions [options] [command]

Your suppression list.

ry mail suppressions list [options]

Example:

ry mail suppressions list

Remove an address from the list after a genuine re-signup (complaints cannot be cleared).

ry mail suppressions clear [options] <address>

Example:

ry mail suppressions clear someone@example.com

The addresses a domain receives at.

ry mail routes [options] [command]

Receiving addresses of a domain.

ry mail routes list [options] <domain>

Example:

ry mail routes list mail.example.com

Receive mail at an address (a local part, a full address under the domain, or * for all).

ry mail routes add [options] <domain> <address>

Example:

ry mail routes add mail.example.com support

Stop receiving at an address (id, address or local part).

ry mail routes remove [options] <domain> <route>

Options:

  • -y, --yes: Skip confirmation (required for automation).

Example:

ry mail routes remove mail.example.com rt-1a2b3c4d