Fork us on GitHub
×
Find plugins

Mailer1.18Minimum Jenkins requirement: 1.625.3ID: mailer

Installs: 131164
Last released: 5 months ago

Maintainers
andresrc

Plugin Information


This plugin allows you to configure email notifications for build results. This is a break-out of the original core based email component.

Configuration

In order to be able to send E-Mail notifications mail server configuration must be introduced in the Manage Jenkins page,  E-mail Notification section. Available options are:

  • SMTP server: Name of the mail server. If empty the system will try to use the default server (which is normally the one running on localhost). Jenkins uses JavaMail for sending out e-mails, and JavaMail allows additional settings to be given as system properties to the container. See this document for possible values and effects.
  • Default user e-mail suffix: If your users' e-mail addresses can be computed automatically by simply adding a suffix, then specify that suffix if this field. Otherwise leave it empty. Note that users can always override the e-mail address selectively. For example, if this field is set to @acme.org, then user foo will by default get the e-mail address foo@acme.org.

There are some advanced options as well:

  • Use SMTP Authentication: check this option to use SMTP authentication when sending out e-mails. If your environment requires the use of SMTP authentication, specify the user name and the password in the fields shown when this option is checked.
  • Use SSL: Whether or not to use SSL for connecting to the SMTP server. Defaults to port 465. Other advanced configurations can be done by setting system properties. See this document for possible values and effects.
  • SMTP Port: Port number for the mail server. Leave it empty to use the default port for the protocol (465 if using SSL, 25 if not).
  • Reply-To Address: Address to include in the Reply-To header. Up to version 1.16, only one address is allowed, starting in version 1.17 more than one can be used.
  • Charset: character set to use to construct the message.

In order to test the configuration, you can check the Test configuration by sending test e-mail checkbox, provide a destination address at the Test e-mail recipient field and clicking the Test configuration button.

Usage

E-Mail notifications are configured in jobs by adding an E-mail notification Post-build Action. If configured, Jenkins will send out an e-mail to the specified recipients when a certain important event occurs:

  1. Every failed build triggers a new e-mail.
  2. A successful build after a failed (or unstable) build triggers a new e-mail, indicating that a crisis is over.
  3. An unstable build after a successful build triggers a new e-mail, indicating that there's a regression.
  4. Unless configured, every unstable build triggers a new e-mail, indicating that regression is still there.

The Recipients field must contain a whitespace or comma-separated list of recipient addresses. May reference build parameters like $PARAM.

Additional options include:

  • Send e-mail for every unstable build: if checked, notifications will be sent for every unstable build and not only int first build after a successful one.
  • Send separate e-mails to individuals who broke the build: if checked, the notification e-mail will be sent to individuals who have committed changes for the broken build (by assuming that those changes broke the build).
    If e-mail addresses are also specified in the recipient list, then both the individuals as well as the specified addresses get the notification e-mail. If the recipient list is empty, then only the individuals will receive e-mails.

Changelog

Version 1.18 (Sep 4 2016)

  • Use the new display-url-api for user facing page links
  • Move i18n messages to own package namespace.

Version 1.17 (Apr 20 2016)

Version 1.16 (Oct 29 2015)

  • Fixed some findbugs warnings
  • Fix an encoding issue for the french locale
  • Made the plugin buildable with jdk 8

Version 1.15 (Feb 4 2015)

  • issue #26758 Charset is ignored (and incorrect) in MimeMessageBuilder

Version 1.14 (Feb 2 2015)

  • issue #26606 Recipient list tokenizer not including comma delim

Version 1.13 (Jan 23 2015)

  • issue #23074 Add convenience function for creating a standard MimeMessage

Version 1.12 (Nov 06 2014)

  • Better format for the X-Jenkins-Job header.

Version 1.12-beta-1 (Aug 25 2014)

Version 1.11 (Aug 18 2014)

Version 1.10 (Aug 06 2014)

  • SECURITY-152: plaintext password vulnerability.

Version 1.9 (Jul 08 2014)

  • New extension point in mailer-plugin to exclude email recipients
  • Mail resolvers return emails from user configurations if defined (JENKINS-19433)
  • Suppress errors in MailResolvers to prevent their impact on external callers (JENKINS-23256)
  • Prevent NullPointerException during the creation of failure e-mails (JENKINS-22695)

Version 1.8 (Dec 17 2013)

  • Moved help files from Jenkins core (forgotten after split of plugin).

Version 1.7 (Dec 16 2013)

  • NullPointerException from MailSender.createEmptyMail (JENKINS-20954)

Version 1.6 (Dec 05 2013)

  • Form data binding fix to work with newer Jenkins versions (JENKINS-20226)
  • Never wait for a prior build to complete merely to set a more accurate mail subject (JENKINS-20867)
ArchivesGet past versions
Labels
This plugin has no labels
Open Issues

See here for any open issues for this plugin.