Package org.osid.messaging

package org.osid.messaging

The Open Service Interface Definitions for the org.osid.messaging service.

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.

Copyright © 2002-2004, 2008 Massachusetts Institute of Technology.

Copyright © 2011 Ingeenscus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.messaging.batch	The Open Service Interface Definitions for the org.osid.messaging.batch service.
org.osid.messaging.records

Interfaces

Class	Description
Mailbox	A mailbox defines a collection of messages.
MailboxAdminSession	This session creates, updates, and deletes Mailboxes .
MailboxForm	This is the form for creating and updating mailboxes.
MailboxHierarchyDesignSession	This session defines methods for managing a hierarchy of Mailbox objects.
MailboxHierarchySession	This session defines methods for traversing a hierarchy of Mailbox objects.
MailboxList	Like all OsidLists , MailboxList provides a means for accessing Mailbox elements sequentially either one at a time or many at a time.
MailboxLookupSession	This session provides methods for retrieving Mailbox objects.
MailboxNode	This interface is a container for a partial hierarchy retrieval.
MailboxNodeList	Like all OsidLists , MailboxNodeList provides a means for accessing MailboxNode elements sequentially either one at a time or many at a time.
MailboxNotificationSession	This session defines methods to receive notifications on adds/changes to Mailbox objects.
MailboxQuery	This is the query for searching mailboxes.
MailboxQueryInspector	This is the query inspector for examining mailbox queries.
MailboxQuerySession	This session provides methods for searching among Mailbox objects.
MailboxReceiver	The mailbox receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Mailbox objects.
MailboxSearch	The interface for governing mailbox searches.
MailboxSearchOrder	An interface for specifying the ordering of search results.
MailboxSearchResults	This interface provides a means to capture results of a search.
MailboxSearchSession	This session provides methods for searching among Mailbox objects.
Message	A Message .
MessageAdminSession	This session creates, updates, and deletes Messages .
MessageForm	This is the form for creating and updating Messages .
MessageList	Like all OsidLists , MessageList provides a means for accessing Message elements sequentially either one at a time or many at a time.
MessageLookupSession	This session defines methods for retrieving messages.
MessageMailboxAssignmentSession	This session provides methods to re-assign Messages to Mailboxes .
MessageMailboxSession	This session provides methods to retrieve Message to Mailbox mappings.
MessageNotificationSession	This session defines methods to receive notifications on adds/changes to Message objects in this Mailbox .
MessageQuery	This is the query for searching messages.
MessageQueryInspector	This is the query inspector for examining message queries.
MessageQuerySession	This session provides methods for searching among Message objects.
MessageReceiver	The message receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Message objects.
MessageSearch	The search interface for governing message searches.
MessageSearchOrder	An interface for specifying the ordering of search results.
MessageSearchResults	This interface provides a means to capture results of a search.
MessageSearchSession	This session provides methods for searching among Message objects.
MessageSmartMailboxSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MessagingManager	The message manager provides access to message lookup and creation sessions and provides interoperability tests for various aspects of this service.
MessagingProfile	The message profile describes interoperability among message services.
MessagingProxyManager	The message manager provides access to message lookup and creation session and provides interoperability tests for various aspects of this service.
MessagingSession	This session provides a means to send messages.
Receipt	A Message receipt is generated when a message is received by a receiving agent.
ReceiptAdminSession	This session updates Receipts .
ReceiptForm	This is the form for creating and updating Receipts .
ReceiptList	Like all OsidLists , ReceiptList provides a means for accessing Message elements sequentially either one at a time or many at a time.
ReceiptLookupSession	This session defines methods for retrieving receipts to messages.
ReceiptNotificationSession	This session defines methods to receive notifications on new and changed Receipts in this Mailbox .
ReceiptQuery	This is the query for searching message receipts.
ReceiptQueryInspector	This is the query inspector for examining receipt queries.
ReceiptReceiver	The receipt receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Receipt objects.
ReceiptSearchOrder	An interface for specifying the ordering of search results.