OSID — Messaging Entities

Messaging

The Messaging OSID sends and receives messages.

Messages

Messages are structures that include a sender, recipients, and a timestamp. A Message is created using a MessageAdminSession. The text of the Message is displayable as text and may include a specific structure defined using a MessageRecord.

Until a Message is sent, it is stored and may be edited as a draft. Once a Message is sent, the Message includes the sending Agent as well as the addressed recipients represented by a list of Resources. A Message is received by a receiving Agent which generally is related to one of the recipients.

Sending Messages

Once a Message has been created, it may be sent from the authenticated Agent to a specified list of recipients using the MessagingSession. The same Message may be sent to additional recipients by returning to the MessagingSession and using the same Message Id.

Receiving Messages

The MessageLookupSession can be used to retrieve incoming Messages. From the point of view of the receiving Agent, Messages from the MessageLookupSession indicate a foreign Agent as the sender and at least one recipient related to the authenticated Agent which generally, but may not always, be the receiving Agent.

The same interfaces are used to receive Messages as well as examine created Messages. The Messages seen in the MessageLookupSession vary depending on the point of view implied by the Mailbox catalog.

Message Receipts

Once a Message has been received by a receiving Agent, a Receipt is be generated to include the time receive and the receiving Agent. A Receipt can be used to store additional data related to the received Message.

Receipts may only be visible to the receiving Agent or a Messaging OSID Provider may authorize Receipts to be visible to the sender or other parties.

Mailbox Catalogs

Messages are cataloged using Mailboxes. Mailboxes be may used to store messages for different users, and may also be used to provide message folders for each user. Like all OsidCatalogs, a Mailbox may belong to a federated hierarchy to provide fedeated and filtering views among multiple mailboxes.

On Resource & Agents

The Agent is the identity of an authenticated actor while the Resource represents a real-world entity such as a person or organization. The mapping between Agents and Resources is managed by the Resource OSID. In the Messaging OSID, an Agent sends a Message to a Resource, However, aspects of the service also examine messages from the recipient's point of view where the sender appears as an object instead of an actor. The Messaging OSID references both a sender as a Resource and asending agent as an Agent. The Messaging OSID Provider orchestrates the mapping between Agents and Resources as a messaging application would access a local address book for looking up full names corresponding to incoming email addresses.

Sub Packages

The Messaging OSID contains a Messaging Batch OSID for managing Messages and Mailboxes in bulk.

Message

Osid Object

A Message.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Many	Description
`subjectLine`	displaytext		the subject
`text`	displaytext		the text
`isSent`	boolean		`true` if this message has been sent, `false` otherwise
`sentTime`	datetime		the time
`senderId`	id		the sender agent `Id`
`sender`	Resource		the sender
`sendingAgentId`	id		the sending agent `Id`
`sendingAgent`	Agent		the sending agent
`receivedTime`	datetime		the time
`recipientIds`	id	⋆	the recipient resource `Ids`
`recipients`	Resource	⋆	the recpient resources
`isRecipient`	boolean		`true` if this agent is a recipient, `false` otherwise
`receiptId`	id		the receipt `Id`
`receipt`	Receipt		the receipt

Receipt

Osid Object Subjugateable

A Message receipt is generated when a message is received by a receiving agent.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Description
`messageId`	id	the message `Id`
`message`	Message	the message
`receivedTime`	datetime	the time
`receivingAgentId`	id	the receiving agent `Id`
`receivingAgent`	Agent	the receiving agent
`recipientId`	id	the recipient `Id`
`recipient`	Resource	the recipient

Mailbox

Osid Catalog

A mailbox defines a collection of messages.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license