Sendio.Mailboxes (sendio v1.1.0)

Manage mailboxes in Sendio: real email accounts with an IMAP/SMTP login.

Summary

Functions

create(client \\ Sendio.client(), opts)

Creates a new mailbox. The domain must be verified; an address that already exists returns a 409 error.

list(client \\ Sendio.client())

Lists all mailboxes.

remove(client \\ Sendio.client(), mailbox_id)

Removes a mailbox: the email account, and the agent inbox on it if there is one. Caution: This can't be undone!

reset_password(client \\ Sendio.client(), mailbox_id)

Resets the IMAP/SMTP password of a mailbox. The old password stops working.

update(client \\ Sendio.client(), mailbox_id, opts)

Updates a mailbox.

Functions

create(client \\ Sendio.client(), opts)

@spec create(Sendio.Client.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Mailboxes.Mailbox.t())

Creates a new mailbox. The domain must be verified; an address that already exists returns a 409 error.

Parameter options, either:

:address - The full address, e.g. "support@yourdomain.com"
:local_part and :domain_id - The part before the @ and the ID of the domain

or, for a free mailbox (no domain):

:username - The username (required)
:org - The organization
:display_name - The display name

When IMAP/SMTP is ready, the :credentials field in the response struct is the only time you will see the password. It is also an API key for that mailbox, keep it somewhere safe.