Mail

config does not require entering properties or arguments. Enter the command and then press Enter. The command returns a table containing current email configuration settings.

From the CLI prompt, enter:

system mail config

Press Enter.

system mail config
+----------------+---------------------+
|             id | 1                   |
|      fromemail | test@test.com       |
| outgoingserver | smtp.mailserver.com |
|           port | 587                 |
|       security | TLS                 |
|           smtp | true                |
|           user | test@test.com       |
|           pass | passw0rt            |
|       fromname | TrueNAS             |
|          oauth | <dict>              |
+----------------+---------------------+

The send command has one required property, mail_message, which has two required sub-properties, subject and text, and nine optional sub-properties (see chart below), and one optional property, mail_update, which uses the same properties as the update command.

Enter mail_message or mail_update properties as an array enclosed in curly brackets {}. Enclose properties and values in double quotes, do not double quote boolean values, separate properties from values using a colon, and separate property/value pairs using a comma.

From the CLI prompt, enter:

system mail send mail_message={“subject”:"test",“text”:"Test message"}

Where test is the email subject and Test message is the email body text. Press Enter.

system mail send mail_message={"subject":"test","text":"Test message."}
[0%] ...
[100%] ...
true

update has 9 optional properties (see the tables in Update Properties below). Enter the command followed by one or more property/value pairs. Enclose any values using special characters, for example a period . or @ in double quotes. Separate multiple property/value pairs with a space.

To configure the system email using SMTP, enter the mail update command followed by the SMTP properties.

To configure using OAuth, first obtain a valid OAuth token from your email provider. For example, see Authenticating with Google services. Enter the mail update command with the property OAuth followed by an array containing the client_id, client_secret, and refresh_token properties and values from the token.

The TrueNAS SCALE web UI provides a streamlined experience for Gmail OAuth authentication. See Setting Up System Email for details.

Press Enter. The command returns an empty line.

Use config to view updated configuration and send to confirm configuration by sending a test email.

From the CLI prompt, enter:

system mail update property=value

Where property is one of the optional properties (see table) and value is the setting you want to apply. Press Enter.