SMTP de administrador de UIP

Sintaxis y opciones para `smtp de administrador de uip`, que gestiona la configuración del correo electrónico SMTP saliente de la organización.

uip admin smtp lee, actualiza, elimina y prueba la configuración de correo electrónico SMTP saliente de la organización: el servidor de correo que UiPath utiliza para enviar notificaciones, invitaciones y alertas.

Sinopsis

uip admin smtp get
uip admin smtp update [--host <host>] [--port <port>] [--username <username>] [--password <password>] [--domain <domain>] [--enable-ssl true|false] [--use-default-credentials true|false] [--from-address <email>] [--from-display-name <name>] [--connection-timeout <ms>]
uip admin smtp delete
uip admin smtp test --recipient <email> [same options as update]

Conceptos

• La configuración se almacena como pares de clave/valor individuales (Email.Smtp.Host, Email.Smtp.Port, etc.) en segundo plano, pero la CLI los presenta como un objeto de configuración plano.
• La contraseña es de solo escritura. smtp get nunca lo devuelve: el servidor devuelve la configuración SMTP con la contraseña enmascarada, por lo que leerla y volver a enviarla al actualizar corrompería silenciosamente el valor real. smtp update solo escribe la contraseña cuando se pasa explícitamente --password.
• update fusiona, no reemplaza. Lee la configuración existente, superpone los campos que pasaste y escribe la unión de nuevo, porque el servidor requiere que las claves relacionadas (host, puerto, dirección de origen) estén presentes juntas en una solicitud. No pasar ningún campo falla en el lado del cliente ("No SMTP fields to update").
• --port y --connection-timeout son del lado del cliente validados por rango: el puerto debe ser un número entero entre 1 y 65535; el tiempo de espera de la conexión debe ser un número entero entre 1 y 300 000 (milisegundos). Un valor fuera de rango falla antes de cualquier llamada de red.
• test puede validar una configuración sin guardarla. Pasa las opciones SMTP directamente a test para probarlas sin persistir; omítelos para probar la configuración ya guardada. Si pasas cualquier opción SMTP personalizada pero no --password, y --use-default-credentials no es true, el comando falla en el lado del cliente: la contraseña guardada está cifrada en el lado del servidor y no se puede reutilizar en una prueba ad hoc . Cuando pasas opciones personalizadas parciales, se fusionan en la configuración guardada (por ejemplo solo --host sigue utilizando el from-address guardado).

obtención de SMtp de administrador de UIP

Obtener la configuración SMTP actual de la organización. Los valores de contraseña nunca se devuelven.

Ejemplo

uip admin smtp get

Forma de datos (--json de salida)

{
  "Code": "SmtpSettings",
  "Data": {
    "host": "smtp.example.com",
    "port": "587",
    "userName": "[e-mail]",
    "enableSsl": "True",
    "fromAddress": "[e-mail]",
    "fromDisplayName": "UiPath Platform"
  }
}

actualización de SMtp de administrador de UIP

Actualiza la configuración SMTP. Solo cambian los campos que pasas; todo lo demás se conserva de la configuración existente.

Opciones

Largo	Valor	Descripción
--host <host>	String	Nombre de host del servidor SMTP.
--port <port>	entero 1–65535	Puerto del servidor SMTP.
--username <username>	String	Nombre de usuario de autenticación SMTP.
--password <password>	String	Contraseña de autenticación SMTP. De solo escritura (nunca volver a leer).
--domain <domain>	String	Dominio de autenticación SMTP.
--enable-ssl <value>	true|false	Habilitar SSL/TLS.
--use-default-credentials <value>	true|false	Utiliza las credenciales predeterminadas de Windows en lugar del nombre de usuario/contraseña.
--from-address <email>	Correo electrónico	Dirección de correo electrónico del remitente.
--from-display-name <name>	String	Nombre para mostrar del remitente.
--connection-timeout <ms>	entero 1–300 000	Tiempo de espera de la conexión en milisegundos.

Se requiere al menos una opción.

Ejemplos

uip admin smtp update --host smtp.example.com --port 587

uip admin smtp update --host smtp.example.com --port 587 --username [e-mail] \
  --password secret --from-address [e-mail] --enable-ssl true

Forma de datos (--json de salida)

{ "Code": "SmtpSettingsUpdated", "Data": { "host": "smtp.example.com", "port": "587", "...": "same shape as smtp get" } }

Eliminar SMTP de administrador de UIP

Eliminar toda la configuración SMTP de la organización: elimina toda la configuración del correo electrónico.

Ejemplo

uip admin smtp delete

Forma de datos (--json de salida)

{ "Code": "SmtpSettingsDeleted", "Data": { "Status": "Deleted successfully" } }

prueba smtp de administrador de uip

Envíe un correo electrónico de prueba utilizando la configuración guardada actual o un conjunto de configuraciones pasadas en línea sin guardarlas.

Opciones

Largo	Valor	Obligatorio	Descripción
--recipient <email>	Correo electrónico	Sí	Dirección a la que enviar el correo electrónico de prueba.
... igual que update		No	Opcional: pasa cualquier subconjunto para probar la configuración personalizada sin guardar. --password es necesario junto con una configuración personalizada a menos que --use-default-credentials true.

Ejemplos

# Test the saved configuration
uip admin smtp test --recipient [e-mail]

# Test a custom configuration without saving it
uip admin smtp test --recipient [e-mail] --host smtp.example.com --port 587 \
  --username [e-mail] --password secret

Forma de datos (--json de salida)

{ "Code": "SmtpTestSent", "Data": { "Recipient": "[e-mail]", "Status": "Test email sent successfully" } }

Relacionado

• uip admin users : usuarios y grupos del directorio.
• uip admin robot-accounts / pat / scopes : identidades y tokens no humanos.
• uip admin external-apps : registros de clientes OAuth2.

Ver también

• Opciones globales
• Códigos de salida