...

The MailInboxJob template can be used to read mail by an job from a JS7 Agent.

• The job template makes use of the IMAP or POP3 protocol to read mail.
• The job template can be used to specify settings from different sources:
  • Connection Settings
    • This includes settings such as the IMAP/POP3 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 inbox that should be read.
  • Mail Settings
    • Such settings are specific for individual mail inboxes and include e.g. the folder of the mail inbox.
• The job template can be used with a JS7 - Credential Store.

• Display feature availability
  StartingFromRelease 2.1.1

...

You can use the job wizard like this:

Image RemovedImage Added

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:

Image RemovedImage Added

Explanation:

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

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

Image RemovedImage Added

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 IMAP/POP3 host, SMTP IMAP/POP3 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 inbox job.

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

Image RemovedImage Added

The job arguments can be specified

...

A number of settings for reading mail inboxes most probably carry the same values when used for different mail jobs. This includes e.g. use of the IMAP/POP3 host, 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.

...

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

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

Image RemovedImage Added

Explanation:

• The variable names specified are selected to match use with the JITL MailInboxJob template.
• Consider the use of variable names that start with mail.store., mail.imap., mail.pop3, etc.
  • These The 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
    • general mail settings from https://javaee.github.io/javamail/docs/api/javax/mail/package-summary.html
    • mail.imap. properties from https://javaee.github.io/javamail/docs/api/com/sun/mail/imap/package-summary.html
    • mail.pop3. properties from https://javaee.github.io/javamail/docs/api/com/sun/mail/pop3/package-summary.html 
  • Required properties include (but are not limited to):
    • mail.imap.host
    • mail.imap.port

...

Image Removed

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 MailInboxJob to populate the job's arguments from the job resource like this:

Image RemovedImage Added

Documentation

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

...