Oracle® Beehive RESTful Web Services API Reference   Release 2 (2.0.1.7)   E16658-04

Overview

Members

Show inherited members

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

Examples

XML Example

(show inherited members)

JSON Example

(show inherited members)

XML Schema

<xs:complexType name="emailMessage">
    <xs:complexContent>
        <xs:extension base="tns:message">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="BCCReceivers" type="tns:participant"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="CCReceivers" type="tns:participant"/>
                <xs:element minOccurs="0" name="content" type="tns:emailMessageContent"/>
                <xs:element minOccurs="0" name="contentSnapshotId" type="xs:string"/>
                <xs:element minOccurs="0" name="deliveryInfo" type="tns:emailDeliveryInfo"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="flags" nillable="true" type="tns:messageFlag"/>
                <xs:element minOccurs="0" name="from" type="tns:participant"/>
                <xs:element name="messageIdentifier" type="xs:int"/>
                <xs:element name="repairAttemptCount" type="xs:int"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="replyTo" type="tns:participant"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="scanResults" nillable="true" type="tns:virusScanResult"/>
                <xs:element name="size" type="xs:long"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="toReceivers" type="tns:participant"/>
                <xs:element minOccurs="0" name="type" type="tns:emailMessageType"/>
                <xs:element name="UID" type="xs:long"/>
                <xs:element minOccurs="0" name="virusDefinitionId" type="xs:int"/>
                <xs:element minOccurs="0" name="virusScanDate" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="virusScanStatus" type="tns:virusScanStatus"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

Referenced By Resources

Referenced By Representaions

Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices