The Emails resource represents emails in actions.
Resource Properties
Scope Parameter | emails |
---|
Location | /emails |
---|
Methods | GET POST PUT DELETE |
---|
Default Page Size | 50 |
---|
Max Page Size | 200 |
---|
Default Includes | None |
---|
Resource Attributes
Field | Description | Format | Required | Field Type | Restrictions | Notes |
---|
direction |
| string (1) | true | default |
| I for incoming mail or O for outgoing mail |
status |
| string | true | default |
|
|
uniqueMessageId |
| string | false | default |
|
|
subject |
| string | false | default |
|
|
bodyText |
| string | false | default |
|
|
bodyHtml |
| string | false | default |
|
|
readConfirmedTimestamp |
| timestamp | false | default |
|
|
deliveryConfirmedTimestamp |
| timestamp | false | default |
|
|
createdTimestamp |
| timestamp | true | default |
|
|
priority |
| string | true | default |
| . |
sensitivity |
| string | true | default |
|
|
sentTimestamp |
| timestamp | false | default |
|
|
receivedTimestamp |
| timestamp | false | default |
|
|
flag |
| integer | true | default |
|
|
attachmentCount |
| integer | true | default |
|
|
emailSize |
| integer | true | default |
|
|
recipients |
| string | false | default |
|
|
to |
| string | false | default |
|
|
cc |
| string | false | default |
|
|
bcc |
| string | false | default |
|
|
from |
| string | true | default |
|
|
deliveredTo |
| string | false | default |
|
|
replyTo |
| string | false | default |
|
|
readConfirmationTo |
| string | false | default |
|
|
deliveryConfirmationTo |
| string | false | default |
|
|
size |
| integer | false | default |
|
|
externalReference |
| string | false | default |
|
|
createdBy |
| string | false | link |
|
|
parent |
| string | false | link |
|
|
Link Templates
Identifier | Resource | Location Template |
---|
emails.createdBy | participants | /participants/{emails.createdBy} |
emails.parent | emails | /emails/{emails.parent} |