POST api/{version}/Email?noDecrypt={noDecrypt}
Sends an encrypted email. This is the method all of the addins use to send encrypted email. The maximum size of the message (body, headers and attachments) cannot exceed 25MB. We recommend checking the size of the message before sending the request. Attachments must be base64 encoded and as such you can expect an increase in size of up to 30%.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| noDecrypt | boolean |
Default value is False |
|
| version | string |
None. |
Body Parameters
Email| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| From | MailAddress |
Required |
|
| Recipients |
The To, Cc, and Bcc recipients. |
Collection of Recipient |
Required Max length: 500 |
| Subject | string |
Max length: 255 |
|
| Body |
A convenient shortcut for providing a plaintext or Html formatted body. Use AlternateViews to specify both plaintext and Html or another content type. Note: At this time only HTML format is supported. |
string |
None. |
| IsBodyHtml |
Specifies whether the Body property is plaintext or Html. Default: false. |
boolean |
None. |
| ReplyTo | MailAddress |
None. |
|
| Headers |
Specify any custom mail headers. |
Dictionary of string [key] and string [value] |
None. |
| AlternateViews |
Note: This conforms to a future spec that hasn't been implemented yet. A collection of message bodies in specific formats. Note: Highest priority is last in the collection. Ex. To specify Html as a priority over a plaintext view you would order the array like so: [PlainText, HTML]. |
Collection of AlternateView |
None. |
| Attachments | Collection of Attachment |
Max length: 500 |
|
| AllSecurityPolicy |
Specifies the macro template used to set all of the recipient security policies at once. Used to persist options in the Delivery Trust Web Portal. If the email you are sending doesn't originate through a UI this property might not be applicable. |
SecurityPolicy |
None. |
| SentOn | date |
None. |
|
| HasEsignPackage | boolean |
None. |
Request Formats
application/json, text/json
{
"Id": "cb6334a0-86a6-4c73-be83-d1dcfcacd89f",
"From": {
"DisplayName": "sample string 1",
"Address": "sample string 2"
},
"Recipients": [
{
"SecurityPolicy": {
"MFAAuthenticationEnabled": true,
"MFAAuthenticationPhone": "sample string 2",
"MobileLast4Enabled": true,
"MobileLast4": "sample string 4",
"BusinessLast4Enabled": true,
"BusinessLast4": "sample string 6",
"BusinessPostalCodeEnabled": true,
"BusinessPostalCode": "sample string 8",
"PasswordEnabled": true,
"Password": "sample string 10",
"CustomQuestion": "sample string 11",
"CustomAnswer": "sample string 12",
"CustomQuestionEnabled": true,
"DisablePrinting": true,
"DisableForwarding": true,
"DisableEmailDownloading": true,
"DisableAttachmentDownloading": true,
"DaysAvailable": 18,
"ViewLimit": 19,
"EnforcePolicy": true,
"CopyToSelf": true,
"RequestRecipientReadNotification": true,
"EnforceEmailIntegrity": true
},
"Type": 1,
"ReadUrl": "sample string 1",
"DisplayName": "sample string 2",
"Address": "sample string 3"
},
{
"SecurityPolicy": {
"MFAAuthenticationEnabled": true,
"MFAAuthenticationPhone": "sample string 2",
"MobileLast4Enabled": true,
"MobileLast4": "sample string 4",
"BusinessLast4Enabled": true,
"BusinessLast4": "sample string 6",
"BusinessPostalCodeEnabled": true,
"BusinessPostalCode": "sample string 8",
"PasswordEnabled": true,
"Password": "sample string 10",
"CustomQuestion": "sample string 11",
"CustomAnswer": "sample string 12",
"CustomQuestionEnabled": true,
"DisablePrinting": true,
"DisableForwarding": true,
"DisableEmailDownloading": true,
"DisableAttachmentDownloading": true,
"DaysAvailable": 18,
"ViewLimit": 19,
"EnforcePolicy": true,
"CopyToSelf": true,
"RequestRecipientReadNotification": true,
"EnforceEmailIntegrity": true
},
"Type": 1,
"ReadUrl": "sample string 1",
"DisplayName": "sample string 2",
"Address": "sample string 3"
}
],
"Subject": "sample string 2",
"Body": "sample string 3",
"IsBodyHtml": true,
"ReplyTo": {
"DisplayName": "sample string 1",
"Address": "sample string 2"
},
"Headers": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"AlternateViews": [
{
"Body": "sample string 1",
"ContentType": 0
},
{
"Body": "sample string 1",
"ContentType": 0
}
],
"Attachments": [
{
"Name": "sample string 1",
"Data": "QEA=",
"ContentId": "sample string 2",
"Size": 3,
"SizeStr": "sample string 4",
"DownloadUrl": "sample string 5"
},
{
"Name": "sample string 1",
"Data": "QEA=",
"ContentId": "sample string 2",
"Size": 3,
"SizeStr": "sample string 4",
"DownloadUrl": "sample string 5"
}
],
"AllSecurityPolicy": {
"MFAAuthenticationEnabled": true,
"MFAAuthenticationPhone": "sample string 2",
"MobileLast4Enabled": true,
"MobileLast4": "sample string 4",
"BusinessLast4Enabled": true,
"BusinessLast4": "sample string 6",
"BusinessPostalCodeEnabled": true,
"BusinessPostalCode": "sample string 8",
"PasswordEnabled": true,
"Password": "sample string 10",
"CustomQuestion": "sample string 11",
"CustomAnswer": "sample string 12",
"CustomQuestionEnabled": true,
"DisablePrinting": true,
"DisableForwarding": true,
"DisableEmailDownloading": true,
"DisableAttachmentDownloading": true,
"DaysAvailable": 18,
"ViewLimit": 19,
"EnforcePolicy": true,
"CopyToSelf": true,
"RequestRecipientReadNotification": true,
"EnforceEmailIntegrity": true
},
"SentOn": "2026-04-05T05:03:57.752847+00:00",
"HasEsignPackage": true
}
application/xml, text/xml
<Email xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
<AllSecurityPolicy>
<BusinessLast4>sample string 6</BusinessLast4>
<BusinessLast4Enabled>true</BusinessLast4Enabled>
<BusinessPostalCode>sample string 8</BusinessPostalCode>
<BusinessPostalCodeEnabled>true</BusinessPostalCodeEnabled>
<CopyToSelf>true</CopyToSelf>
<CustomAnswer>sample string 12</CustomAnswer>
<CustomQuestion>sample string 11</CustomQuestion>
<CustomQuestionEnabled>true</CustomQuestionEnabled>
<DaysAvailable>18</DaysAvailable>
<DisableAttachmentDownloading>true</DisableAttachmentDownloading>
<DisableEmailDownloading>true</DisableEmailDownloading>
<DisableForwarding>true</DisableForwarding>
<DisablePrinting>true</DisablePrinting>
<EnforceEmailIntegrity>true</EnforceEmailIntegrity>
<EnforcePolicy>true</EnforcePolicy>
<MFAAuthenticationEnabled>true</MFAAuthenticationEnabled>
<MFAAuthenticationPhone>sample string 2</MFAAuthenticationPhone>
<MobileLast4>sample string 4</MobileLast4>
<MobileLast4Enabled>true</MobileLast4Enabled>
<Password>sample string 10</Password>
<PasswordEnabled>true</PasswordEnabled>
<RequestRecipientReadNotification>true</RequestRecipientReadNotification>
<ViewLimit>19</ViewLimit>
</AllSecurityPolicy>
<AlternateViews>
<AlternateView>
<Body>sample string 1</Body>
<ContentType>Plain</ContentType>
</AlternateView>
<AlternateView>
<Body>sample string 1</Body>
<ContentType>Plain</ContentType>
</AlternateView>
</AlternateViews>
<Attachments>
<Attachment>
<ContentId>sample string 2</ContentId>
<Data>QEA=</Data>
<DownloadUrl>sample string 5</DownloadUrl>
<Name>sample string 1</Name>
<Size>3</Size>
<SizeStr>sample string 4</SizeStr>
</Attachment>
<Attachment>
<ContentId>sample string 2</ContentId>
<Data>QEA=</Data>
<DownloadUrl>sample string 5</DownloadUrl>
<Name>sample string 1</Name>
<Size>3</Size>
<SizeStr>sample string 4</SizeStr>
</Attachment>
</Attachments>
<Body>sample string 3</Body>
<From>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
</From>
<HasEsignPackage>true</HasEsignPackage>
<Headers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Headers>
<Id>cb6334a0-86a6-4c73-be83-d1dcfcacd89f</Id>
<IsBodyHtml>true</IsBodyHtml>
<Recipients>
<Recipient>
<Address>sample string 3</Address>
<DisplayName>sample string 2</DisplayName>
<ReadUrl>sample string 1</ReadUrl>
<SecurityPolicy>
<BusinessLast4>sample string 6</BusinessLast4>
<BusinessLast4Enabled>true</BusinessLast4Enabled>
<BusinessPostalCode>sample string 8</BusinessPostalCode>
<BusinessPostalCodeEnabled>true</BusinessPostalCodeEnabled>
<CopyToSelf>true</CopyToSelf>
<CustomAnswer>sample string 12</CustomAnswer>
<CustomQuestion>sample string 11</CustomQuestion>
<CustomQuestionEnabled>true</CustomQuestionEnabled>
<DaysAvailable>18</DaysAvailable>
<DisableAttachmentDownloading>true</DisableAttachmentDownloading>
<DisableEmailDownloading>true</DisableEmailDownloading>
<DisableForwarding>true</DisableForwarding>
<DisablePrinting>true</DisablePrinting>
<EnforceEmailIntegrity>true</EnforceEmailIntegrity>
<EnforcePolicy>true</EnforcePolicy>
<MFAAuthenticationEnabled>true</MFAAuthenticationEnabled>
<MFAAuthenticationPhone>sample string 2</MFAAuthenticationPhone>
<MobileLast4>sample string 4</MobileLast4>
<MobileLast4Enabled>true</MobileLast4Enabled>
<Password>sample string 10</Password>
<PasswordEnabled>true</PasswordEnabled>
<RequestRecipientReadNotification>true</RequestRecipientReadNotification>
<ViewLimit>19</ViewLimit>
</SecurityPolicy>
<Type>To</Type>
</Recipient>
<Recipient>
<Address>sample string 3</Address>
<DisplayName>sample string 2</DisplayName>
<ReadUrl>sample string 1</ReadUrl>
<SecurityPolicy>
<BusinessLast4>sample string 6</BusinessLast4>
<BusinessLast4Enabled>true</BusinessLast4Enabled>
<BusinessPostalCode>sample string 8</BusinessPostalCode>
<BusinessPostalCodeEnabled>true</BusinessPostalCodeEnabled>
<CopyToSelf>true</CopyToSelf>
<CustomAnswer>sample string 12</CustomAnswer>
<CustomQuestion>sample string 11</CustomQuestion>
<CustomQuestionEnabled>true</CustomQuestionEnabled>
<DaysAvailable>18</DaysAvailable>
<DisableAttachmentDownloading>true</DisableAttachmentDownloading>
<DisableEmailDownloading>true</DisableEmailDownloading>
<DisableForwarding>true</DisableForwarding>
<DisablePrinting>true</DisablePrinting>
<EnforceEmailIntegrity>true</EnforceEmailIntegrity>
<EnforcePolicy>true</EnforcePolicy>
<MFAAuthenticationEnabled>true</MFAAuthenticationEnabled>
<MFAAuthenticationPhone>sample string 2</MFAAuthenticationPhone>
<MobileLast4>sample string 4</MobileLast4>
<MobileLast4Enabled>true</MobileLast4Enabled>
<Password>sample string 10</Password>
<PasswordEnabled>true</PasswordEnabled>
<RequestRecipientReadNotification>true</RequestRecipientReadNotification>
<ViewLimit>19</ViewLimit>
</SecurityPolicy>
<Type>To</Type>
</Recipient>
</Recipients>
<ReplyTo>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
</ReplyTo>
<SentOn>2026-04-05T05:03:57.752847+00:00</SentOn>
<Subject>sample string 2</Subject>
</Email>
application/x-www-form-urlencoded
Sample not available.
application/bson
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |