IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Email > Reference > Business object information
Header business object properties
Header business object properties are used to store standard (RFC822) email headers and headers customized by you. They are populated dynamically by the adapter and comprise a name and value pair. Customized headers and their related information are tracked by the adapter with the help of the headerList entries in the email business object.
The adapter picks up the header name from the HeaderList property in the email business object. Each header can have multiple values, but Bcc and Resent-bcc headers cannot be retrieved from an email. However, they can be sent on an email.
All headers are encoded by the adapter in the specified character set. Because To and From header values are required, the adapter ends the outbound Create operation, if the encoding of either of those header values fails. The JavaMail API does not provide enough information to decipher the character set and encoding information for the header content; hence header content might not be globalized
The following table provides example header business object name and value pairs.
Examples of header business object name and value pairs Name Value HeaderName = to HeaderValue = abc@xyz.com HeaderName = cc HeaderValue = def@xyz.com HeaderName = mimetype HeaderValue = text/plain
The following table lists the Standard email Headers supported by the adapter. A more detailed description of each property is provided in the sections that follow the table. For more information about how to read the property detail tables in the sections that follow, see Guide to information about properties.
Standard email Headers supported by the adapter Property name Description Bcc The blind carbon copy addresses for the email Cc The email addresses for secondary recipients of the email Comments Specifies whether text comments can be added to the message body Date The date the email was created Encrypted Specifies whether the body of a message was encrypted by the sender From The address that the email was sent from In reply to Subject line of previous correspondence that the email message is responding to Keywords Keywords or phrases contained in the email separated by commas Message identifier The unique identifier (local-part address unit) referring to the particular version of a particular message References Other pieces of email correspondence referenced by this email Reply to Addresses to which the responses to the email is sent Resent - bcc Blind carbon copy addresses for the email Resent - cc Email addresses for secondary or informational recipients of the email Resent - date The date the email was forwarded Resent - from The address that the email was resent from Resent - message identifier The unique identifier (local-part address unit) that refers explicitly to a particular version of a particular message Resent - reply to Addresses to which the responses to the email is sent Resent - sender Authenticated identity of the agent (person, system, or process) sending the email message Resent - to Addresses of the primary recipients of the email Sender Authenticated identity of the agent (person, system, or process) sending the email message Subject Summary of what the email is about To Addresses of the primary recipients of the email
Blind carbon copy (Bcc)
This property specifies blind carbon copy addresses for the email. The addresses listed in this field are not included in copies of the message sent to the primary and secondary recipients.
Blind carbon copy details Required No Default No default value Property type String Usage This header is only supported for outbound communication.
Some systems choose to include the text of the Bcc field only in the copy of the author,
while some systems include these addresses to all those recipients listed in the Bcc field.Globalized Yes Bidi supported Yes
Carbon copy (Cc)
This property specifies the email addresses of secondary recipients of the email.
Carbon copy details Required No Default No default value Property type String Usage Specifies email addresses of secondary recipients of the email. All recipients listed in this field are visible to anyone receiving the email. Globalized Yes Bidi supported Yes
Comments
This property allows the addition of text comments to the message body without disturbing the message body content.
Comments details Required No Default No default value Property type String Usage Allows the addition of text comments to the message body without disturbing the message body content. Bidi supported No
Date
The date set by the mail server of the sender during inbound processing. The date the email is created during outbound processing.
Date details Required No Default No default value Property type String Usage The date set by the mail server of the sender during inbound processing. The date the email is created during outbound processing. Globalized Yes Bidi supported Yes
Encrypted
This property indicates whether the body of a message was encrypted by the sender. If set to True, the message was encrypted.
Encrypted details Required No Default No default value Property type String Usage Setting the encrypted header value to True does not enable encryption. This property only notes whether the message has been encrypted for informational purposes. Bidi supported No
From
This property specifies the address that the email was sent from.
From details Required Yes Default No default value Property type String Usage Specifies the address that the email was sent from. Globalized Yes Bidi supported Yes
In reply to
The contents of this field identify which piece of previous correspondence is being answered with a new email message.
In reply to details Required No Default No default value Property type String Usage Identifies which piece of previous correspondence is being answered with a new email message. Bidi supported No
Keywords
This property specifies keywords or phrases contained in the email, which are separated by commas.
Keywords details Required No Default No default value Property type String Usage Keywords specified using this field are used during selective polling. Bidi supported No
Message Identifier (Message ID)
This property specifies the unique identifier (local-part address unit) that refers explicitly to a particular version of a particular message.
Message ID details Required No Default No default value Property type String Usage Each revision of an email message is assigned a new message ID. The uniqueness of the message ID is guaranteed by the host system that generates it. It is machine readable and does not include any meaningful syntax for users. Bidi supported No
References
The contents of this field identify other pieces of email correspondence referenced by the email.
References details Required No Default No default value Property type String Usage Identifies other pieces of email correspondence referenced by the email. Bidi supported No
Reply to
This property specifies the addresses where responses to the email are to be sent.
Reply to details Required No Default No default value Property type String Usage Specifies the addresses to which the response emails are to be sent. Bidi supported No
Resent - blind carbon copy (Resent-bcc)
This property specifies the blind carbon copy addresses for the email.
Resent-blind carbon copy details Required No Default No default value Property type String Usage This value is only supported during outbound communication. The addresses listed in this field are not included in copies of the message sent to the primary and secondary recipients. Some systems choose to include the text of the Bcc field only in the copy of the author, while some systems include these addresses to all those recipients listed in the Bcc field. Bidi supported No
Resent - carbon copy (Resent-cc)
This property specifies the email addresses for secondary recipients of the email.
Resent-carbon copy details Required No Default No default value Property type String Usage Specifies the email addresses for secondary recipients of the email. Bidi supported No
Resent - date
This property specifies the date that the email was forwarded.
Resent - date details Required No Default No default value Property type String Usage Specifies the date that the email was forwarded. Bidi supported No
Resent - from
This property specifies the address that the email was resent from.
Resent - from details Required No Default No default value Property type String Usage Specifies the address that the email was resent from. Bidi supported No
Resent message identifier (Resent-message-ID)
This property specifies the unique identifier (local-part address unit) that refers explicitly to a particular version of a particular message.
Resent-message-ID details Required No Default No default value Property type String Usage Each revised email message is assigned a new message ID. The uniqueness of the message ID is guaranteed by the host system that generates it. It is machine readable and does not include any meaningful syntax for users. Bidi supported No
Resent - reply to
This property specifies the addresses where responses to the email are to be sent.
Resent reply to details Required No Default No default value Property type String Usage Specifies the addresses where responses to the email are to be sent. Bidi supported No
Resent - sender
This property specifies the authenticated identity of the agent (person, system, or process) that is sending the email message.
Resent sender details Required No Default No default value Property type String Usage Specifies the authenticated identity of the agent (person, system, or process) that is sending the email message. Bidi supported No
Resent - to
This field contains the addresses for the primary recipients of the email.
Resent - to details Required No Default No default value Property type String Usage Contains the addresses for the primary recipients of the email. Bidi supported No
Sender
This property specifies the authenticated identity of the agent the (person, system, or process) that is sending the email message.
Sender details Required No Default No default value Property type String Usage Specifies the authenticated identity of the agent the (person, system, or process) that is sending the email message. Bidi supported No
Subject
This property contains a summary of what the email is about.
Subject details Required No Default No default value Property type String Usage Contains a summary of what the email is about. Globalized Yes Bidi supported Yes
To
This field contains the addresses for the primary recipients of the email.
To details Required No Default No default value Property type String Usage Contains the addresses for the primary recipients of the email. Globalized Yes Bidi supported Yes