An object that represents a classic email in Email Studio.
note: To manage Content Builder emails, use the Assets endpoints in REST API.
Properties
| Name | Data Type | Description |
|---|---|---|
CategoryID |
Int | Specifies the identifier of the folder containing the email. |
CharacterSet |
String | Indicates encoding used in an email message. Valid values include:<ul><li>us-ascii (United States)</li><li>shift-jis (Japanese)</li><li>EUC-KR (Korean)</li><li>iso-8859-1 (Western European)</li><li>big5 (Chinese)</li><li>koi8-r (Russian)</li><li>utf-8 (Unicode)</li><li>iso-2022-JP (Japanese)</li><li>iso-8859-2 (Central European)</li><li>ISO-8859-11 (Thai)</li><li>GB2312 (Simplified Chinese)</li><li>iso-8859-6 (Arabic)</li></ul> |
Client |
ClientID object | Specifies the account ownership and context of an object. |
ClonedFromID |
Int | ID of email message from which the specified email message was created. |
ContentAreas |
Array of objects | Contains information about content areas included in an email message. |
ContentCheckStatus |
String | Indicates whether content validation has completed for this email message. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
EmailType |
EmailType | Indicates whether the email contains HTML or plain text. |
Folder |
String | Specifies folder information (Retrieve only) - Deprecated. |
HasDynamicSubjectLine |
Boolean | Indicates whether email message contains a dynamic subject line. |
HTMLBody |
String | Contains HTML body of an email message. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
IsActive |
Boolean | Specifies whether the object is active. |
IsHTMLPaste |
Boolean | Indicates whether email message was created via pasted HTML. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
Name |
String | Name of the object or property. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only by using the API. |
PreHeader |
String | Contains text used in preheader of email message on mobile devices. |
Status |
String | Defines status of object. Status of an address. |
Subject |
String | Contains subject area information for a message. |
SyncTextWithHTML |
Boolean | Makes the text version of an email contain the same content as the HTML version. |
TextBody |
String | Contains raw text body of a message. |
__AdditionalEmailAttribute1 |
String | Optional field that lets you specify up to five email attributes in CREATE or RETRIEVE calls. Used to capture analytics or other metadata. Additional attributes are AdditionalEmailAttribute2, AdditionalEmailAttribute3, and so on. |