9

The Problem

I am using Jenkins with the email-ext plugin to send HTML formatted emails to several recipient groups (distribution lists).

When configuring the list of recipients I have used the following formats:

"Development" <dev@mysite.com>, "Software QA" <qa@mysite.com>, "Project Management" <pmo@mysite.com>

OR without quotes …

Development <dev@mysite.com>, Software QA <qa@mysite.com>, Project Management <pmo@mysite.com>

Using these configurations Jenkins will only email the initially listed recipient.

Update

The behavior appears to be the same using only the email addresses, and no friendly names.

dev@mysite.com, qa@mysite.com, pmo@mysite.com

The Question

Is it possible to use these friendly names when sending mails from email-ext, or have I made an assumption which turns out inaccurate?

I couldn't find documentation indicating either way.

Environment

Jenkins: 2.57
Email-ext: 2.57.2

Community
  • 1
  • 1
Chris Giddings
  • 697
  • 2
  • 7
  • 20

3 Answers3

9

The Answer

As it turns out, some of the email addresses in the recipients list were also listed in the Jenkins/Email-Ext "Excluded Recipients" list.

This list is found under Manage Jenkins >> Configure System >> Extended E-mail Notification >> Excluded Recipients

There is no output from email-ext or the job's console to indicate this was the case, so it took time to track down.

I may open an enhancement request with the plugin owner to add some console output related to indicating whether excluded recipients are configured on the job.

Conclusion

Just to be clear: email-ext DOES support using friendly display names in the following formats:

Development <dev@mysite.com> or "Development" <dev@mysite.com>

Multiples are supported as the usual comma separated list.

Chris Giddings
  • 697
  • 2
  • 7
  • 20
  • Nice catch, more precise than my answer. +1 – VonC Apr 28 '17 at 15:48
  • I'm using pipeline style for my job, is there a way to configure a recipients list ? – Ghassen Aug 20 '19 at 14:44
  • @ghassen I am unfamiliar with the pipelines options as we currently use Jenkins's UI for most or all configuration, as is the case here. However, you should be able to configure default recipients under Manage Jenkins >> Configure System. We just wanted more granular control of who received notifications. We have also switched to a chat ops integration (Slack, MS Teams, etc) vs sending emails. – Chris Giddings Aug 24 '19 at 14:31
  • On the day I'm writing this there's a bug that when your recipient list has only one e-mail it will slice this recipient based on the spaces. I've created pull request to fix thix: https://github.com/jenkinsci/email-ext-plugin/pull/395 but for now to workaround that you need to add `,` comma at the end of the e-mail address. Instead of `Name Surname ` write `Name Surname ,`. That would be nice to have it in accepted answer as I looked for it quite long. – jarzyn Sep 23 '22 at 08:46
6

I had to do this as well with friendly names to pick up some email lists from jenkins. Below is the syntax that worked for me. I declared primaryOwnerEmail and secondaryOwners [list of emails] and pulled them in the 'to:' line below.

    stage ("Notify Developers of Success"){
        env.ForEmailPlugin = env.WORKSPACE
        emailext attachmentsPattern: 'Checkmarx\\Reports\\*.pdf',
         to: "${primaryOwnerEmail},${secondaryOwners}",
         subject: "${env.JOB_NAME} - (${env.BUILD_NUMBER}) Finished Successfuly!",
         body: "Check console output at  ${env.BUILD_URL} to view the results"
    }
DevOps Steve
  • 61
  • 1
  • 1
0

If the JENKINS Email-ext plugin supported an extended email format, with a display name, that would be as 

Project Management <pmo@mysite.com>

Yet, emailext/recipients/EmailRecipientUtilsTest.java does not show anywhere any display name, which is a strong case for its non support.

VonC
  • 1,262,500
  • 529
  • 4,410
  • 5,250
  • 1
    Simply changing to the following provides the same result: `dev@mysite.com, qa@mysite.com, pmo@mysite.com` – Chris Giddings Apr 28 '17 at 14:24
  • @ChrisGiddings Then you can try and clone/compile the repo source, to see if at least the test class runs correctly. – VonC Apr 28 '17 at 14:31
  • 1
    I think it's too idealistic to say, especially for OSS, that just because there's no test, there's no code that should've been tested :) Pipelines in Jenkins are an afterthought. – Abhijit Sarkar Dec 08 '18 at 01:29