The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Email Extension Plugin

emailext: Extended Email

Step for sending email via the email-ext plugin.
  • subject
    • Type: String
  • body
    • Type: String
  • attachLog (optional)
    • Type: boolean
  • attachmentsPattern (optional)
    • Type: String
  • compressLog (optional)
    • Type: boolean
  • from (optional)
    • Type: String
  • mimeType (optional)
    • Type: String
  • postsendScript (optional)
    • Type: String
  • presendScript (optional)
    • Type: String
  • recipientProviders (optional)
      Array/List
      Nested Choice of Objects
    • $class: 'CulpritsRecipientProvider'
    • Sends email to the list of users who committed a change since the last non-broken build till now. This list at least always include people who made changes in this build, but if the previous build was a failure it also includes the culprit list from there.
      • $class: 'DevelopersRecipientProvider'
      • Sends email to all the people who caused a change in the change set.
        • $class: 'FailingTestSuspectsRecipientProvider'
        • Sends email to the list of users suspected of causing a unit test to begin failing. This list includes committers and requestors of the build where the test began to fail, and those for any consecutive failed builds prior to the build in which the test began to fail.
          Build Number 1 2 3 4 5
          Requestor Alice Alice
          Committers Bob
          Clay
          Clay
          Dan
          Bob
          Ed
          Ed
          foo Failed Failed Passed N/A Failed
          bar Failed Failed Passed N/A Passed
          baz Passed Failed Failed N/A Passed
          qux Passed Passed Failed N/A Passed
          new N/A Failed
          Suspects Alice (foo, bar) Alice (foo, bar)
          Bob (baz)
          Clay (baz)
          Bob (baz)
          Clay (baz, qux)
          Dan (qux)
          N/A
          (build failed)
          Alice (foo, new)
          Bob (foo, new)
          Ed (foo, new)
          • $class: 'FirstFailingBuildSuspectsRecipientProvider'
          • Sends email to the list of users suspected of causing the build to begin failing.
            • $class: 'ListRecipientProvider'
            • Sends email to the list of recipients defined in the "Project Recipient List."
              • $class: 'RequesterRecipientProvider'
              • Sends email to the user who initiated the build.
                • $class: 'UpstreamComitterRecipientProvider'
                • Sends email to the list of users who committed changes in upstream builds that triggered this build.
                • replyTo (optional)
                  • Type: String
                • to (optional)
                  • Type: String

                emailextrecipients: Extended Email Recipients

                • recipientProviders
                    Array/List
                    Nested Choice of Objects
                  • $class: 'CulpritsRecipientProvider'
                  • Sends email to the list of users who committed a change since the last non-broken build till now. This list at least always include people who made changes in this build, but if the previous build was a failure it also includes the culprit list from there.
                    • $class: 'DevelopersRecipientProvider'
                    • Sends email to all the people who caused a change in the change set.
                      • $class: 'FailingTestSuspectsRecipientProvider'
                      • Sends email to the list of users suspected of causing a unit test to begin failing. This list includes committers and requestors of the build where the test began to fail, and those for any consecutive failed builds prior to the build in which the test began to fail.
                        Build Number 1 2 3 4 5
                        Requestor Alice Alice
                        Committers Bob
                        Clay
                        Clay
                        Dan
                        Bob
                        Ed
                        Ed
                        foo Failed Failed Passed N/A Failed
                        bar Failed Failed Passed N/A Passed
                        baz Passed Failed Failed N/A Passed
                        qux Passed Passed Failed N/A Passed
                        new N/A Failed
                        Suspects Alice (foo, bar) Alice (foo, bar)
                        Bob (baz)
                        Clay (baz)
                        Bob (baz)
                        Clay (baz, qux)
                        Dan (qux)
                        N/A
                        (build failed)
                        Alice (foo, new)
                        Bob (foo, new)
                        Ed (foo, new)
                        • $class: 'FirstFailingBuildSuspectsRecipientProvider'
                        • Sends email to the list of users suspected of causing the build to begin failing.
                          • $class: 'ListRecipientProvider'
                          • Sends email to the list of recipients defined in the "Project Recipient List."
                            • $class: 'RequesterRecipientProvider'
                            • Sends email to the user who initiated the build.
                              • $class: 'UpstreamComitterRecipientProvider'
                              • Sends email to the list of users who committed changes in upstream builds that triggered this build.

                              Was this page helpful?

                              Please submit your feedback about this page through this quick form.

                              Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

                                  


                              See existing feedback here.