Getting Mailbox Items

In this article

    You can get a resource representation of a backed-up mailbox item with the specified ID.

    Request

    GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    restoreSessionId

    string

    Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

    mailboxId

    string

    Specifies the identification number of the mailbox. For more information on how to get this parameter, see Getting Mailboxes.

    itemId

    string

    Specifies the identification number of the mailbox item. For more information on how to get this parameter, see Getting Mailbox Items.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    Exchange organizations use Items to represent individual email messages, appointments, journals and other items in a mailbox. The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource has different properties depending on the item type.

    Task

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Task item has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox item.

    itemClass

    string

    Specifies the class of the organization's backed-up mailbox item.

    status

    string

    Specifies the task status:

    • NotStarted
    • InProgress
    • Completed
    • WaitingOnsomeoneelse
    • Deferred

    percentComplete

    integer

    Specifies the task progress.

    startDate

    UTC

    Specifies the date and time when the task was started.

    dueDate

    UTC

    Specifies the date and time when the task must be completed.

    owner

    string

    Specifies the owner of the task.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Journal

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Journal item has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox item.

    itemClass

    string

    Specifies the class of the organization's backed-up mailbox item.

    subject

    string

    Specifies the task status:

    • NotStarted
    • InProgress
    • Completed
    • WaitingOnsomeoneelse
    • Deferred

    startDate

    UTC

    Specifies the date and time when the task was started.

    duration

    UTC

    Specifies the duration of the journal entry in hours.

    entryType

    string

    Specifies the journal entry type.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Note

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Note item has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox item.

    itemClass

    string

    Specifies the class of the organization's backed-up mailbox item.

    name

    string

    Specifies the name of the note.

    date

    string

    Specifies the date when the note was created.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Message

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Message item has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox item.

    itemClass

    string

    Specifies the class of the organization's backed-up mailbox item.

    from

    string

    Specifies the sender mailbox email address.

    to

    string

    Specifies the recipient mailbox email address.

    cc

    string

    Specifies the recipient email address in carbon copy.

    bcc

    string

    Specifies the recipient address in blind carbon copy.

    subject

    string

    Specifies the subject of the email message.

    sent

    UTC

    Specifies the date and time when the message was sent.

    received

    UTC

    Specifies the date and time when the message was received.

    reminder

    boolean

    If set to true, indicates that the message was sent with the reminder.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Appointment

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Appointment item has the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox item.

    itemClass

    string

    Specifies the class of the organization's backed-up mailbox item.

    startTime

    UTC

    Specifies the when the appointment starts.

    endTime

    UTC

    Specifies when the appointment finishes.

    organizer

    string

    Specifies the appointment's organizer.

    location

    string

    Specifies the location where the appointment is held.

    attendees

    string[]

    Specifies the appointment's attendees.

    recurring

    boolean

    If set to true, specifies that the appointment is recurring.

    attachments

    attachment

    Specifies attachment items for the appointment item.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    attachments

    The appointment attachment item has the following properties:

    Property

    Type

    Description

    name

    string

    Specifies a name of an attachment item.

    size

    string

    Specifies a size of an attachment item.

    Contact

    The /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Items/{itemId} resource for the Contact item has the following properties:

    Property

    Type

    Description

    fullName

    string

    Specifies the name of the name of the contact.

    mobile

    string

    Specifies the mobile phone number of the contact.

    homePhone

    string

    Specifies the home phone number of the contact.

    fax

    string

    Specifies the fax number of the contact.

    address

    string

    Specifies the contact address.

    company

    string

    Specifies the company of the contact.

    jobTitle

    string[]

    Specifies the contact's job title.

    email

    string

    Specifies the contact's email.

    businessPhone

    string

    Specifies the business phone number of the contact.

    webPage

    string

    Specifies the webpage of the contact.

    Examples

    Example 1

    The following request returns a resource representation of the organization's mailbox item with the ID AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==.

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/479ae6aa-610b-4652-8966-5db06021903c/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

         "startTime": "2022-10-09T21:00:00Z",

         "endTime": "2022-10-10T21:00:00Z",

         "organizer": "jsmith",

         "location": "United States",

         "attendees": "",

         "recurring": false,

         "itemClass": "IPM.Appointment",

         "_links": {

           "self": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA=="

           },

           "parent": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAA=="

           },

           "mailbox": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

           }

         },

         "_actions": {

           "restoretoOriginallocation": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           },

           "restoreTo": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           },

           "exporttoPst": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           },

           "savetoMsg": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           },

           "sendtoDefaultaddress": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           },

           "sendtoDifferentaddress": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/3da69c6c-bb12-4bed-9c4d-7276cb9074bf/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items/AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA==/action",

             "method": "POST"

           }

         },

         "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgHAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUcAAEJD8-NHTuNAoFrJGmIzcMoAAE-h_u0AAA=="

           }