Skip to content

Zuar Runner Documentation Class - jobs.job_email.JobConfig

Class - `jobs.job_email.JobConfig`¶

JSON Schema¶

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	mail
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
	Credentials name or dict containing `username` and `password`.
	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.
	type	string
	examples	steve@zuar.com
mail_to	Mail To
	One or more email addresses.
	examples	alice@foo.com,bob@foo.com, ted@bar.com
		alice@foo.com
		bob@foo.com
		ted@bar.com
	anyOf	type	string
		type	array
		items	type	string
mail_cc	Mail Cc
	CC recipients.
	anyOf	type	string
		type	array
		items	type	string
mail_bcc	Mail Bcc
	BCC recipients.
	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.
	type	string
	examples	<html><head>CEO Report</head><body>Job done.</body></html>
attachments	Attachments
	List of a) file names located in `MITTO_DATA` or b) fully-qualified paths to files that will be attched to the email.
	type	array
	examples	vehicles.csv
		/tmp/temp_data.txt
	items	type	string