Overview

Represents a unit of conversation in an e-mail exchange. It includes the sender and the list of receivers. Message content is stored in the content attributes that may represent a hierarchy of message parts (attachments)

Members

Show inherited members

Projections
Name Type Required Description

BCCReceivers

participant[]
"Blind Carbon Copied" recipients. BCC recipients are only visible to the sender of the message.

CCReceivers

participant[]
"Carbon Copied" recipients. CC recipients are considered secondary recipients of an email message.

UID

long
The IMAP UID for this message

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

body

content
Body of the message. The body typically contains a free-form payload but may potentially include an hierarchy of parts.

bonds

bond[]
List of artifact bonds

changeStatus

changeStatus
The change status of the artifact

collabId

beeId
CollabId of the snapshot

content

emailMessageContent
The top level content of the email message.

contentSnapshotId

string
Sets the content snapshotId

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

deliveredTime

dateTime
Time when the message is delivered to the INBOX of this intended recipient

deliveryInfo

emailDeliveryInfo
Delivery status of a message. This member describes the state of the message delivery and individual delivery status associated with each recipient.

flags

messageFlag[]
Message flags associated with the message

from

participant
The envelope sender of the message. This may be different from the regular sender.

messageIdentifier

int
The integer identifier of this message for zimbra client.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

properties

collabProperties
The properties of the artifact that are shared among all the actors

receivers

anyType[]
Intended collection of recipients of this message.

references

artifact[]
This member is deprecated and no longer in use.

repairAttemptCount

int
Sets the repair attempt count

replyTo

participant[]
The list of Reply-To addresses. The Reply-To addresses if present are to be used as targets to receive a reply message.

scanResults

virusScanResult[]

sender

actor
Sender of the message.

size

long
Sets the size of the message

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

toReceivers

participant[]
Receivers on the "TO" list. "TO" list of recipients are considered the primary recipients of an email message.

type

emailMessageType
The type of the email message indicating the origin. Type can be EMAIL, VOICEMAIL, FAX or NOTIFICATION.

userCreatedOn

dateTime
The user creation date (if created offline)

userModifiedOn

dateTime
The user last modified date (if modified offline)

viewer

actor
The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties
The viewer properties of the artifact that are private to loading actor

virusDefinitionId

int
Sets the virus definition id

virusScanDate

dateTime
Sets the virus scan date

virusScanStatus

virusScanStatus
Sets the virus scan status

Hierarchy

Inherits From

Examples

Below are examples in XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:emailMessage xsi:type="obh:emailMessage" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <BCCReceivers>your_participant_0</BCCReceivers>
        <BCCReceivers>your_participant_1</BCCReceivers>
        <BCCReceivers>your_participant_2</BCCReceivers>
         <CCReceivers>your_participant_0</CCReceivers>
        <CCReceivers>your_participant_1</CCReceivers>
        <CCReceivers>your_participant_2</CCReceivers>
         <UID>your_long_0</UID>
         <attachedMarkers>your_marker_0</attachedMarkers>
        <attachedMarkers>your_marker_1</attachedMarkers>
        <attachedMarkers>your_marker_2</attachedMarkers>
         <attachedReminders>your_reminder_0</attachedReminders>
        <attachedReminders>your_reminder_1</attachedReminders>
        <attachedReminders>your_reminder_2</attachedReminders>
         <attachedSubscriptions>your_subscription_0</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_1</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_2</attachedSubscriptions>
         <body>your_content_0</body>
         <bonds>your_bond_0</bonds>
        <bonds>your_bond_1</bonds>
        <bonds>your_bond_2</bonds>
         <changeStatus>your_changeStatus_0</changeStatus>
         <collabId>your_beeId_0</collabId>
         <content>your_emailMessageContent_0</content>
         <contentSnapshotId>your_string_0</contentSnapshotId>
         <createdOn>your_dateTime_0</createdOn>
         <creator>your_actor_0</creator>
         <deleted>your_boolean_0</deleted>
         <deliveredTime>your_dateTime_0</deliveredTime>
         <deliveryInfo>your_emailDeliveryInfo_0</deliveryInfo>
         <flags>your_messageFlag_0</flags>
        <flags>your_messageFlag_1</flags>
        <flags>your_messageFlag_2</flags>
         <from>your_participant_0</from>
         <messageIdentifier>your_int_0</messageIdentifier>
         <modifiedBy>your_actor_0</modifiedBy>
         <modifiedOn>your_dateTime_0</modifiedOn>
         <name>your_string_0</name>
         <parent>your_entity_0</parent>
         <properties>your_collabProperties_0</properties>
         <receivers>your_anyType_0</receivers>
        <receivers>your_anyType_1</receivers>
        <receivers>your_anyType_2</receivers>
         <references>your_artifact_0</references>
        <references>your_artifact_1</references>
        <references>your_artifact_2</references>
         <repairAttemptCount>your_int_0</repairAttemptCount>
         <replyTo>your_participant_0</replyTo>
        <replyTo>your_participant_1</replyTo>
        <replyTo>your_participant_2</replyTo>
         <scanResults>your_virusScanResult_0</scanResults>
        <scanResults>your_virusScanResult_1</scanResults>
        <scanResults>your_virusScanResult_2</scanResults>
         <sender>your_actor_0</sender>
         <size>your_long_0</size>
         <snapshotId>your_string_0</snapshotId>
         <toReceivers>your_participant_0</toReceivers>
        <toReceivers>your_participant_1</toReceivers>
        <toReceivers>your_participant_2</toReceivers>
         <type>your_emailMessageType_0</type>
         <userCreatedOn>your_dateTime_0</userCreatedOn>
         <userModifiedOn>your_dateTime_0</userModifiedOn>
         <viewer>your_actor_0</viewer>
         <viewerProperties>your_collabProperties_0</viewerProperties>
         <virusDefinitionId>your_int_0</virusDefinitionId>
         <virusScanDate>your_dateTime_0</virusScanDate>
         <virusScanStatus>your_virusScanStatus_0</virusScanStatus>
 </obh:emailMessage>

Referenced By Representaions

Not Referenced Directly by Representations