UIP Admin SMTP

Sintaxe e opções para "uip admin smtp", que gerencia a configuração de e-mail SMTP de saída da organização.

uip admin smtp lê, atualiza, exclui e testa a configuração de e-mail SMTP de saída da organização — o servidor de e-mail que a UiPath usa para enviar notificações, convites e alertas.

Resumo

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]

Conceitos

• As configurações são armazenadas como pares de chave/valor individuais (Email.Smtp.Host, Email.Smtp.Port, etc.) sob o pano, mas a CLI as apresenta como um objeto de configurações simples.
• A senha é somente gravação. smtp get nunca a retorna — o servidor retorna configurações SMTP com a senha mascarada, portanto, lê-la de volta e reenviá-la na atualização corromperia silenciosamente o valor real. smtp update só grava a senha quando você passa --password explicitamente.
• update mescla, ele não substitui. Ele lê as configurações existentes, sobrepõe os campos que você passou e grava a união de volta — porque o servidor requer que as chaves relacionadas (host, porta, endereço de origem) estejam presentes juntas em uma solicitação. Não passar nenhum campo falha no lado do cliente ("No SMTP fields to update").
• --port e --connection-timeout são o lado do cliente validado por intervalo — a porta deve ser um número inteiro de 1 a 65535; o tempo limite da conexão deve ser um número inteiro de 1 a 300.000 (milissegundos). Um valor fora do intervalo falha antes de qualquer chamada de rede.
• test validar uma configuração sem salvá-la. Passe as opções de SMTP diretamente para test para experimentá-las sem persistir; omita-os para testar a configuração já salva. Se você passar qualquer opção SMTP personalizada, mas não --password, e --use-default-credentials não for true, o comando falhará no lado do cliente — a senha salva é criptografada no lado do servidor e não pode ser reutilizada em um teste ad hoc . Quando você passa opções personalizadas parciais, elas são mescladas na configuração salva (por exemplo --host isoladamente ainda usa o from-address salvo).

Obter smtp do administrador do uip

Obtenha as configurações de SMTP atuais para a organização. Os valores de senha nunca são retornados.

Exemplo

uip admin smtp get

Formato dos dados (--output json)

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

atualização de SMTP do administrador do uip

Atualize as configurações de SMTP. Apenas os campos que você passar serão alterados; todo o resto é preservado da configuração existente.

Opções

Long	Valor	Description
--host <host>	String	Nome do host do servidor SMTP.
--port <port>	número inteiro 1 – 65535	Porta do servidor SMTP.
--username <username>	String	Nome de usuário de autenticação SMTP.
--password <password>	String	Senha de autenticação SMTP. Somente para gravação (nunca lido de volta).
--domain <domain>	String	Domínio de autenticação SMTP.
--enable-ssl <value>	true|false	Habilite o SSL/TLS.
--use-default-credentials <value>	true|false	Use as credenciais padrão do Windows em vez de nome de usuário/senha.
--from-address <email>	email	Endereço de email do remetente.
--from-display-name <name>	String	Nome de exibição do remetente.
--connection-timeout <ms>	número inteiro 1–300000	Tempo limite da conexão em milissegundos.

É necessária pelo menos uma opção.

Exemplos

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

Formato dos dados (--output json)

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

Excluir smtp do administrador do uip

Excluir todas as configurações de SMTP da organização — remove toda a configuração de e-mail.

Exemplo

uip admin smtp delete

Formato dos dados (--output json)

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

teste smtp do administrador do uip

Envie um email de teste usando as configurações atuais salvas ou um conjunto de configurações passadas em linha sem salvá-las.

Opções

Long	Valor	Required	Description
--recipient <email>	email	sim	Endereço para o qual enviar o email de teste.
...igual a update		não	Opcional — passe qualquer subconjunto para testar configurações personalizadas sem salvar. --password é necessário junto com uma configuração personalizada, a menos --use-default-credentials true que.

Exemplos

# 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

Formato dos dados (--output json)

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

Relacionado

• uip admin users — usuários e grupos do diretório.
• uip admin robot-accounts / pat / scopes — identidades e tokens não humanos.
• uip admin external-apps — Registros de clientes do OAuth2.

Veja também

• Opções globais
• Códigos de saída