Webmail in REST 3.0: section overview

Webmail in Bitrix24 allows you to work with e-mails directly in the interface: read and send e-mails, filter correspondence, link e-mails to the CRM, and also create a chat, a task, a calendar event, or a Feed message from an e-mail.

Mail methods work with three groups of objects:

• Mailboxes — show a list of user mailboxes, mailbox data, and available sender addresses
• E-mails — find and retrieve e-mails, send and process an e-mail, and create linked objects from an e-mail
• Recipients — find contacts and employees for addressing e-mails and show recipient fields

Quick links: all methods

User documentation: Manage emails in Bitrix24

Getting StartedGetting Started

1. Retrieve a list of mailboxes using the mail.mailbox.list method
2. Select a mailbox and retrieve the required e-mails using the mail.message.list method
3. Retrieve an e-mail by identifier using the mail.message.get method
4. Perform an action with an e-mail: send a reply, move an e-mail, or create a linked object

To manage mail services, use the methods in the mailservice.* section.

Limitations and recommendationsLimitations and recommendations

• The mail.mailbox.* and mail.message.* methods only work with mailboxes to which the current user has access
• Use the *.field.list and *.field.get methods to check available fields and their types

Connection with Other ObjectsConnection with Other Objects

Mailbox. The mail.mailbox.* methods work with the mailboxes of the current user. The mailbox identifier id is used in methods for retrieving a mailbox and searching for e-mails. Available mailboxes can be retrieved using the mail.mailbox.list method.

E-mail. The mail.message.* methods work with e-mails available to the current user. The e-mail identifier id is required to retrieve an e-mail, reply to it, forward it, move it, or create a linked object.

Recipient. The mail.recipient.* methods help select e-mail recipients. Contacts can be found using the mail.recipient.listcontacts method, and employees via the mail.recipient.listemployees method.

CRM. An e-mail can be linked to a CRM activity using the mail.message.createcrmactivity method. The link can be removed using the mail.message.removecrmactivity method.

Task. An e-mail can be converted into a task using the mail.message.createtask method

Calendar. A calendar event can be created from an e-mail using the mail.message.createcalendarevent method

Chat. The text of an e-mail can be discussed in a chat using the mail.message.createchat method

News feed. An e-mail can be published as a post in the News feed using the mail.message.createfeedpost method

Overview of MethodsOverview of Methods

Scope: mail

Who can execute the methods: depends on the method

MailboxesMailboxes

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 mailbox field description

E-mailsE-mails

Method	Description
mail.message.list	Searches for e-mails in the current user's mailboxes
mail.message.get	Returns an e-mail by identifier
mail.message.thread	Returns an e-mail thread by the identifier of a single e-mail
mail.message.send	Sends a new e-mail
mail.message.reply	Sends a reply to an e-mail
mail.message.forward	Forwards an e-mail
mail.message.movetofolder	Moves e-mails to a folder, spam, or trash
mail.message.createcrmactivity	Creates a CRM activity from an e-mail
mail.message.removecrmactivity	Removes the link between an e-mail and a CRM activity
mail.message.createtask	Creates a task from an e-mail
mail.message.createcalendarevent	Creates a calendar event from an e-mail
mail.message.createchat	Creates a chat from an e-mail
mail.message.createfeedpost	Creates a News Feed message from an e-mail
mail.message.field.list	Returns a list of e-mail fields
mail.message.field.get	Returns an e-mail field description

RecipientsRecipients

Method	Description
mail.recipient.listcontacts	Searches for contacts in the address book
mail.recipient.listemployees	Searches for employees by name or e-mail
mail.recipient.field.list	Returns a list of recipient fields
mail.recipient.field.get	Returns a recipient field description

Continue learningContinue learning

• Overview of REST API 3.0