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

This session provides methods for retrieving Mailbox objects. The Mailbox represents a collection messages.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Mailboxes it can access, without breaking execution. However, an administrative application may require all Mailbox elements to be available.

Mailboxes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Mailbox.

MethodcanLookupMailboxes
Description

Tests if this user can perform Mailbox lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are 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 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.
MethodgetMailbox
Description

Gets the Mailbox specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Mailbox may have a different Id than requested, such as the case where a duplicate Id was assigned to a Mailbox and retained for compatibility.

Parametersosid.id.IdmailboxId Id of the Mailbox
Returnosid.messaging.Mailboxthe mailbox
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetMailboxesByIds
Description

Gets a MailboxLidt corresponding to the given IdList. In plenary mode, the returned list contains all of the mailboxes specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible mailboxes may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListmailboxIdsthe list of Ids to retrieve
Returnosid.messaging.MailboxListthe returned Mailbox list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT mailboxIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxesByGenusType
Description

Gets a Mailbox corresponding to the given mailbox genus Type which does not include mailboxes of types derived from the specified Type. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.

Parametersosid.type.TypemailboxGenusTypea mailbox genus type
Returnosid.messaging.MailboxListthe returned Mailbox list
ErrorsNULL_ARGUMENT mailboxGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxesByParentGenusType
Description

Gets a MailboxList corresponding to the given psocess genus Type and include any additional mailboxes with genus types derived from the specified Type. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.

Parametersosid.type.TypemailboxGenusTypea mailbox genus type
Returnosid.messaging.MailboxListthe returned Mailbox list
ErrorsNULL_ARGUMENT mailboxGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxesByRecordType
Description

Gets a MailboxList containing the given mailbox record Type. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.

Parametersosid.type.TypemailboxRecordTypea mailbox record type
Returnosid.messaging.MailboxListthe returned Mailbox list
ErrorsNULL_ARGUMENT mailboxRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxesByProvider
Description

Gets a MailboxList for the given provider. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.messaging.MailboxListthe returned Mailbox list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxes
Description

Gets all Mailboxes. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.

Returnosid.messaging.MailboxLista list of mailboxes
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.