Email business object properties

During external service discovery, the adapter generates the email business object. This parent business object includes all the header, encoding, and mail content details that the adapter needs to process both inbound and outbound requests.

The following table lists the attributes of the email business object. For the simple alert email business object structure, a number of header fields (such as To and From) are part of the email wrapper business object. These header fields are not part of the email wrapper business object with other business object structures (such as the generic email data type). For this reason, all the header values available in the simple alert email wrapper business object are not listed in this topic. For a list and description for each of the properties available in the simple alert email version of the wrapper business object, see Header business object properties.

Each property available with all versions of the email business object is described completely in the sections that follow the table.

Note: In business object attributes, the use of the [] symbol denotes an array of values.

Table 1. Email business object attributes
Business object attribute name	Description
Encoding	Contains outbound data encoding information when you do not use data transformation.
File references	Contains the list of files that must be attached to an outbound email.
Header list	Contains header details for all the headers listed in an inbound email request.
Mail attachments	Stores the content for the attachments of an email.
Mail content	Stores the content for the body of an email. This attribute does not include email attachments.

Encoding

This attribute is set during outbound communications to indicate the type of character encoding the adapter will use.

Table 2. Encoding details
Required	No
Default	No default value
Attribute type	String
Usage	Encoding is used for headers, mail content, and attachment business objects.
Example	The following are the examples of the encoding attribute: ASCII for character encoding based on the English alphabet Big5 for character encoding based on traditional Chinese characters GB18030 for globalized characters in a business graph
Globalized	No
Bidi supported	No

File references

This attribute contains a list of files that must be attached to an outbound email. This attribute is not used during inbound processing.

Table 3. File references details
Required	No
Default	No default value
Attribute type	String []
Usage	During outbound communication, the run time specifies absolute paths for the referenced files listed in this field. The adapter reads these files, which are on the local system with the adapter, and includes them as attachments to the outbound email.
Globalized	Yes
Bidi supported	No

Header List

This attribute is populated with the header details for all the headers listed in a polled email request.

Table 4. Header list details
Required	No
Default	No default value
Attribute type	Header[]
Usage	Headers are the fields in an email, such as To, From, Cc, Bcc, and Subject.
Globalized	Yes
Bidi supported	Yes

Mail attachments

This attribute stores the content details for an attachment in an inbound email request.

Table 5. Mail attachments details
Required	No
Default	No default value
Attribute type	MailAttachment[]
Usage	Stores the content details for an attachment in an inbound email request.
Globalized	Yes
Bidi supported	No

Mail content

During inbound communication, this attribute stores any content found in the body of the email request. During outbound communication, this attribute contains the data that becomes the body of the email being sent to the mail server. This attribute does not include email attachments.

Table 6. Mail content details
Required	Yes
Default	No default value
Attribute type	anyType
Usage	Contains body content of an email.
Globalized	Yes
Bidi supported	No