E-mails in mail: methods overview

E-mails in Bitrix24 mail are messages in a user's mailboxes, including correspondence threads and related activities.

The section methods allow you to:

• search for e-mails and retrieve an individual e-mail or a thread of e-mails
• send a new e-mail, a reply, or a forward
• move e-mails to folders, spam, or the trash
• create related objects in other tools from an e-mail
• retrieve a list of e-mail fields and the description of a specific field

Quick links: all methods

User documentation: Manage emails in Bitrix24

When to use each methodWhen to use each method

Use mail.message.list when you need to find e-mails in the current user's mailboxes based on filter conditions.

Use mail.message.get when you need to retrieve an e-mail by its id.

Use mail.message.thread when you need to retrieve an e-mail thread by the id of a single e-mail.

Use mail.message.send, mail.message.reply, and mail.message.forward when you need to send a new e-mail, a reply, or a forward.

Use mail.message.movetofolder when you need to move e-mails to a folder, spam, or the trash.

Use mail.message.createcrmactivity and mail.message.removecrmactivity when you need to create or delete a link between an e-mail and a CRM activity.

Use mail.message.createtask, mail.message.createcalendarevent, mail.message.createchat, and mail.message.createfeedpost when you need to pass the e-mail content to a task, calendar, chat, or Feed.

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

• find out the available e-mail fields
• retrieve the types and metadata of a specific field

Workflow for working with e-mailsWorkflow for working with e-mails

1. Retrieve a list of e-mails via mail.message.list
2. Retrieve full e-mail data via mail.message.get or a thread via mail.message.thread
3. Perform the target action: send a new e-mail, a reply, or a forward via mail.message.send, mail.message.reply, mail.message.forward
4. If necessary, move e-mails to another folder via mail.message.movetofolder or create related objects in CRM, tasks, calendar, chat, and Feed
5. Clarify the field structure via *.field.list and *.field.get

Section restrictionsSection restrictions

• The current user can only work with e-mails from mailboxes they have access to
• Most operations require a correct id of an e-mail from mail.message.list or mail.message.get

Connection with Other ObjectsConnection with Other Objects

Mailbox. Section methods work with e-mails in the user's mailboxes. A mailbox identifier can be retrieved using mail.mailbox.* methods.

Recipient. To select recipients, use mail.recipient.* methods.

CRM. An e-mail can be linked to a CRM activity, and this link can be removed via mail.message.createcrmactivity and mail.message.removecrmactivity methods.

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

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 post from an e-mail
mail.message.field.list	Returns a list of e-mail fields
mail.message.field.get	Returns the description of an e-mail field

Continue LearningContinue Learning

• Mailboxes: methods overview
• Mail recipients: method overview
• Webmail in REST 3.0: section overview