| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- login : string : name of mail list (without @dominio.com)
- admin_email : string : list administrator mail address
- password : string : list administrator password
Output parameters:
- Returns a boolean with true value if the list is created correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_MAILLIST_LISTALREADYEXISTS
- ERROR_MAILLIST_NEWLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_MAILLISTS
Remarks:
- Creates a new mail list. The list administrator may be identified with the indicated email and password.
Examples:
.NET Java PHP
Input parameters:
- arrayListID : Array : array of mail list IDs.
Output parameters:
- Returns a Boolean true if the lists(s) were deleted correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_LISTNOTEXISTS
- ERROR_MAILLIST_DELLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Delete the mail list indicated in the array arrayListID.
Examples:
.NET Java PHP
Input parameters:
- listID : int : mail list ID for which the password is to be changed.
- newPassword : string : new password.
Output parameters:
- Returns a boolean with true "value" if the password has been changed.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_LISTNOTEXISTS
- ERROR_MAILLIST_MAILCHANGEPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Assigns a new password to the mail list indicated.
Examples:
.NET Java PHP
Input parameters:
- [list] : string : filter the search by list name.
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns a mailList
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_GETMAILLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- List the mail lists created by the domain accessing the web service.
- The results may be ordered by the following criteria:
- list_email : mail list name
- date : mail list creation date
Examples:
.NET Java PHP