Addresses

Email addresses of users, and forwarded addresses that are not tied to a user account.

📄️ List addresses

Lists all registered addresses, both user addresses and forwarded addresses, with paging.

📄️ Create an address for a user

Add a new email address for a User. Addresses can contain unicode characters. Dots in usernames are normalized so no need to create both '[email protected]' and '[email protected]' Special addresses `*@example.com` and `username@*` catch all emails to these domains or users without a registered destination (requires allowWildcard argument)

📄️ List addresses of a user

Lists the addresses registered for a user.

📄️ Get address details

Returns the details of an address of a user.

📄️ Delete an address of a user

Deletes an address of a user. The main address of a user can not be deleted.

📄️ Update an address of a user

Updates the name, address, tags or metadata of an address, or makes it the main address of the user.

📄️ List addresses from the address register

Lists the addresses the user has received mail from or sent mail to, as collected in the address register. Useful for address autocompletion.

📄️ Update an address register entry

Updates the name of an address register entry, or disables the entry so it is no longer suggested.

📄️ Create a forwarded address

Add a new forwarded email address. Addresses can contain unicode characters. Dots in usernames are normalized so no need to create both '[email protected]' and '[email protected]' Special addresses `*@example.com` and `username@*` catches all emails to these domains or users without a registered destination (requires allowWildcard argument)

📄️ Update a forwarded address

Updates the targets, limits, autoreply settings, tags or metadata of a forwarded address.

📄️ Delete a forwarded address

Deletes a forwarded address.

📄️ Get forwarded address details

Returns the targets, limits and autoreply settings of a forwarded address.

📄️ Resolve an address

Returns the user or forwarded address entry for an email address, also through domain aliases. Wildcard addresses are matched only when allowWildcard is set.

📄️ Rename a domain

Renames domain names for addresses, DKIM keys and Domain Aliases