Searching for Exchange Items in Mailboxes

In this article

    You can search for items in the specified mailbox.

    Request

    POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/action

    Request Headers

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

    Request Parameters

    The request URL must contain the following parameters:

    Parameter

    Type

    Description

    restoreSessionId

    string

    Specifies the identification number of the restore session. Can be obtained as described in Getting Restore Sessions.

    mailboxId

    string

    Specifies the identification number of the mailbox. Can be obtained as described in Getting Mailboxes.

    Request Body

    The request body must contain the search action property:

    Property

    Type

    Description

    query

    string

    Specifies query parameters used to search for items in the mailbox. For more information, see Query Parameters.

    Query Parameters

    The following table lists examples of parameters that you can use in the query string to search for items in a mailbox.

    For the complete list of supported query parameters, see Appendix A. Item Search Parameters.

    Parameter

    Type

    Description

    from

    string

    Specifies the name of the sender.

    Query example: from: admin.

    to

    string

    Specifies the name of the recipient.

    Query example: to: user.

    hasattachments

    string

    Defines whether the post has attachments.

    Query example: hasattachments: true.

    body

    string

    Specifies the part of the post message body.

    Query example: body: information.

    subject

    string

    Specifies the post subject or part of the post subject.

    Query example: subject: announcement.

    Request Example

    Request:

    POST https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/Organization/Mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

      "search":{

         "query": "from:user_X to:user_Y"

      }

    }

     

    Searching for Exchange Items in Mailboxes Note

    If a value for a query parameter contains a space, provide the value in the quotation marks (""). Use the backslash (\) symbol as an escape character before these quotation marks. For example: "query": "from: \"user X\" to: \"user Y\"".

    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

    Property

    Type

    Description

    offset

    integer

    Shows the offset value.

    limit

    integer

    Shows the limit of records to be displayed on the page.

    results

    Results Object

    Contains the Results object.

    Results Object

    Property

    Type

    Description

    from

    string

    Shows the sender.

    cc

    string

    Shows the recipients of the copy.

    bcc

    string

    Shows the recipients of the concealed copy.

    to

    string

    Shows the recipients.

    sent

    string

    Shows the date and time when the message was sent.

    received

    string

    Shows the date and time when the message was received.

    reminder

    boolean

    Shows if the remainder is set.

    subject

    string

    Shows the subject.

    itemClass

    string

    Shows the item class.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    200 OK

     

    Response Body:

    {

      "offset": 0,

      "limit": 30,

      "results": [   {

         "from": "John Doe in Teams",

         "cc": "",

         "bcc": "",

         "to": "Jane Doe",

         "sent": "2019-10-08T15:13:16Z",

         "received": "2019-10-08T15:13:21.7138592Z",

         "reminder": false,

         "subject": "John Doe",

         "itemClass": "IPM.Note",

         "_links":       {

            "self": {"href": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA"},

            "parent": {"href": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/folders/AAAAAPI-ZgUzFo1OutsrlqscF3YBAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAA"},

            "mailbox": {"href": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d"}

         },

         "_actions":       {

            "restoretoOriginallocation":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            },

            "restoreTo":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            },

            "exporttoPst":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            },

            "savetoMsg":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            },

            "sendtoDefaultaddress":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            },

            "sendtoDifferentaddress":          {

               "uri": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/items/AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA/action",

               "method": "POST"

            }

         },

         "id": "AAAAAPI-ZgUzFo1OutsrlqscF3YHAPoX1QVx9BZHraHZM4xpWtgAARuR8joAAPoX1QVx9BZHraHZM4xpWtgAARuSD4wAAA"

      }],

      "_links": {"self": {"href": "https://delta.tech.local:4443/v5/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/Organization/Mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/action?offset=0&limit=30"}}

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.