uip admin smtp

Syntax and options for `uip admin smtp`, which manages the organization's outbound SMTP email configuration.

uip admin smtp reads, updates, deletes, and tests the organization's outbound SMTP email configuration — the mail server UiPath uses to send notifications, invitations, and alerts.

Synopsis

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

• Settings are stored as individual key/value pairs (Email.Smtp.Host, Email.Smtp.Port, etc.) under the hood, but the CLI presents them as one flat settings object.
• The password is write-only. smtp get never returns it — the server returns SMTP settings with the password masked, so reading it back and re-sending it on update would silently corrupt the real value. smtp update only writes the password when you explicitly pass --password.
• update merges, it doesn't replace. It reads the existing settings, overlays the fields you passed, and writes the union back — because the server requires related keys (host, port, from-address) to be present together in one request. Passing no fields at all fails client-side ("No SMTP fields to update").
• --port and --connection-timeout are range-validated client-side — port must be an integer 1–65535; connection timeout must be an integer 1–300000 (milliseconds). An out-of-range value fails before any network call.
• test can validate a config without saving it. Pass SMTP options directly to test to try them without persisting; omit them to test the already-saved configuration. If you pass any custom SMTP option but not --password, and --use-default-credentials isn't true, the command fails client-side — the saved password is encrypted server-side and can't be reused in an ad hoc test. When you do pass partial custom options, they're merged onto the saved config (e.g. --host alone still uses the saved from-address).

uip admin smtp get

Get current SMTP settings for the organization. Password values are never returned.

Example

uip admin smtp get

Data shape (--output json)

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

uip admin smtp update

Update SMTP settings. Only the fields you pass change; everything else is preserved from the existing configuration.

Options

Long	Value	Description
--host <host>	string	SMTP server hostname.
--port <port>	integer 1–65535	SMTP server port.
--username <username>	string	SMTP authentication username.
--password <password>	string	SMTP authentication password. Write-only (never read back).
--domain <domain>	string	SMTP authentication domain.
--enable-ssl <value>	true|false	Enable SSL/TLS.
--use-default-credentials <value>	true|false	Use Windows default credentials instead of username/password.
--from-address <email>	email	Sender email address.
--from-display-name <name>	string	Sender display name.
--connection-timeout <ms>	integer 1–300000	Connection timeout in milliseconds.

At least one option is required.

Examples

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

Data shape (--output json)

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

uip admin smtp delete

Delete all SMTP settings for the organization — removes the entire email configuration.

Example

uip admin smtp delete

Data shape (--output json)

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

uip admin smtp test

Send a test email using the current saved settings, or a set of settings passed inline without saving them.

Options

Long	Value	Required	Description
--recipient <email>	email	yes	Address to send the test email to.
...same as update		no	Optional — pass any subset to test custom settings without saving. --password is required alongside a custom config unless --use-default-credentials true.

Examples

# 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

Data shape (--output json)

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

Related

• uip admin users — directory users and groups.
• uip admin robot-accounts / pat / scopes — non-human identities and tokens.
• uip admin external-apps — OAuth2 client registrations.

See also

• Global options
• Exit codes