mail.send

Sends mail using configured mail settings.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: message

message

Type: object

Email message content and configuration.

No Additional Properties

subject Required

Subject

Type: string

Subject line for the email message.

text

Text

Type: string

Formatted to HTML using Markdown and rendered using default email template.

html

Html

Custom HTML (overrides text). If null, no HTML MIME part will be added to the email.

Any of

• Option 1
• Option 2

Type: string

Type: null

to

To

Type: array of string

Email recipients. Defaults to all local administrators.

No Additional Items

Each item of this array must be:

Type: string

cc

Cc

Type: array of string

Email CC recipients, if any.

No Additional Items

Each item of this array must be:

Type: string

interval

Interval

In seconds.

Any of

• Option 1
• Option 2

Type: integer

Type: null

channel

Channel

Defaults to "truenas".

Any of

• Option 1
• Option 2

Type: string

Type: null

timeout

Timeout

Type: integer Default: 300

Time limit for connecting to the SMTP server in seconds.

attachments

Attachments

Type: boolean Default: false

If set to true, an array compromised of the following object is required via HTTP upload:

• headers (array)

  • name (string)
  • value (string)
  • params (object)

• content (string)

Example:
[
{
"headers": [
{
"name": "Content-Transfer-Encoding",
"value": "base64"
},
{
"name": "Content-Type",
"value": "application/octet-stream",
"params": {
"name": "test.txt"
}
}
],
"content": "dGVzdAo="
}
]

queue

Queue

Type: boolean Default: true

Queue the message to be sent later if it fails to send.

extra_headers

Extra Headers

Type: object

Any additional headers to include in the email message.

Parameter 2: config

config

Type: object

Optional mail configuration overrides for this message.

No Additional Properties

fromemail

Fromemail

Type: string

The sending address that the mail server will use for sending emails.

fromname

Fromname

Type: string

Display name that will appear as the sender name in outgoing emails.

outgoingserver

Outgoingserver

Type: string

Hostname or IP address of the SMTP server used for sending emails.

port

Port

Type: integer

TCP port number for the SMTP server connection.

security

Security

Type: enum (of string)

Type of encryption.

Must be one of:

• "PLAIN"
• "SSL"
• "TLS"

smtp

Smtp

Type: boolean

Whether SMTP authentication is enabled and user, pass are required.

user

User

SMTP username.

Any of

• Option 1
• Option 2

Type: string

Type: null

pass

Pass

SMTP password.

Any of

• Option 1
• Option 2

Type: string

Type: null

oauth

Oauth

OAuth configuration for email providers that support it or null for basic authentication.

Any of

• MailEntryOAuth
• EmptyDict
• Option 3

MailEntryOAuth

Type: object
No Additional Properties

provider Required

Provider

Type: string

An email provider, e.g. "gmail", "outlook".

client_id Required

Client Id

Type: string

OAuth client ID provided by the email provider.

client_secret Required

Client Secret

Type: string

OAuth client secret provided by the email provider.

refresh_token Required

Refresh Token

Type: string

OAuth refresh token used to obtain new access tokens for email authentication.

EmptyDict

Type: object

Type: null

Return value

Result

Type: boolean

The message was sent successfully.

Required roles: MAIL_WRITE