UIP 管理者 SMTP

「uip admin smtp」の構文とオプション - 組織の送信 SMTP メールの設定を管理します。

uip admin smtp は、組織の送信 SMTP メールの設定 (UiPath が通知、招待、アラートの送信に使用するメール サーバー) を読み取り、更新、削除、およびテストします。

概要

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]

概念

• 設定は、内部では個別のキーと値のペア (Email.Smtp.Host、 Email.Smtp.Portなど) として保存されますが、CLI では 1 つのフラットな設定オブジェクトとして表示されます。
• パスワードは書き込み専用です。smtp get は決して返しません — サーバーはパスワードをマスクした状態で SMTP 設定を返すため、それを読み戻して更新時に再送信すると、実際の値が静かに破損します。smtp update は、明示的に を渡した場合にのみパスワード --password書き込みます。
• マージupdate、置換されません。既存の設定を読み取り、渡したフィールドをオーバーレイして、共用体を書き戻します — サーバーでは、関連するキー (ホスト、ポート、送信元アドレス) が 1 つの要求に一緒に存在する必要があるためです。フィールドをまったく渡さないと、クライアント側で失敗します ("No SMTP fields to update")。
• --port と --connection-timeout はクライアント側で範囲検証済みです。ポートは整数 1 から 65535 である必要があります。接続タイムアウトは、1 から 300000 (ミリ秒) の整数である必要があります。範囲外の値があると、ネットワーク呼び出しの前に失敗します。
• test 保存せずに構成を検証できます。SMTP オプションを test に直接渡して、しつこく試すことなく試す既に保存された設定をテストする場合は、これらのオプションを省略します。いずれかのカスタム SMTP オプションを渡しても を--passwordせず、 がtrue--use-default-credentialsない場合、コマンドはクライアント側で失敗します。保存されたパスワードはサーバー側で暗号化され、アドホック テストで再利用できません。部分的なカスタムオプションを渡すと、保存されている構成にマージされます(例:--host だけでは、保存した from-addressが使用されます)。

uip admin smtp get

組織の現在の SMTP 設定を取得します。パスワードの値は返されません。

例

uip admin smtp get

データシェイプ(--output json)

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

UIP 管理者 SMTP の更新

SMTP の設定を更新します。渡したフィールドのみが変更されます。それ以外はすべて既存の構成のまま保持されます。

オプション

長押し	値 (Value)	説明
--host <host>	string	SMTP サーバーのホスト名です。
--port <port>	整数 1 - 65535	SMTP サーバーのポートです。
--username <username>	string	SMTP 認証ユーザー名です。
--password <password>	string	SMTP 認証パスワードです。書き込み専用 (読み戻さない)。
--domain <domain>	string	SMTP 認証ドメインです。
--enable-ssl <value>	true|false	SSL/TLS を有効化します。
--use-default-credentials <value>	true|false	ユーザー名/パスワードの代わりに Windows の既定の資格情報を使用します。
--from-address <email>	メール アドレス	送信者のメール アドレス。
--from-display-name <name>	string	送信者の表示名。
--connection-timeout <ms>	整数 1 から 300000	接続タイムアウト (ミリ秒)。

少なくとも 1 つのオプションが必要です。

例

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

データシェイプ(--output json)

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

uip 管理者 smtp の削除

組織の SMTP 設定をすべて削除 — メールの設定をすべて削除します。

例

uip admin smtp delete

データシェイプ(--output json)

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

UIP 管理者 SMTP テスト

現在保存されている設定、または保存せずにインラインで渡された一連の設定を使用して、テスト メールを送信します。

オプション

長押し	値 (Value)	Required	説明
--recipient <email>	メール アドレス	○	テスト メールの送信先アドレスです。
...次の値と同じ update		×	任意 — 任意のサブセットを渡して、保存せずにカスタム設定をテストします。--password の場合を除き、カスタム構成とともに --use-default-credentials true必要があります。

例

# 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

データシェイプ(--output json)

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

関連

• uip admin users — ディレクトリ ユーザーとディレクトリ グループ
• uip admin robot-accounts/pat/scopes — 人間以外の ID とトークン。
• uip admin external-apps — OAuth2 クライアントの登録です。

参照

• グローバル オプション
• 終了コード