Get Started
Portal api methods
Help

PUT api/2.0/mail/messages/send This function requires authentication

Description

Sends the message with the ID specified in the request

Parameters
Name Description Type Example
id
sent in body
Message id which will be saved or 0. number 1234
from
sent in body
From email. Format: Name string some text
to
sent in body
List of "to" emails. Format: Name System.Collections.Generic.List`1[System.String]
cc
sent in body
List of "cc" emails. Format: Name System.Collections.Generic.List`1[System.String]
bcc
sent in body
List of "bcc" emails. Format: Name System.Collections.Generic.List`1[System.String]
mimeReplyToId
sent in body
Message id to which the reply answer string some text
importance
sent in body
Importanse flag. Values: true - important, false - not important. Bool value true
subject
sent in body
Message subject string some text
tags
sent in body
List of tags id added to message System.Collections.Generic.List`1[System.Int32]
body
sent in body
Message body as html string. string some text
attachments
sent in body
List of attachments represented as MailAttachment object
fileLinksShareMode
sent in body
Share mode for attached file links None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms
calendarIcs
sent in body
Calendar event ical-format for sending string some text
isAutoreply
sent in body
Indicate that message is autoreply or not Bool value true
requestReceipt
sent in body
Add request Return-Receipt-To header
optional
Bool value true
requestRead
sent in body
Add request Disposition-Notification-To header
optional
Bool value true
Example
PUT api/2.0/mail/messages/send
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "id": 1234,
  "from": "some text",
  "to": [
    "some text"
  ],
  "cc": [
    "some text"
  ],
  "bcc": [
    "some text"
  ],
  "mimeReplyToId": "some text",
  "importance": true,
  "subject": "some text",
  "tags": [
    1234
  ],
  "body": "some text",
  "attachments": [],
  "fileLinksShareMode": "None",
  "calendarIcs": "some text",
  "isAutoreply": true,
  "requestReceipt": true,
  "requestRead": true
}
Returns

message id