Get account details: username, plan/subscription, bandwidth used, default alias domain/format, limits, etc.

Get the name, creation date and expiry of the API token this server is using.

Get account notifications/announcements from addy.io.

Get the domains available for creating aliases, plus the account's default alias domain and format.

Get the addy.io app version (only available on self-hosted instances).

List or search aliases. Results are paginated; the response includes meta with totals and page counts.

Get a single alias, including its recipients, labels and statistics.

Create a new alias. Use get_domain_options to see which domains are available.

Update an alias's description, from name, or labels. Only the fields you pass are changed.

Delete an alias. It stops receiving mail but can be brought back with restore_alias.

Restore a deleted alias.

PERMANENTLY forget an alias: it is disassociated from the account and cannot be restored.

Turn an alias option on or off (activate/deactivate, pin/unpin, limit reply/send to attached recipients).

Replace the set of recipients an alias forwards to.

Replace the labels attached to an alias.

Apply one action to up to 25 aliases at once (or fetch them with action='get').

Replace the recipients of up to 25 aliases at once.

Replace the labels of up to 25 aliases at once.

List the account's recipients (the real mailboxes aliases forward to).

Get a single recipient and its settings.

Add a new recipient. addy.io emails it a verification link; it can't be used until verified.

Set a recipient's description.

Delete a recipient. Aliases that used it fall back to the default recipient.

Resend the verification email for an unverified recipient.

Add a public GPG key to a recipient so forwarded mail can be encrypted.

Remove a recipient's public GPG key (this also turns off encryption for it).

Turn a recipient option on or off.

List the account's usernames (each gives a subdomain like name.anonaddy.com for on-the-fly aliases).

Get a single username and its settings.

Create an additional username (counts against the plan's username limit).

Update a username's description, from name, or auto-create regex.

Delete a username. Its aliases stop working.

Set (or clear) the default recipient for aliases on a username.

Turn a username option on or off.

List the custom domains connected to the account.

Get a single custom domain and its settings/verification status.

Add a custom domain. Its DNS must already have the TXT verification record addy.io shows in its dashboard.

Update a custom domain's description, from name, or auto-create regex.

Delete a custom domain. Its aliases stop working.

Set (or clear) the default recipient for aliases on a custom domain.

Check a custom domain's DNS records (SPF, DKIM, DMARC, ...) for sending/replying from aliases.

Turn a custom domain option on or off.

List the labels used to organise aliases.

Get a single label.

Create a label for organising aliases.

Rename a label or change its colour.

Delete a label (aliases are kept, just unlabelled).

List all rules, in the order they are applied.

Get a single rule with its conditions and actions.

Create a rule that runs actions on emails matching conditions.

Example: block newsletters to a specific alias -> conditions=[{type:'alias', match:'is exactly', values:['shop@anonaddy.me']}, {type:'header', match:'exists', values:['List-Unsubscribe']}], actions=[{type:'block'}].

Update a rule. Only the fields you pass change; the rest are kept from the current rule.

Delete a rule.

Set the order rules are applied in.

Activate or deactivate a rule.

List blocked senders/domains, with how many emails each has blocked.

Block mail from sender email addresses or whole domains, across all aliases.

Unblock blocklist entries by id (see list_blocklist).

List emails that addy.io failed to deliver (or quarantined).

Get details of a failed delivery (sender, alias, bounce reason, ...).

Download the raw email (.eml source) of a failed delivery, if addy.io stored it.

Retry delivering a failed or quarantined email.

Delete failed delivery records (and any stored email).