| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- name : string : name of mailbox to create (name@domain.com)
- password : string : mailbox password
Output parameters:
- Returns a boolean with true value if the mailbox has been correctly created.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_ADDMAILBOX
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_MAIL_MAILBOXNAMEEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MAILBOXES
Remarks:
- Create a mailbox with the selected name and password
Examples:
.NET Java PHP
Input parameters:
- mailboxId : int : mailbox ID
- newPassword : string : new mailbox password
Output parameters:
- returns a Boolean with true value if the password has been changed.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_MAILBOXNOTEXISTS
- ERROR_MAIL_CHANGEMAILBOXPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MAILBOXES
Remarks:
- Modify the password of an already existing mailbox.
Examples:
.NET Java PHP
Input parameters:
- arrayMailboxId : Array : array of mailbox ID's
Output parameters:
- Returns a boolean with true value if the mailbox(es) have been deleted
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_MAIL_MAILBOXNOTEXISTS
- ERROR_MAIL_REMOVEMAILBOX
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Deletes all of the associated mailboxes to the IDs indicated in the arrayMailboxId.
Examples:
.NET Java PHP
Input parameters:
- [searchBox] : string : filter for the search by mailbox name
- [orderArray] : OrderArray : OrderArray structure to order the results
Output parameters:
- Returns an ArrayOfMailBoxInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_LISTMAILBOXES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- List mailboxes of invoking domain.
- The parameter functions can be the following:
- name : name of mailbox
- creationdate : creation date
Examples:
.NET Java PHP