| Referencia de la API 2.2 de Cube Panel: Acceso a los servicios web de Cube Panel | ||
|---|---|---|
| Anterior | Capítulo 2. Referencia de la API | Siguiente |
Parámetros de entrada:
- name : string : Nombre del buzón a crear (nombre@dominio.com)
- password : string : Contraseña del buzón
Parámetros de salida:
- Devuelve un boolean a true si el buzón se ha creado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_ADDMAILBOX
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_MAIL_MAILBOXNAMEEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_MAILBOXES
Funcionamiento:
- Crea un buzón para con el nombre y contraseña indicados
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- mailboxId : int : Identificador del buzón
- newPassword : string : Nueva contraseña a asignar al buzón
Parámetros de salida:
- Devuelve un boolean a true si el password se ha cambiado
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_MAILBOXNOTEXISTS
- ERROR_MAIL_CHANGEMAILBOXPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_MAILBOXES
Funcionamiento:
- Modifica la contraseña de un buzón ya existente
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- arrayMailboxId : Array : array de identificadores de buzones
Parámetros de salida:
- Devuelve un boolean a true si se ha eliminado el buzón(es)
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_MAIL_MAILBOXNOTEXISTS
- ERROR_MAIL_REMOVEMAILBOX
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Elimina todos los buzones asociados a los identificadores indicados en el array arrayMailboxId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [searchBox] : string : filtrado para la busqueda por nombre de buzón
- [orderArray] : OrderArray : estructura OrderArray para la ordenación de los resultados
Parámetros de salida:
- Devuelve un ArrayOfMailBoxInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAIL_LISTMAILBOXES
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Lista los buzones del dominio que invoca la función.
- Los parámetros de ordenación pueden ser los siguientes:
- name : nombre de buzón
- creationdate : fecha de creación
Ejemplos:
.NET Java PHP