...

• 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 These include settings such as the IMAP/POP3 host, port etc.
    • It is recommended to use that the JS7 - Job Resources is used for this purpose as such settings suggest to the use of the same values for any mail inbox that should be read from the same mail server.
  • Mail Settings
    • Such These settings are specific for individual mail inboxes and include e.g. , for example, the folder of the mail inbox.
• The job template can be used with a JS7 - Credential Store.

• Display feature availability
  StartingFromRelease 2.1.1

Usage

When defining the job considereither:

• to invoke the Wizard that is available from the Job Properties tab in the Configuration view and to select the JITL MailInboxJob and respective relevant arguments from the Wizard

or

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

Example

Download: jitlMailInboxJob_sample.workflow.json

You can use the job wizard like thisas shown here:

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 will bring up the following popup window:

...

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

Explanation:

• Required arguments include the mail.store.protocol argument to specify which specifies whether imap or pop3 to should be used.
• Any All other arguments are optional provided that a Job Resource is used that which specifies the connection details to the mail server, see below. Otherwise individual settings such as the IMAP/POP3 host, IMAP/POP3 port etc. have to be specified from arguments.
• When using a secure SSL connection consider tothat:
  • use the mail.imap.ssl.enable argument with has the value true,
  • optionally use the mail.imap.ssl.protocols argument with a value such as TLSv1.2 or TLSv1.1,TLSv1.2 to specify one or more protocol versions that limit handshake with the mail server to the the protocol versions specified protocol versions. Depending on the Java version in use and possible modifications of the java.security file a number of protocols could be enabled that might not match the mail server's capabilities. Typically SSL handshaking starts from the highest protocol version accepted by both parties, however. However, it is not guaranteed that protocol negotiation will work perfectly work. In such a situation it is recommended to specify that the protocol version by use of is specified using this argument.
• Select the check box provided with each argument if you want this argument to be added to the arguments of the MailInboxJob.

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

The job arguments can be specified:

• from individual variables as offered by configured using the job wizard.
• by use of using Job Resources.

Use of Job Resources for Mail Settings

A number of settings for reading mail inboxes most probably carry the same values when used for different mail inbox jobs. This includes e.g. , for example, the use of the IMAP/POP3 host, port etc.

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

...

• For details how to set up a Job Resource, follow instructions from the JS7 - Job Resources article.
• Find the below example The example shown below is available for download: eMailIMAPDefault.jobresource.json

A Job Resource has two sides, one being the variables that are specified from the "Arguments" sub-tab and the second is about "Environment Variables" that are available for Shell Jobs. For the purpose of use with the MailInboxJob it is sufficient to specify variables from the "Arguments" tab.

...

• The variable names specified should match arguments available with the JITL MailInboxJob template.
• Consider use of variable names that start with mail.store., mail.imap., mail.pop3, etc.
  • Names of variables correspond to Java properties available with the JavaMail API. Any of the JavaMail properties can be specified.
  • Find You will 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.store.protocol
    • mail.imap.host
    • mail.imap.port
    • mail.imap.user
    • mail.imap.password

...

A Job Resource can be created, deployed and assigned the MailInboxJob to populate the job's arguments from the Job Resource like as shown in this screenshot:

Documentation

The Job Documentation including the full list of available arguments can be found under: https://www.sos-berlin.com/doc/JS7-JITL/MailInboxJob.xml

...