config_email_global.xml

File config_email_global.xml is the configuration file for setting up the sender's email credentials for all emails that are sent by the LRM process. It is located in the global <HOME>/Lingoport_Data/L10nStreamlining/config folder.

The config_email_global.xml file is used by a project's Notifications Jenkins job in order to send out status emails. This Jenkins job is, by default, set to run once a week.

There are 3 types of information contained in the config_email_global.xml file.

email configuration

interval between the sending of status emails

flag indicating whether to send out the 'No Files to Prep' email

Email Credentials Configuration

The email configuration consists of the following xml elements:

smtp-host - server that will send the email

smtp-auth - authentication mechanism, if applicable

mail.smtp.auth - smtp protocol with smtp authentication

mail.smtps.auth - smtps protocol with smtps authentication

none' - smtp protocol with no authentication

email-sender - valid email address

sender-password - not required

The first step in configuring the global email file is to verify, with your IT department, the mail server credentials.
Send email command may be used to test the configuration values.

Additional Email Configuration

In addition, there are configuration settings for when to send out notification emails and whether or not to send out the 'No Files to Prep' email.

dashboard-url - Dashboard URL used as the link destination for the email Log In button

notify-changes-email-interval - By default, the Notification email may be sent every day. Since the project's Jenkins Notification job is only run once a week, this email will only be set out once a week.

late-kits-email-interval - By default, the Late Prep Kits email may be sent every day depending on the number of days late. Since the project's Jenkins Notification job is only run once a week, this email will be sent out once a week.

number-days-late - By default, a prep kit is deemed late if it is 7 days late.

send-no-files-to-prep-email - By default, the No Files to Prep email will be sent out when there is a request to prep a kit but there are no files to prep. If a Jenkins job is created that automatically attempts to prep a kit, then this value should be set to 0 so that the email is not sent. Otherwise, the email recipient's inbox may be inundated with 'No Files to Prep' emails.

Encrypted Password

The <sender-password> can be configured with the encrypted attribute set to true, as in

Send Email Command

The send email command is used to test sending an email using your mail server credentials. Before starting, verify with your IT department the mail server credentials otherwise errors will occur.

The send email command is accessed through the lpcommon.jar file and is located in the lib folder (i.e. ../lrm-server-x.x/lib). This command is used to test the configured mail server. Before running this command, you may want to enable the email session debug mode.

In order to run the send email -sse or --send-smtp-email command, you must specify an existing location for the error log.

In addition to the log file, there are 5 other required fields.

SMTP Host denoted by option -sh or --smtp-host

Senders email address denoted by option -es or --email-sender

Email Subject denoted by option -subj or --subject

Email Message denoted by option -msg or --message

Email Recipients denoted by option -r or --recipients

Sending Email with SMTP protocol and no authorization

To test sending an email using the SMTP protocol with no authorization run the following command:

Error Messages

The first step in trouble shooting any email messages is to verify, with your IT department, the mail server credentials.

If you're unable to send an email successfully then you may want to enable the debug mode for the email session. This will provide additional information regarding the progress of the session. Set the debug mode through java options.
After enabling the debug mode, the error messages should provide explicit information regarding the reason for the failure. There are a few error messages that may not be so obvious. These are:

Connection is not successful due to invalid port number:

The default port number will be used when setting up the connection. If you're unable to change the default port number then you'll need to explicitly set it via java options.

Must issue a STARTTLS command first. This error indicates that STARTTLS must be enabled. This error occurs when the protocol is SMTP. You can attempt to fix this error by:

Setting the authorization to SMTPS (connection may require a password)

or

Explicitly setting STARTTLS through the java option mail.smtp.starttls.enable and adding the password to the command line (-ep)