...

The JITL MailInboxJob template can be used to read mail by job from a JS7 Agentcreate a job that reads a mail inbox.

• 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 suggest to use the same values for any mail inbox that should be read from the same mail server.
  • 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

...

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

...

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

...

• Required arguments include the mail.store.protocol argument to specify imap or pop3 to be used.
• Any other arguments are optional provided that a job resource Job Resource is used that specifies connection details to your the mail server, see below. Otherwise individual settings such as the IMAP/POP3 host, IMAP/POP3 port etc. can have to be specified from arguments.
• When using a secure SSL connection consider to
  • use the mail.imap.ssl.enable argument with 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 protocols to which protocol versions that limit handshake with the mail server is limitedto the 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, it is not guaranteed that protocol negotiation will perfectly work. In such a situation it is recommended to specify the protocol version by use of this argument.
• Select the check box provided with each argument if you want this argument to be added to the arguments of the mail inbox job MailInboxJob.

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

...

• from individual variables as offered by the job wizard.
• by use of job resourcesJob 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. 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 inbox jobs.

Setting up a Job Resource for Mail Settings

You can create a job resource Job Resource that includes any settings required to read mail inboxes.

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

A job resource Job Resource has two partssides, one being the variables that can be are specified like this 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.

Explanation:

• The variable names specified are selected to match use should match arguments available with the JITL MailInboxJob template.
• Consider the use of variable names that start with mail.store., mail.imap., mail.pop3, etc.
  • The variable names Names of variables 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.store.protocol
    • mail.imap.host
    • mail.imap.port
    • mail.imap.user
    • mail.imap.password

Assigning a Job Resource for Mail Settings

With a job resource being created and deployed it can be assigned the JITL A Job Resource can be created, deployed and assigned the MailInboxJob to populate the job's arguments from the job resource Job Resource like this:

Documentation

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

...