Module - jobs.job_email¶

JobConfig¶

JSON configuration for the job
type	object
properties
server	Server
	Hostname or IP address of a server. Defaults to a local postfix.
	type	string
	default	localhost
port	Port
	The TCP/IP port to use for SMTP. See comment at `require_tls`.
	type	integer
	default	25
require_tls	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 `port` should be set to `25` or `2525`. Do not use the standard SMTP TLS port (e.g., 465).
	type	boolean
	default	False
credentials	Credentials name or dict containing `username` and `password`.
	Credentials
	examples	‘support_email_account’
		{‘username’: ‘<username>’, ‘password’: ‘<password>’}
	anyOf		type	string
			type	object
			additionalProperties	type	string
timeout	Timeout
	Timeout in seconds for blocking operations.
	type	integer
	default	30
mail_subject	Mail Subject
	The `Subject` of the outgoing email.
	type	string
	default	default_mail_subject
mail_from	Mail From
	The email address that will appear in the `From:` field of the outgoing email. Example:: “steve@zuar.com”
	type	string
mail_to	One or more email addresses. Example:: “alice@foo.com,bob@foo.com, ted@bar.com” [“alice@foo.com”, “bob@foo.com”, “ted@bar.com”]
	Mail To
	anyOf		type	string
			type	array
			items
				type	string
mail_cc	CC recipients.
	Mail Cc
	anyOf		type	string
			type	array
			items
				type	string
mail_bcc	BCC recipients.
	Mail Bcc
	anyOf		type	string
			type	array
			items
				type	string
text	Text
	Text template which will be used as the body of the email.
	type	string
html	Html
	HTML template which will be used as the body of the email. Example: “<html><head>CEO Report</head><body>Job done.</body></html>”
	type	string
attachments	Attachments
	List of attachments file names under mitto data directory or paths. Example: [“vehicles.csv”, “/tmp/temp_data.txt”]
	type	array
	items
		type	string

Table Of Contents

Module - jobs.job_email¶

JobConfig¶