OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.Mailbox
Implementsosid.OsidCatalog
Used Byosid.messaging.MailboxAdminSession
osid.messaging.MailboxList
osid.messaging.MailboxLookupSession
osid.messaging.MailboxNode
osid.messaging.MessageAdminSession
osid.messaging.MessageLookupSession
osid.messaging.MessageNotificationSession
osid.messaging.MessageQuerySession
osid.messaging.MessageSmartMailboxSession
osid.messaging.ReceiptAdminSession
show 2 more…
osid.messaging.ReceiptLookupSession
osid.messaging.ReceiptNotificationSession
Description

A mailbox defines a collection of messages.

MethodgetMailboxRecord
Description

Gets the record corresponding to the given Mailbox record Type.This method is used to retrieve an object implementing the requested record. The mailboxRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(mailboxRecordType) is true.

Parametersosid.type.TypemailboxRecordType the mailbox record type
Returnosid.messaging.records.MailboxRecord the mailbox record
ErrorsNULL_ARGUMENT mailboxRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(mailboxRecordType) is false
Compliancemandatory This method must be implemented.