UIP-Administrator-SMTP

Syntax und Optionen für „uip admin SMTP“, das die Konfiguration von ausgehenden SMTP-E-Mails der Organisation verwaltet.

uip admin smtp liest, aktualisiert, löscht und testet die ausgehende SMTP-E-Mail-Konfiguration der Organisation – der Mail-Server, den UiPath zum Senden von Benachrichtigungen, Einladungen und Warnungen verwendet.

Zusammenfassung

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]

Konzepte

• Einstellungen werden als einzelne Schlüssel/Wert-Paare (Email.Smtp.Host, Email.Smtp.Port usw.) unter der Oberfläche gespeichert, aber die CLI zeigt sie als ein flaches Einstellungsobjekt an.
• Das Kennwort ist schreibgeschützt. smtp get gibt es nie zurück – der Server gibt SMTP-Einstellungen mit maskiertem Kennwort zurück, sodass das Zurücklesen und erneute Senden bei der Aktualisierung den echten Wert im Hintergrund verfälscht. smtp update schreibt das Kennwort nur, wenn Sie --password explizit übergeben.
• update wird zusammengeführt, nicht ersetzt. Es liest die vorhandenen Einstellungen, überschreibt die von Ihnen übergebenen Felder und schreibt die Vereinigung zurück – da der Server benötigt, dass verwandte Schlüssel (Host, Port, Absenderadresse) zusammen in einer Anforderung vorhanden sind. Wenn überhaupt keine Felder übergeben werden, schlägt dies auf der Clientseite fehl ("No SMTP fields to update").
• --port und --connection-timeout sind auf Clientseite bereichsvalidiert – der Port muss ein Integer von 1–65535 sein; Das Verbindungszeitlimit muss ein Integer zwischen 1–300.000 (Millisekunden) sein. Ein Wert außerhalb des Bereichs schlägt fehl, bevor ein Netzwerkaufruf ausgeführt wird.
• test kann eine Konfiguration validieren, ohne sie zu speichern. Übergeben Sie SMTP-Optionen direkt an test, um sie ohne Beibehaltung auszuprobieren; lassen Sie sie aus, um die bereits gespeicherte Konfiguration zu testen. Wenn Sie eine benutzerdefinierte SMTP-Option übergeben, aber nicht --password, und --use-default-credentials ist nicht true, schlägt der Befehl auf Clientseite fehl – das gespeicherte Kennwort ist serverseitig verschlüsselt und kann nicht für einen Ad-hoc-Test wiederverwendet werden . Wenn Sie teilweise benutzerdefinierte Optionen übergeben, werden sie mit der gespeicherten Konfiguration zusammengeführt (z. B. --host verwendet nur noch das gespeicherte from-address).

UIP-Administrator SMTP-Get

Rufen Sie die aktuellen SMTP-Einstellungen für die Organisation ab. Kennwortwerte werden nie zurückgegeben.

Beispiel

uip admin smtp get

Datenform (--output json)

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

UIP-Administrator-SMTP-Aktualisierung

Aktualisieren Sie die SMTP-Einstellungen. Nur die Felder, die Sie übergeben, ändern sich; Alles andere wird von der vorhandenen Konfiguration beibehalten.

Optionen

Long	Wert	Beschreibung
--host <host>	string	Hostname des SMTP-Servers.
--port <port>	Integer 1–65535	SMTP-Serverport.
--username <username>	string	Benutzername für SMTP-Authentifizierung.
--password <password>	string	SMTP-Authentifizierungskennwort. Schreibgeschützt ( Niemals zurücklesen).
--domain <domain>	string	SMTP-Authentifizierungsdomäne.
--enable-ssl <value>	true|false	Aktivieren Sie SSL/TLS.
--use-default-credentials <value>	true|false	Verwenden Sie die Windows-Standardanmeldeinformationen anstelle von Benutzername/Kennwort.
--from-address <email>	E-Mail	E-Mail-Adresse des Absenders.
--from-display-name <name>	string	Anzeigename des Absenders.
--connection-timeout <ms>	Integer 1–300.000	Verbindungs-Timeout in Millisekunden.

Mindestens eine Option ist erforderlich.

Beispiele

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

Datenform (--output json)

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

UIP-Administrator SMTP-Löschen

Alle SMTP-Einstellungen für die Organisation löschen – entfernt die gesamte E-Mail-Konfiguration.

Beispiel

uip admin smtp delete

Datenform (--output json)

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

UIP-Administrator-SMTP-Test

Senden Sie eine Test-E-Mail mit den aktuell gespeicherten Einstellungen oder eine Reihe von Einstellungen, die inline übergeben werden, ohne sie zu speichern.

Optionen

Long	Wert	Erforderlich	Beschreibung
--recipient <email>	E-Mail	ja	Adresse, an die die Test-E-Mail gesendet werden soll.
…wie update		nein	Optional – Übergeben Sie eine beliebige Teilmenge, um benutzerdefinierte Einstellungen ohne Speichern zu testen. --password ist zusammen mit einer benutzerdefinierten Konfiguration erforderlich, außer --use-default-credentials true.

Beispiele

# 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

Datenform (--output json)

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

Zugehörig

• uip admin users – Verzeichnisbenutzer und -gruppen.
• uip admin robot-accounts / pat / scopes – nicht-menschliche Identitäten und Token.
• uip admin external-apps – OAuth2 Client-Registrierungen.

Siehe auch

• Globale Optionen
• Exitcodes