Módulo: `mail`#

`accounts`#

count mail accounts
list mail accounts

COMANDOS

count mail accounts

Devuelve el número de cuentas de correo de cPanel.

Ejemplo

$ cpanel count mail accounts

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/count_pops/

list mail accounts

Lista las cuentas de correo de cPanel.

Ejemplo

$ cpanel list mail accounts

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_pops/

`settings`#

get mail settings ACCOUNT

Obtiene la configuración del correo ACCOUNT.

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

Ejemplo

$ cpanel get mail settings scott@example.com

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/get_client_settings

`incoming`#

suspend mail incoming ACCOUNT
unsuspend mail incoming ACCOUNT

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

COMANDOS

suspend mail incoming ACCOUNT

Suspende el correo entrante para la cuenta ACCOUNT, de forma que no se acepta ningún correo nuevo. El usuario aún podrá iniciar sesión en la cuenta. Vea además ‘cpanel unsuspend mail incoming’.

Ejemplo

$ cpanel suspend mail incoming scott@example.com

unsuspend mail incoming ACCOUNT

Vuelve a habilitar el correo entrante para la cuenta ACCOUNT, de modo que se acepten nuevos correos.

Ejemplo

$ cpanel unsuspend mail incoming scott@example.com

`outgoing`#

suspend mail outgoing ACCOUNT
unsuspend mail outgoing ACCOUNT

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

COMANDOS

suspend mail outgoing ACCOUNT

Suspende el correo saliente (SMTP) para la cuenta ACCOUNT, de modo que no se pueda enviar correo. El usuario aún podrá iniciar sesión en la cuenta. Vea además ‘cpanel unsuspend mail outgoing’.

Ejemplo

$ cpanel suspend mail outgoing scott@example.com

unsuspend mail outgoing ACCOUNT

Vuelve a habilitar el correo saliente (SMTP) para la cuenta ACCOUNT, de modo que se puedan enviar correos.

Ejemplo

$ cpanel unsuspend mail outgoing scott@example.com

`login`#

suspend mail login ACCOUNT
unsuspend mail login ACCOUNT

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

COMANDOS

suspend mail login ACCOUNT

Suspende la cuenta ACCOUNT, de modo que el usuario no pueda iniciar sesión. Tenga en cuenta que la cuenta no se elimina, por lo que el nuevo correo aún se recibirá y almacenará en ella. Vea también ‘cpanel unsuspend mail login’.

Ejemplo

$ cpanel suspend mail login scott@example.com

unsuspend mail login ACCOUNT

Vuelve a habilitar ACCOUNT, para que el usuario pueda iniciar sesión nuevamente.

Ejemplo

$ cpanel unsuspend mail login scott@example.com

`boxes`#

list mail boxes [ACCOUNT] [DIR]

Lista los directorios y archivos del buzón de correo de ACCOUNT. Si no se proporciona ACCOUNT, lista los buzones de correo para todas las cuentas de correo. Opcionalmente, puede restringir el listado al directorio DIR.

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

Ejemplos

$ cpanel list mail boxes
$ cpanel list mail boxes scott@example.com
$ cpanel list mail boxes scott@example.com .Sent
$ cpanel list mail boxes scott@example.com .spam

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/browse_mailbox

`autoresponders`#

list mail autoresponders DOMAIN
count mail autoresponders
get mail autoresponder ACCOUNT
set mail autoresponder ACCOUNT [FROM] [SUBJECT] [BODY] [START] [STOP]
delete mail autoresponder ACCOUNT

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

COMANDOS

list mail autoresponders DOMAIN

Lista las respuestas automáticas de todas las cuentas de correo de DOMAIN.

Ejemplo

$ cpanel list mail autoresponders example.com

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_auto_responders/

count mail autoresponders

Devuelve el número de respuestas automáticas para todas las cuentas de correo.

Ejemplo

$ cpanel count mail autoresponders

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/count_auto_responders/

get mail autoresponder ACCOUNT

Devuelve información de la respuesta automática correspondiente a ACCOUNT.

Ejemplo

$ cpanel get mail autoresponder scott@example.com

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/get_auto_responder/

set mail autoresponder ACCOUNT [FROM] [SUBJECT] [BODY] [START] [STOP]

Crea una respuesta automática para ACCOUNT.

FROM es el nombre del remitente; por defecto, se utiliza el nombre de correo ACCOUNT.

SUBJECT es el asunto del correo de respuesta automática; el asunto por defecto es “This is an automatic message”

BODY es el texto del correo de respuesta automática; el cuerpo por defecto es “I’m currently unavailable.”

START es el instante de tiempo a partir del cual la respuesta automática está activa; puede usar una expresión legible para un humano (en inglés) que se pueda interprertar como una fecha y hora, por ejemplo, “now”, “tomorrow 9 AM”, “December 20, 2022 19:00”, etc. Para más ejemplos, véase bear/parsedatetime La fecha y hora START por defecto es “now”, lo que significa que la respuesta automática se habilita inmediatamente.

