Sending Emails - Revision history

Llawson: /* Additional Email Configuration */

2021-12-07T16:56:37Z

Additional Email Configuration

← Older revision		Revision as of 16:56, 7 December 2021
Line 52:		Line 52:
	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.		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		* '''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~~.		* '''notify-changes-email-interval''' - By default, the ''Notification'' email interval is set to 1 (every day) and is also dependent on how often the Jenkins Notification job is run. If no notification email is desired then set the interval to a number > 365.
	* '''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~~.		* '''late-kits-email-interval''' - By default, the ''Late Prep Kits'' email interval is set to 1 (every day) but is dependent on the number of days late and on how often the Jenkins Notification job is run. If no late kit email is desired then set the interval to a number > 365.
	* '''number-days-late''' - By default, a prep kit is deemed late if it is 7 days late.		* '''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.		* '''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.

Rdaly at 23:18, 18 November 2019

2019-11-18T23:18:14Z

← Older revision		Revision as of 23:18, 18 November 2019
Line 10:		Line 10:

	=== Location of the global email configuration file ===		=== Location of the global email configuration file ===
	The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required. For example, if a specific project requires a different email sender then is defined at the global level, then copy the global email config file to the project level and make the required changes.		The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>/config</code>''') depending on the level of granularity required. For example, if a specific project requires a different email sender then is defined at the global level, then copy the global email config file to the project level and make the required changes.

	=== Email Credentials Configuration ===		=== Email Credentials Configuration ===

Llawson: /* Location of the global email configuration file */

2019-11-18T17:49:33Z

Location of the global email configuration file

← Older revision		Revision as of 17:49, 18 November 2019
Line 10:		Line 10:

	=== Location of the global email configuration file ===		=== Location of the global email configuration file ===
	The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required.		The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required. For example, if a specific project requires a different email sender then is defined at the global level, then copy the global email config file to the project level and make the required changes.

	=== Email Credentials Configuration ===		=== Email Credentials Configuration ===

Llawson: /* Location of the global email configuration file */

2019-11-18T17:45:18Z

Location of the global email configuration file

← Older revision		Revision as of 17:45, 18 November 2019
Line 10:		Line 10:

	=== Location of the global email configuration file ===		=== Location of the global email configuration file ===
	The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder (('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required.		The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required.

	=== Email Credentials Configuration ===		=== Email Credentials Configuration ===

Llawson: /* config_email_global.xml */

2019-11-18T17:44:17Z

config_email_global.xml

← Older revision		Revision as of 17:44, 18 November 2019
Line 1:		Line 1:
	== config_email_global.xml ==		== config_email_global.xml ==
	File '''<code>config_email_global.xml</code>''' 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 '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder~~.		File '''<code>config_email_global.xml</code>''' is the configuration file for setting up the sender's email credentials for all emails that are sent by the LRM process.

	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.		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.
Line 8:		Line 8:
	* interval between the sending of status emails		* interval between the sending of status emails
	* flag indicating whether to send out the 'No Files to Prep' email		* flag indicating whether to send out the 'No Files to Prep' email

			=== Location of the global email configuration file ===
			The default location for this file is the '''<code><HOME>/Lingoport_Data/L10nStreamlining/config</code>''' folder. As with other LRM config files, this file can be moved to either the group's config folder ('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/config</code>''') or the project's config folder (('''<code><HOME>/Lingoport_Data/L10nStreamlining/<group name>/projects/<project name>config</code>''') depending on the level of granularity required.

	=== Email Credentials Configuration ===		=== Email Credentials Configuration ===

Llawson: /* Sending Email with SMTP protocol and no authorization */

2017-09-11T21:17:00Z

Sending Email with SMTP protocol and no authorization

← Older revision		Revision as of 21:17, 11 September 2017
Line 125:		Line 125:
	* Authorization `mail.smtp.auth` is set to `false`		* Authorization `mail.smtp.auth` is set to `false`

	If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#~~Send_Email_Error_Messages~~\|~~Send~~ Email Error Messages]].		If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#Error_Messages\|Email Error Messages]].

	=== Sending Email with SMTP authorization ===		=== Sending Email with SMTP authorization ===

Llawson: /* Sending Email with SMTP authorization */

2017-09-11T21:16:44Z

Sending Email with SMTP authorization

← Older revision		Revision as of 21:16, 11 September 2017
Line 135:		Line 135:
	* Authorization `mail.smtp.auth` is set to `true`		* Authorization `mail.smtp.auth` is set to `true`

	If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#~~Send_Email_Error_Messages~~\|~~Send~~ Email Error Messages]].		If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#Error_Messages\|Email Error Messages]].

	=== Sending Email with SMTPS protocol ===		=== Sending Email with SMTPS protocol ===

Llawson: /* Sending Email with SMTPS protocol */

2017-09-11T21:16:29Z

Sending Email with SMTPS protocol

← Older revision		Revision as of 21:16, 11 September 2017
Line 145:		Line 145:
	* Authorization `mail.smtp.auth` is set to `false`		* Authorization `mail.smtp.auth` is set to `false`

	If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#Error_Messages\|~~Send~~ Email Error Messages]].		If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#Error_Messages\|Email Error Messages]].

	=== Error Messages ===		=== Error Messages ===

Llawson: /* Sending Email with SMTPS protocol */

2017-09-11T21:16:13Z

Sending Email with SMTPS protocol

← Older revision		Revision as of 21:16, 11 September 2017
Line 145:		Line 145:
	* Authorization `mail.smtp.auth` is set to `false`		* Authorization `mail.smtp.auth` is set to `false`

	If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#~~Send_Email_Error_Messages~~\|Send Email Error Messages]].		If errors occurs then you'll need to change your email send options. For error examples see [[Sending_Emails#Error_Messages\|Send Email Error Messages]].

	=== Error Messages ===		=== Error Messages ===

Llawson: /* Additional Email Configuration */

2017-09-11T17:29:09Z

Additional Email Configuration

@@ Line 53: / Line 53: @@
 * '''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.
 == Java Options for sending emails ==