N-central Help

Get Mailbox Folder Statistics

Get statistics for specified Mailbox folder or all mailbox folders.

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.

Email Address

String

Yes

Email address of user for which to retrieve statistics.

Folder

String

Yes

Name of folder for which to retrieve statistics.

Output Parameters

Name Type Description

Folder Count

Number

Number of rows output into Array.

Run Space ID

String

GUID for mailbox folder.

Date

Date

Date the mailbox was created.

Name

String

Name of mailbox folder.

Folder Path

String

Path of mailbox folder.

Folder ID

String

ID of mailbox folder.

Folder Type

String

Type of mailbox folder.

Calendar, Inbox, Notes, Tasks

Items In Folder

Number

Number of items within mailbox folder.

Deleted Items In Folder

Number

Number of deleted items within mailbox folder.

Folder Size

Number

Size of mailbox folder in bytes.

Items in Folder and Subfolders

Number

Total number items within mailbox folder including subfolder.

Deleted Items in Folder and Subfolders

Number

Total number of deleted items within mailbox folder including subfolder.

Oldest Item Received Date

Date

Oldest received item with the mailbox folder.

Newest Item Receive Date

Date

Newest received item with the mailbox folder.

Folder and Subfolder Size

Date

Size of the folder including subfolders in bytes.

Oldest Deleted Item Received Date

Date

Oldest deleted item with the mailbox folder.

Newest Deleted Item Received Date

Date

Newest deleted item with the mailbox folder.

Oldest Item Last Modified Date

Date

Oldest modified item with the mailbox folder.

Newest Item Last Modified Date

Date

Newest modified item with the mailbox folder.

Oldest Deleted Item Last Modified Date

Date

The modified date of the oldest deleted item within the mailbox folder.

Newest Deleted Item Last Modified Date

Date

The modified date of the newest deleted item within the mailbox folder.

Managed Folder

String

Identifies whether or not the folder has the managed attribute enabled.

Top Subject

String

Mailbox item subject that recurs most often.

Top Subject Size

Number

The size of the mailbox items that recurs most often.

Top Subject Count

Number

The number of mailbox items that recurs most often.

Top Subject Class

String

The class of the mailbox items that recurs most often.

Top Subject Path

String

The path of the mailbox items that recurs most often.

Top Subject Received Time

String

The latest received item of the mailbox items that recurs most often.

Top Subject From

String

The from address of the mailbox items that recurs most often.

Top Client Info for Subject

String

The Client information of the mailbox items that recurs most often.

Top Client Info Count for Subject

String

The client information with count for mailbox items that recurs most often.

Identity

String

Unique identifier of the mailbox folder.

Is Valid

String

Displays if the mailbox folder is valid or contains errors.

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>

Email Address

String

Yes

User1@ABC.onmicrosoft.com

Folder

String

Yes

  • Inbox
  • Inbox\sub-folder

All

Checkbox

No

Optionally, you can select to retrieve statistics for all folders. If this option is selected, the Folder field is not required.