mail.send ========= Sends mail using configured mail settings. .. raw:: html
Formatted to HTML using Markdown and rendered using default email template.
Custom HTML (overrides text
). If null, no HTML MIME part will be added to the email.
Email recipients. Defaults to all local administrators.
No Additional ItemsEmail CC recipients, if any.
No Additional ItemsIn seconds.
Defaults to "truenas".
Time limit for connecting to the SMTP server in seconds.
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)
[ { "headers": [ { "name": "Content-Transfer-Encoding", "value": "base64" }, { "name": "Content-Type", "value": "application/octet-stream", "params": { "name": "test.txt" } } ], "content": "dGVzdAo=" } ]
Whether to queue the message to be sent later if it fails to send.
Any additional headers to include in the email message.
The sending address that the mail server will use for sending emails.
Hostname or IP address of the SMTP server used for sending emails.
Type of encryption.
Whether SMTP authentication is enabled and user
, pass
are required.
SMTP username.
SMTP password.
An email provider, e.g. "gmail", "outlook".
Whether the message was sent successfully.