| 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:
- login : string : nombre de la lista de correo (sin @dominio.com)
- admin_email : string : dirección de correo del administrador de la lista
- password : string : contraseña del administrador de la lista
Parámetros de salida:
- Devuelve un boolean a true si la lista se ha creado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_LIMIT_RESOURCES
- ERROR_MAILLIST_LISTALREADYEXISTS
- ERROR_MAILLIST_NEWLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_MAILLISTS
Funcionamiento:
- Crea una nueva lista de correo. El administrador de la lista podrá será identificado con el email y contraseña indicados.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- arrayListID : Array : array de identificadores de listas de correo
Parámetros de salida:
- Devuelve un boolean a true si la lista(s) se ha eliminado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_LISTNOTEXISTS
- ERROR_MAILLIST_DELLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Elimina las listas de correo indicadas en el array arrayListID.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- listID : int : identificador de la lista de correo a la que se le quiere cambiar la contraseña
- newPassword : string : nueva contraseña
Parámetros de salida:
- Devuelve un boolean a true si la contraseña se ha cambiado
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_LISTNOTEXISTS
- ERROR_MAILLIST_MAILCHANGEPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Asigna una nueva contraseña a la lista de correo indicada.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [list] : string : filtra la búsqueda por nombre de lista
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un mailList
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_MAILLIST_GETMAILLIST
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: ninguno
Funcionamiento:
- Lista las listas de correo creadas para el dominio que invoca al servicio web.
- El resultado puede ser ordenado por los siguientes criterios:
- list_email : nombre de la lista de correo
- date : fecha de creación de la lista de correo
Ejemplos:
.NET Java PHP