STOP es el instante de tiempo a partir del cual se deshabilita la respuesta automática; puede usar una expresión legible como en START. La fecha y hora STOP por defecto es una fecha muy lejana en el futuro, lo que significa que a efectos prácticos la respuesta automática estará habilitada hasta que se desactive manualmente utilizando ‘cpanel delete autoresponder’

Ejemplos

$ cpanel set mail autoresponder scott@example.com

$ cpanel set mail autoresponder \
      scott@example.com \
      "Bruce Scott" \
      "Auto-response"

$ cpanel set mail autoresponder \
      scott@example.com \
      "Bruce Scott" \
      "This is an automatic message" \
      "I’m currently unavailable, please contact my boss." \
      "Tomorrow 6 PM" \
      "December 15, 8:00 AM"

delete mail autoresponder ACCOUNT

Elimina la respuesta automática para ACCOUNT.

Ejemplo

$ cpanel delete mail autoresponder scott@example.com

`forwarders`#

list mail forwarders [DOMAIN]
add mail forwarder DOMAIN FORWARDHERE
add mail forwarder EMAIL FORWARDHERE
count mail forwarders
delete mail forwarder DOMAIN
delete mail forwarder EMAIL

COMANDOS

list mail forwarders [DOMAIN]

Lista todos los reenviadores activos de correo. Si se proporciona el argumento opcional DOMAIN, sólo se listan los reenviadores para el dominio DOMAIN.

Ejemplos

$ cpanel list mail forwarders
$ cpanel list mail forwarders example.com

Vea una muestra del resultado en formato JSON para todos los reenviadores en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_forwarders/

Vea una muestra del resultado en formato JSON para los reenviadores de DOMAIN en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_domain_forwarders/

add mail forwarder DOMAIN FORWARDHERE

Reenvía todo el correo recibido en las cuentas del dominio DOMAIN al dominio FORWARDHERE.

Ejemplo

$ cpanel add mail forwarder example.com forwarded.com

add mail forwarder EMAIL FORWARDHERE

Reenvía todo el correo recibido en EMAIL a la dirección de correo FORWARDHERE.

Ejemplo

$ cpanel add mail forwarder scott@example.com larry@example.com

count mail forwarders

Devuelve el número total de reenviadores de correo para todas las cuentas.

Ejemplo

$ cpanel count mail forwarders

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/count_forwarders/

delete mail forwarder DOMAIN

Elimina el reenviador del dominio DOMAIN.

Ejemplo

$ cpanel delete mail forwarder example.com

delete mail forwarder EMAIL

Elimina el reenviador de la dirección de correo EMAIL.

Ejemplo

$ cpanel delete mail forwarder scott@example.com

`filters`#

list mail filters ACCOUNT
count mail filters
get mail filter ACCOUNT FILTERNAME
set mail filter ACCOUNT FILE
enable mail filter ACCOUNT FILTERNAME
disable mail filter ACCOUNT FILTERNAME
delete mail filter ACCOUNT FILTERNAME
move mail filter ACCOUNT FILTERNAME up|down [N]
move mail filter ACCOUNT FILTERNAME top|bottom
move mail filter ACCOUNT FILTERNAME N
trace mail filter ACCOUNT TESTMESSAGE
list filter domains

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Utilice ‘cpanel list mail accounts’ para obtener una lista de cuentas válidas para ACCOUNT.

COMANDOS

list mail filters ACCOUNT

Lista los filtros de correo asociados a ACCOUNT.

Ejemplo

$ cpanel list mail filters scott@example.com

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_filters/

count mail filters

Devuelve el número total de filtros de correo para todas las cuentas.

Ejemplo

$ cpanel count mail filters

get mail filter ACCOUNT FILTERNAME

Devuelve una descripción en formato JSON del filtro de correo electrónico FILTERNAME asociado al correo ACCOUNT. Para obtener la lista de filtros, use ‘cpanel list mail filters ACCOUNT’

Ejemplo

$ cpanel get mail filter scott@example.com spamkiller

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/get_filter/

set mail filter ACCOUNT FILE

Crea o actualiza un filtro de correo electrónico asociado con el correo ACCOUNT. Si el filtro ya existe, lo actualiza; de lo contrario, crea un nuevo filtro. Utilice un JSON FILE para describir las reglas del filtro. Este JSON FILE tiene el mismo formato textual que la salida de ‘cpanel get mail filter’, por lo que la forma más fácil de crear un nuevo filtro es descargar un filtro existente a un archivo ‘filter.json’, editarlo y luego cargarlo con ‘cpanel set mail filter’. Vea el ejemplo a continuación.

Ejemplo

$ cpanel get mail filter scott@example.com spamkiller > filter.json
$ cpanel set mail filter scott@example.com filter.json

enable mail filter ACCOUNT FILTERNAME

