OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MessageMailboxSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Message to Mailbox mappings. A Message may appear in multiple Mailboxes. Each Mailbox may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupMessageMailboxMappings
Description

Tests if this user can perform lookups of message/mailbox mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeMailboxView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryMailboxView
Description

A complete view of the Message and Mailbox returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetMessageIdsByMailbox
Description

Gets the list of Message Ids associated with a Mailbox.

Parametersosid.id.IdmailboxId Id of a Mailbox
Returnosid.id.IdListlist of related message Ids
ErrorsNOT_FOUND mailboxId is not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMessagesByMailbox
Description

Gets the list of Messages associated with a Mailbox.

Parametersosid.id.IdmailboxId Id of a Mailbox
Returnosid.messaging.MessageListlist of related messages
ErrorsNOT_FOUND mailboxId is not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMessageIdsByMailboxes
Description

Gets the list of Message Ids corresponding to a list of Mailbox objects.

Parametersosid.id.IdListmailboxIdslist of mailbox Ids
Returnosid.id.IdListlist of message Ids
ErrorsNULL_ARGUMENT mailboxIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMessagesByMailboxes
Description

Gets the list of Messages corresponding to a list of Mailboxes.

Parametersosid.id.IdListmailboxIdslist of mailbox Ids
Returnosid.messaging.MessageListlist of messages
ErrorsNULL_ARGUMENT mailboxIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxIdsByMessage
Description

Gets the list of Mailbox Ids mapped to a Message.

Parametersosid.id.IdmessageId Id of a Message
Returnosid.id.IdListlist of mailbox Ids
ErrorsNOT_FOUND messageId is not found
NULL_ARGUMENT messageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxesByMessage
Description

Gets the list of Mailbox objects mapped to a Message.

Parametersosid.id.IdmessageId Id of a Message
Returnosid.messaging.MailboxListlist of mailboxes
ErrorsNOT_FOUND messageId is not found
NULL_ARGUMENT messageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.