Back

POST api/v1/Mail

Requires Authorization

Send email.For a customer admin or administrator 'FromAddress' will be used from the request parameter.
For all other users as well as in the case when 'FromAddress' is not specified by an administrator user, 'FromAddress' will be logged in user's username(emailaddress).

Request Information

URI Parameters

None.

Body Parameters

mail message parameter

MailBindingModel

Name	Description	Type	Additional information
From	Sender's email address	string	None.
To	List of recipient email addresses separated by ";" or ","	string	None.
Cc	List of cc recipient email addresses separated by ";" or ","	string	None.
Bcc	List of Bcc recipient email addresses separated by ";" or ","	string	None.
Subject	Email subject	string	None.
TimeZoneOffset	TimeZoneOffset. Timezoneoffset should be specified in format ±hh:mm	string	None.
Body	Body of the email	string	None.
Attachments	This is a list of attachment ids. When attachments are uploaded through api/Upload , a string id is returned on successful file upload. Include these ids for the email attachment(s).This property should be ignored if there are no attachments. If the cumulative size of attachments exceeeds 100 MB , attachments will be available for download separately via a secured website.	Collection of string	None.
Options	This is a dictionary (key , value pair) .This property should be ignored if no specific mail headers need to be included. Here is an example of Options - {"X-RPost-Sidenote-Text" : "Side note example", "X-RPost-Sidenote-Cc" : 1 }	Dictionary of string [key] and string [value]	None.
IsLargeMail	If large mail is set to true , the email attachments will available for download separately and not attached to the email.The email will contain a link to download the attachments. By default it is set to false.	boolean	None.

Sample Request

Request Formats

application/json, text/json

Sample:

{
  "From": "sender@example.com",
  "To": "recipient1@example.com;recipient2@example.com",
  "Cc": "Ccrecipient1@example.com;Ccrecipient2@example.com",
  "Bcc": "Bccrecipient1@example.com;Bccrecipient2@example.com",
  "Subject": "Sample email",
  "TimeZoneOffset": null,
  "Body": "This is an example email",
  "Attachments": [
    "adoim766",
    "asytqmP"
  ],
  "Options": {
    "X-RPost-Sidenote-Text": "Side note example",
    "X-RPost-Sidenote-Cc": "1"
  },
  "IsLargeMail": false
}

Response Information

Resource Description

string

Sample Response

application/json, text/json

Sample:

"sample string"