Mailboxes: methods overview

Mailboxes in Bitrix24 store the user's email connection parameters and a set of available sender addresses.

Using the methods in this section, you can:

• retrieve a list of connected mailboxes
• request mailbox data by its identifier
• find available sender addresses
• view a list of mailbox fields and the description of a specific field

Quick links: all methods

User documentation: Connect mailboxes to Bitrix24

When to use each methodWhen to use each method

Use mail.mailbox.list when you need to retrieve a list of available mailboxes and select a id for further requests.

Use mail.mailbox.get when you need to retrieve the parameters of a specific mailbox by its id.

Use mail.mailbox.senders when you need to retrieve a list of sender addresses available to the current user.

Use mail.mailbox.field.list and mail.mailbox.field.get when you need to:

• find available mailbox fields
• retrieve the types and metadata of a specific field

Workflow for working with mailboxesWorkflow for working with mailboxes

1. Retrieve a list of mailboxes via mail.mailbox.list
2. Select the required id and retrieve details via mail.mailbox.get
3. Retrieve sender addresses via mail.mailbox.senders before sending an email
4. Clarify the field structure via *.field.list and *.field.get

Section limitationsSection limitations

• The set of available mailboxes and senders depends on the current user's permissions
• The methods in this section do not send emails, but prepare data for working with emails

Connection with Other ObjectsConnection with Other Objects

Emails. The mailbox identifier is used in mail.message.* methods to search for and process emails in the required mailbox.

Overview of MethodsOverview of Methods

Scope: mail

Who can execute the methods: depends on the method

Method	Description
mail.mailbox.list	Returns a list of the current user's mailboxes
mail.mailbox.get	Returns a mailbox by identifier
mail.mailbox.senders	Returns sender addresses available to the current user
mail.mailbox.field.list	Returns a list of mailbox fields
mail.mailbox.field.get	Returns a description of a mailbox field

Continue LearningContinue Learning

• E-mails in mail: methods overview
• Mail recipients: method overview
• Webmail in REST 3.0: section overview