Activa el filtro de correo FILTERNAME asociado a ACCOUNT. Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’

Ejemplo

$ cpanel enable mail filter scott@example.com spamkiller

disable mail filter ACCOUNT FILTERNAME

Desactiva el filtro de correo FILTERNAME asociado a ACCOUNT. Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’

Ejemplo

$ cpanel disable mail filter scott@example.com spamkiller

delete mail filter ACCOUNT FILTERNAME

Elimina el filtro de correo FILTERNAME asociado a ACCOUNT. Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’

Ejemplo

$ cpanel delete mail filter scott@example.com spamkiller

move mail filter ACCOUNT FILTERNAME up|down [N]

Mueve el filtro de correo FILTERNAME asociado a ACCOUNT hacia arriba (up) o hacia abajo (down) en la lista de filtros. (Los filtros se ejecutan en orden desde el primero hacia abajo.) Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’. Si se especifica N, el filtro se mueve N posiciones hacia arriba o abajo.

Ejemplos

$ cpanel move mail filter scott@example.com spamkiller up
$ cpanel move mail filter scott@example.com spamkiller down
$ cpanel move mail filter scott@example.com spamkiller up 5
$ cpanel move mail filter scott@example.com spamkiller down 5

move mail filter ACCOUNT FILTERNAME top|bottom

Mueve el filtro de correo FILTERNAME asociado a ACCOUNT hacia la primera (top) o última (bottom) posición de la lista de filtros. (Los filtros se ejecutan en orden desde el primero hacia abajo.) Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’

Ejemplos

$ cpanel move mail filter scott@example.com spamkiller top
$ cpanel move mail filter scott@example.com spamkiller bottom

move mail filter ACCOUNT FILTERNAME N

Mueve el filtro de correo FILTERNAME asociado a ACCOUNT a la N-ésima posición de la lista de filtros. (Los filtros se ejecutan en orden desde el primero hacia abajo.) Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’

Ejemplos

$ cpanel move mail filter scott@example.com spamkiller 2
$ cpanel move mail filter scott@example.com spamkiller 4

trace mail filter ACCOUNT TESTMESSAGE

Ejecuta los filtros asociados a ACCOUNT usando un mensaje de prueba cuyo cuerpo es TESTMESSAGE y reporta qué filtros se disparan. Este comando se puede usar para ver el efecto de un filtro nuevo. (Los filtros se ejecutan en orden desde el primero hacia abajo.) Para obtener la lista de filtros, utilice ‘cpanel list mail filters ACCOUNT’ Este comando no emite JSON sino una traza de ejecución.

Ejemplo

$ cpanel trace mail filter scott@example.com "Spam and eggs!"

list filter domains

Lista todos los dominios que tienen filtros de correo.

Ejemplo

$ cpanel list filter domains

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/list_filters_backups/

`quota`#

get mail quota ACCOUNT
set mail quota ACCOUNT QUOTA
get mail quota default
get mail quota max

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

COMANDOS

get mail quota ACCOUNT

Devuelve la cuota de espacio de correo en megabytes asignada a la cuenta ACCOUNT, o «unlimited» si no tiene cuota.

Ejemplo

$ cpanel get mail quota scott@example.com

set mail quota ACCOUNT QUOTA

Establece la cuota QUOTA en megabytes signada a la cuenta ACCOUNT; use ‘0’ o ‘unlimited’ para establecer una cuota ilimitada.

Ejemplos

$ cpanel set mail quota scott@example.com 1024
$ cpanel set mail quota scott@example.com 0
$ cpanel set mail quota scott@example.com unlimited

get mail quota max

Devuelve la cuota máxima en megabytes de espacio de correo permitida en cPanel.

Ejemplo

$ cpanel get mail quota max

get mail quota default

Devuelve la cuota por defecto en megabytes de espacio de correo permitida en cPanel.

Ejemplo

$ cpanel get mail quota default

`usage`#

get mail usage ACCOUNT

ACCOUNT es el nombre de una cuenta de correo de cPanel, generalmente de la forma user@domain.com

Devuelve el espacio en disco en megabytes usado por la cuenta ACCOUNT.

Ejemplo

$ cpanel get mail usage scott@example.com

Vea una muestra del resultado en formato JSON en: https://api.docs.cpanel.net/openapi/cpanel/operation/get_disk_usage/

Módulo: mail

Contenido

Módulo: `mail`#

`accounts`#

`settings`#

`incoming`#

`outgoing`#

`boxes`#

`autoresponders`#

`forwarders`#

`filters`#

`quota`#

`usage`#

Módulo: mail

Contenido

Módulo: mail#

accounts#

settings#

incoming#

outgoing#

login#

boxes#

autoresponders#

forwarders#

filters#

quota#

usage#

Módulo: `mail`#

`accounts`#

`settings`#

`incoming`#

`outgoing`#

`login`#

`boxes`#

`autoresponders`#

`forwarders`#

`filters`#

`quota`#

`usage`#