N-central Help

Mailbox Get Deleted

Query if specified mailbox is deleted or query for all deleted mailboxes.

Input Parameters

Name Type Required Description
User Name String Yes User name used to authenticate to the Office 365 web service.
Password Password Yes Password used to authenticate to the Office 365 web service.
Mailbox Email Address String Yes Query if mailbox assigned to specified email address is deleted.

Output Parameters

Name Type Description
Deleted Mailboxes Array An array containing all deleted mailboxes.
Deleted Mailbox Count Number The number of rows returned in the deleted mailbox array.
Result String String Object execution error details.
Database String Name of database containing the deleted mailbox.
Alias String Deleted mailbox alias name.
GUID String GUID of deleted mailbox.
Name String Name of deleted mailbox.
Identity String Identity of deleted mailbox.
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
User Name String Yes Office365Admin@ABC.onmicrosoft.com
Password Password Yes <link to start parameter>
Get One or All mailboxes Boolean Yes
  • Choose ‘One’ to query if specific mailbox assigned to email address is deleted or not. Specify email address in Mailbox Email Address field.
  • Choose ‘All’ to query for all deleted mailboxes.

Mailbox Email Address field is not required with ‘All’ selected.

Email Address String No User1@ABC.onmicrosoft.com