smtp d’administrateur UIP

Syntaxe et options de `uip admin smtp`, qui gère la configuration des e-mails SMTP sortants de l'organisation.

uip admin smtp lit, met à jour, supprime et teste la configuration des e-mails SMTP sortants de l'organisation — le serveur de messagerie que UiPath utilise pour envoyer des notifications, des invitations et des alertes.

Synthèse

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]

Concepts

• Les paramètres sont stockés sous forme de paires clé/valeur individuelles (Email.Smtp.Host, Email.Smtp.Port, etc.) invisibles, mais la CLI les présente sous la forme d’un même objet de paramètres plate.
• Le mot de passe est en écriture seule. smtp get ne le renvoie jamais: le serveur renvoie les paramètres SMTP avec le mot de passe masqué, de sorte que sa lecture et son renvoi lors de la mise à jour corrompreaient silencieusement la valeur réelle. smtp update écrit le mot de passe uniquement lorsque vous transmettez explicitement --password.
• update fusionne, il ne remplace pas. Il lit les paramètres existants, superpose les champs que vous avez transmis et écrit l'union à nouveau, car le serveur exige que des clés connexes (hôte, port, adresse de l'expéditeur) soient présentes ensemble dans une seule requête. La transmission d’aucun champ échoue du tout côté client ("No SMTP fields to update").
• --port et --connection-timeout sont validés par la plage côté client - le port doit être un entier compris entre 1 et 65 535; le délai d’expiration de connexion doit être un nombre entier compris entre 1 et 300 000 (millisecondes). Une valeur hors plage échoue avant tout appel réseau.
• test peut valider une configuration sans l'enregistrer. Transmettez les options SMTP directement à test pour les essayer sans persister; Omettez-les pour tester la configuration déjà enregistrée. Si vous transmettez une option SMTP personnalisée mais pas --password et que --use-default-credentials n'est pas true, la commande échoue côté client — le mot de passe enregistré est chiffré côté serveur et ne peut pas être réutilisé dans un test ad hoc . Lorsque vous transmettez des options personnalisées partielles, elles sont fusionnées avec la configuration enregistrée (par exemple --host seul utilise toujours le from-address enregistré).

Obtenir le SMTP d’administrateur UIP

Obtenez les paramètres SMTP actuels de l'organisation. Les valeurs de mot de passe ne sont jamais retournées.

Exemple

uip admin smtp get

Format des données (--sortie json)

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

mise à jour du suffixe de l’administrateur UiP

Mettez à jour les paramètres SMTP. Seuls les champs que vous transmettez sont modifiés; tout le reste est préservé de la configuration existante.

Options

Long	Valeur (Value)	Description
--host <host>	string	Nom d'hôte du serveur SMTP.
--port <port>	entier 1 – 65 535	Port du serveur SMTP.
--username <username>	string	Nom d'utilisateur d'authentification SMTP.
--password <password>	string	Mot de passe d'authentification SMTP. En écriture uniquement (aucune relecture).
--domain <domain>	string	Domaine d’authentification SMTP.
--enable-ssl <value>	true|false	Activez SSL/TLS.
--use-default-credentials <value>	true|false	Utilisez les identifiants par défaut de Windows au lieu du nom d'utilisateur/du mot de passe.
--from-address <email>	E-mail	Expéditeur adresse e-mail.
--from-display-name <name>	string	Expéditeur nom complet.
--connection-timeout <ms>	entier 1 à 30 000	Délai d'expiration de la connexion en millisecondes.

Au moins une option est requise.

Exemples

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

Format des données (--sortie json)

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

Suppression de SMTP d’administrateur UIP

Supprimer tous les paramètres SMTP pour l'organisation — supprime toute la configuration des e-mails.

Exemple

uip admin smtp delete

Format des données (--sortie json)

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

Test SMTP d’administrateur UIP

Envoyez un e-mail de test à l’aide des paramètres enregistrés actuels ou d’un ensemble de paramètres transmis sans les enregistrer.

Options

Long	Valeur (Value)	Requis	Description
--recipient <email>	E-mail	oui	Adresse à laquelle envoyer l'e-mail de test.
...identique à update		non	Facultatif: transmettez tout sous-ensemble pour tester les paramètres personnalisés sans enregistrer. --password est requis avec une configuration personnalisée, sauf --use-default-credentials true.

Exemples

# 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

Format des données (--sortie json)

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

Associé

• uip admin users — utilisateurs et groupes de l'annuaire.
• uip admin robot-accounts / pat / scopes — identités et jetons non humains.
• uip admin external-apps — Inscriptions de clients OAuth2.

Voir également

• Options globales
• Codes de sortie