Introduction

The MailJob template can be used to send mail from an Agent.

• The job template makes use of the SMTP protocol to send mail.
• The job template can be used to specify settings from different sources:
  • Connection Settings
    • This includes settings such as the SMTP host, port etc.
    • It is recommended to use JS7 - Job Resources for this purpose as such settings tend to use the same values for any mail that should be sent.
  • Mail Settings
    • Such settings are specific for individual mail and include e.g. the subject and body of the mail.
• The job template can be used with a JS7 - Credential Store.

Usage

When defining the job consider

• to invoke the Wizard that is available from the job properties tab in the Configuration view and to select the JITL MailJob and respective arguments from the Wizard

or

• to specify the JITL job class and com.sos.jitl.jobs.mail.MailJob Java class name, then add arguments what to send and where to send mail as explained from the below documentation.

Example

Download: pdwNotificationSOSMailPlainText.json

You can use the job wizard like this:

Explanation:

• Add an empty job from the instruction panel.
• Specify a name and a label for the job.
• Select an Agent.

In a next step invoke the job wizard that you find in the upper right corner of the job property editor. The wizard brings up the following popup window:

Explanation:

• From the list of available job templates select the MailJob.

Then hit the "Next" button to make the job wizard display available arguments:

Explanation:

• Required arguments include the to argument to specify the recipient of mail.
• Any other arguments are optional provided that a job resource is used that specifies connection details to your mail server, see below. Otherwise individual settings such as the SMTP host, SMTP port etc. can be specified from arguments.
• Select the check box provided with each argument if you want this argument to be added to the arguments of the mail job.

When hitting the "Submit" button the wizard adds the required arguments to your job that should look like this:

The job arguments can be specified

• from individual variables as offered by the job wizard.
• by use of job resources.

Use of Job Resource for Mail Settings

A number of settings for sending mail most probably carry the same values when used for different mail jobs. This includes e.g. use of the SMTP host, SMTP port etc.

• You can specify such settings individually from variables that are assigned the job's arguments, see above.
• You can specify such settings from JS7 - Job Resources that can be re-used for any number of mail jobs.

Setting up a Job Resource for Mail Settings

You can create a job resource that includes any settings required to send mail.

• For details how to set up a job resource, follow instructions from the JS7 - Job Resources article.
• Find the below example for download: eMailDefault.jobresource.json

A job resource has two parts, one being the variables that can be specified like this from the "Arguments" sub-tab:

Explanation:

• The variable names specified are selected to match use with the JITL MailJob template.
• Consider the use of variable names that start with mail.smtp.
  • These variable names correspond to Java properties available with the JavaMail API. Any of the JavaMail properties can be specified.
  • Find a full list of available mail.smtp. properties from https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html
  • Required properties include (but are not limited to):
    • mail.smtp.host
    • mail.smtp.port

The second part of a job resource is available with the "Environment Variables" sub-tab:

Explanation:

• Values of environment variables are assigned the corresponding variables as explained with the previous chapter.
• The purpose of the "Environment Variables" sub-tab is to propagate variables to shell jobs should you operate jobs that require such environment variables for parameterization purposes.
• Consider that the JITL MailJob is a job running in the Java Virtual Machine. It is not a shell job and therefore does not use environment variables.

Assigning a Job Resource for Mail Settings

With a job resource being created and deployed it can be assigned the JITL MailJob to populate the job's arguments from the job resource like this:

Documentation

Job Documentation: https://www.sos-berlin.com/doc/JS7-JITL/MailJob.xml

The MailJob class accepts the following arguments:

For use of the credential_store_* arguments see JS7 - Use of Credential Store with JITL Jobs.

Further Resources

• JS7 - Job Resources