Documentación de la API
A continuación se muestra la documentación completa de la API de dinahosting y la lista de comandos disponibles. Cada comando incluye una descripción detallada de su funcionamiento, los parámetros que admite y los posibles tipos de respuesta.
Al seleccionar un comando, se mostrará también un generador de peticiones y un simulador de respuesta, que te permitirán probar cómo invocar la API y visualizar la respuesta real que devuelve el servidor.
Cargando comando...
Hosting_Import_ApplyForEmailAccountPop
Apply for an email import through POP to your hosting.
1.0 -> 1.1: Removed unused parameter.
1.1 -> 1.2: Delegated all operations to async ticket execution (incl. mail account creation).
Please note this command has a delayed execution and it'll return SUCCESS_PENDING code on success and a ticket id (integer) on the data field.
Version: 1.2
Special errors:
OBJECT_EXISTS If destination email account cannot be created because already exists.
Parameters
- hosting (string): Destination hosting name. The parameter is required.
- originEmailAddress (string): Origin full email address. The parameter is required. Parameter value must be a valid email address.
- originPassword (string): Origin user password. The parameter is required. Parameter length must be between 1 and 255 characters.
- originServer (string): Origin server hostname or IP with (or without) port. Default port: 110. The parameter is required.
- create (bool): Create destination account. The parameter is optional. Parameter value must be a boolean ( true or false ).
- destinationUser (string): Destination new email account alias (without hostname). If it's empty, we'll use originEmailAddress account alias as the destination name. The parameter is optional. Parameter length must be between 1 and 40 characters. It can contain only alphanumeric, underscore, dot or dash chars. String must start with a alphanumeric char.
- destinationPassword (string): Only used if create is true. Destination user password. If it's empty, we'll use originPassword as the destination password on creation. The parameter is optional. Parameter length must be between 0 and 16 characters.
- destinationFolder (string): Destination folder outside inbox. The parameter is optional. Parameter length must be between 0 and 255 characters.
- notificationMail (string): Email address for a notification. The parameter is optional. Parameter value must be a valid email address.
Tipo de datos de respuesta
int
Generador de código
Genera fácilmente el código completo de tu petición en distintos lenguajes.
Simulador
Prueba tu petición y obtén al instante una respuesta simulada de ejemplo.