Module - jobs.job_email¶
JobConfig¶
JSON configuration for the job |
|||||
type |
object |
||||
properties |
|||||
|
Server |
||||
Hostname or IP address of a server. Defaults to a local postfix. |
|||||
type |
string |
||||
default |
localhost |
||||
|
Port |
||||
The TCP/IP port to use for SMTP. See comment at |
|||||
type |
integer |
||||
default |
25 |
||||
|
Require Tls |
||||
Use STARTTLS to establish secure transport. Note that this requires
use of a non-TLS port to first establish communication. Often, this
means that |
|||||
type |
boolean |
||||
default |
False |
||||
|
Credentials name or dict containing |
||||
Credentials |
|||||
examples |
‘support_email_account’ |
||||
{‘username’: ‘<username>’, ‘password’: ‘<password>’} |
|||||
anyOf |
type |
string |
|||
type |
object |
||||
additionalProperties |
type |
string |
|||
|
Timeout |
||||
Timeout in seconds for blocking operations. |
|||||
type |
integer |
||||
default |
30 |
||||
|
Mail Subject |
||||
The |
|||||
type |
string |
||||
default |
default_mail_subject |
||||
|
Mail From |
||||
The email address that will appear in the
|
|||||
type |
string |
||||
|
One or more email addresses.
|
||||
Mail To |
|||||
anyOf |
type |
string |
|||
type |
array |
||||
items |
|||||
type |
string |
||||
|
CC recipients. |
||||
Mail Cc |
|||||
anyOf |
type |
string |
|||
type |
array |
||||
items |
|||||
type |
string |
||||
|
BCC recipients. |
||||
Mail Bcc |
|||||
anyOf |
type |
string |
|||
type |
array |
||||
items |
|||||
type |
string |
||||
|
Text |
||||
Text template which will be used as the body of the email. |
|||||
type |
string |
||||
|
Html |
||||
HTML template which will be used as the body of the email.
|
|||||
type |
string |
||||
|
Attachments |
||||
List of attachments file names under mitto data directory or paths.
|
|||||
type |
array |
||||
items |
|||||
type |
string |