Get Quota

This Email tool returns the implementation specific quota for the given folder, root and resource.

This tool is currently only supported by IMAP. On Notes or Exchange, this tool will fail and will create an appropriate entry in the Application Event Log.

Note: The handler author must have intimate knowledge of the mail system in use in order to effectively use this tool, as all parameters can change from one application to the next. Usage and limit, as well as the number of roots and/or resources per root can also vary from one mail system to another.

Inputs

Folder ID

The unique identifier for the folder being queried. This ID is retrieved with an Incoming Mail initiator, or the Open Folder tool.

Root Name

A string representing the root name (e.g., "user/troyt").

Resource Name

A string representing the resource name (e.g., "storage").

Timeout

The number of seconds the tool will wait for a return value.

Outputs

Limit

Integer representing the limit. This number could represent a number of messages or kilobytes, or whatever else the system uses to determine its limits.

Usage

Integer representing the current usage. This number could represent a number of messages or kilobytes, or whatever else the system uses to determine usage parameters.

Result

The results of the operation.

See Email Tool Result Codes for more information.

Exit Paths

Success

This path is taken if the quota is successfully retrieved.

Failure

This path is taken if the operation fails. The most common reason for failure is a lack of quota support by the mail system.