bx24_mail
Handle Bitrix24 email tasks: manage mailboxes, send, reply, forward messages, list recipients, and configure filters and mail services through the REST API.
Instructions
Bitrix24 mail: mailboxes, messages, send, reply, forward, filters, recipient. Methods mail.mailbox., mail.message., mail.recipient., mailservice. (REST 1.0 + 3.0). RU/EN: почта, письмо, отправить письмо, ящик, фильтр / mail, email, send email, mailbox, filter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Entity ID | |
| order | No | Order object (e.g. { 'ID': 'DESC' }) | |
| start | No | Pagination offset (number of records to skip) | |
| action | Yes | Operation to perform: - "mailbox_list": List mailboxes - "mailbox_get": Get a mailbox - "mailbox_add": Add a mailbox - "mailbox_delete": Delete a mailbox (destructive) - "mailbox_senders": List available senders for a mailbox - "mailbox_field_list": List mailbox fields - "mailbox_field_get": Get a mailbox field - "message_list": List messages - "message_get": Get a message - "message_send": Send an email (TO, SUBJECT, BODY) - "message_delete": Delete a message (destructive) - "message_reply": Reply to a message - "message_forward": Forward a message - "message_mark": Mark a message (seen/flagged) - "message_movetofolder": Move a message to a folder (destructive — leaves inbox) - "message_createtask": Create a task from a message - "message_createcalendarevent": Create a calendar event from a message - "message_createchat": Create a chat from a message - "message_createfeedpost": Create a news feed post from a message - "message_createcrmactivity": Create a CRM activity from a message - "message_removecrmactivity": Remove the CRM activity link from a message (destructive) - "message_field_list": List message fields - "message_field_get": Get a message field - "recipient_list": List recipients - "recipient_listcontacts": Search address book contacts - "recipient_listemployees": Search portal employees - "recipient_field_list": List recipient fields - "recipient_field_get": Get a recipient field - "mailservice_list": List mail services - "mailservice_add": Add a mail service - "mailservice_get": Get a mail service - "mailservice_delete": Delete a mail service (destructive) - "mailservice_fields": Describe mail service fields - "filter_add": Add a mail filter - "filter_delete": Delete a mail filter (destructive) - "filter_list": List mail filters | |
| fields | No | Message/mailbox/service fields (per Bitrix24 docs for the method) | |
| filter | No | Filter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' }) | |
| select | No | Array of field names to return (projection) | |
| confirm | No | Set to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled. | |
| folderId | No | Target folder ID for movetofolder | |
| mailboxId | No | Mailbox ID | |
| messageId | No | Message ID | |
| taskFields | No | Task fields for message_createtask | |
| filterFields | No | Filter fields: NAME, MAILBOX_ID, ACTION |