Mailbox

Base Path: /actor/current/webmail/DIRECT/mailboxes

Version: 3.5.0

The collection of mailboxes that the user has access to. This usually includes the user’s personal mailbox, and occasionally may include one or more shared mailboxes. A user’s personal mailbox is identified by the email address.

There are three types of shared mailboxes. This version of the Communicate Webmail API only supports the DELEGATED type.

  • DELEGATED: A user delegates their mailbox to another user to manage.

  • ORGANIZATIONAL: A mailbox shared by multiple users, in an organization, to read and send email messages.

  • REPRESENTED: A representative is chosen to manage a patient's mailbox.

Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.

Methods

Retrieve mailbox list

GET /actor/current/webmail/DIRECT/mailboxes/

Lists the mailboxes that the user has access to, including any shared mailboxes, in the payload attribute.

Responses

application/json+fhir

200

Successfully retrieved the mailbox.

application/json+fhir

401

Your API key or access token has expired or is invalid.

Sample Request

curl -X GET "https://api.orionhealth.io/actor/current/webmail/DIRECT/mailboxes/" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'