Skip to main content

createRestoreQuarantineExchangeItemTask

This method creates a new task to restore items from the quarantine for Exchange Servers.

Important

This method has been updated to version 1.1. For information applicable to version 1.0, refer to this section.

Parameters

Parameter

Type

Optional

Description

quarantineItemsIds

Array

No

The list of IDs for the quarantined items. You can restore maximum 100 items once.

username

String

No

The username of an Microsoft Exchange user. The username must include the domain name.

password

String

No

The password of an Exchange user

email

String

Yes

The email address of the Exchange user. This parameter is necessary when the email address is different from the username.

ewsUrl

String

Yes

The Exchange Web Services URL .The EWS URL is necessary when the Exchange Autodiscovery does not work.

Return value

The password of an Exchange user. Not Optional and Type String.

Example

Request:

{
       "params": {
           "quarantineItemsIds": [
               "63896b87b7894d0f367b23c6",
               "65896b87b7894d0f367b23c6"
           ],
           "username": "user@domain",
           "password": "userPassword"
       },
       "jsonrpc": "2.0",
       "method": "createRestoreQuarantineExchangeItemTask",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }

Response:

{
      "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": [
          "652feab6b9684f3ba80685d5",
          "652feab6b9684f3ba80685d5"
      ]
}

Version 1.0

Parameters

Parameter

Type

Optional

Description

quarantineItemsIds

Array

No

The list of IDs for the quarantined items. You can restore maximum 100 items once.

username

String

No

The username of an Microsoft Exchange user. The username must include the domain name.

password

String

No

The password of an Exchange user

email

String

Yes

The email address of the Exchange user. This parameter is necessary when the email address is different from the username.

ewsUrl

String

Yes

The Exchange Web Services URL .The EWS URL is necessary when the Exchange Autodiscovery does not work.

Return value

This method returns a Boolean which is True when the task was successfully created

Example

Request:

  {
       "params": {
           "quarantineItemsIds": [
               "63896b87b7894d0f367b23c6",
               "65896b87b7894d0f367b23c6"
           ],
           "username": "user@domain",
           "password": "userPassword"
       },
       "jsonrpc": "2.0",
       "method": "createRestoreQuarantineExchangeItemTask",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }

Response:

  {
      "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": True
  }
In this section: