Email notifications in pipelines in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of email notifications in Jenkins pipelines?

Email notifications inform team members about the status of pipeline runs, such as success, failure, or unstable builds, helping them respond quickly.

beginner

Which Jenkins plugin is commonly used to send email notifications in pipelines?

The 'Email Extension Plugin' (emailext) is commonly used to send customizable email notifications in Jenkins pipelines.

intermediate

How do you send a simple email notification in a Jenkins declarative pipeline?

Use the 'emailext' step inside a 'post' block, for example:

post {
  failure {
    emailext(
      subject: "Build Failed",
      body: "The build has failed.",
      to: "[e-mail]"
    )
  }
}

intermediate

What is the difference between 'mail' and 'emailext' steps in Jenkins pipelines?

'mail' is a basic email step with limited features. 'emailext' from the Email Extension Plugin offers more options like attachments, HTML content, and triggers.

beginner

Why is it important to configure SMTP settings in Jenkins for email notifications?

SMTP settings allow Jenkins to connect to an email server to send emails. Without proper SMTP configuration, email notifications will fail.

Which Jenkins pipeline block is best suited for sending email notifications after a build fails?

A stages { stage('Email') { ... } }

B environment { EMAIL = '...' }

C post { failure { ... } }

D agent { label 'email' }

The 'post' block with 'failure' condition runs only when the build fails, making it ideal for failure email notifications.

What plugin provides the 'emailext' step in Jenkins pipelines?

A Email Extension Plugin

B Mailer Plugin

C Slack Notification Plugin

D Git Plugin

'emailext' is provided by the Email Extension Plugin for advanced email notifications.

Which configuration is essential for Jenkins to send emails successfully?

A SMTP server settings

B Git repository URL

C Build timeout

D Agent label

SMTP server settings allow Jenkins to connect to an email server to send notifications.

What is a benefit of using 'emailext' over 'mail' in Jenkins pipelines?

A Requires no configuration

B Supports HTML email content

C Runs builds faster

D Automatically fixes build errors

'emailext' supports HTML content and more customization options than 'mail'.

Where do you typically place email notification steps in a declarative Jenkins pipeline?

A Inside the 'tools' section

B Inside the 'environment' section

C Inside the 'agent' section

D Inside the 'post' section

The 'post' section is designed for actions after build stages, like sending emails on failure or success.

Explain how to configure and use email notifications in a Jenkins pipeline.

Think about Jenkins settings and pipeline script structure.

Describe the difference between the 'mail' and 'emailext' steps in Jenkins pipelines and when to use each.

Consider features and complexity.

Practice

1. What is the main purpose of adding email notifications in Jenkins pipelines?

easy

A. To increase the number of pipeline stages

B. To speed up the pipeline execution

C. To automatically inform team members about pipeline success or failure

D. To reduce the size of the pipeline script

Solution

1. Step 1: Understand the role of email notifications

   Email notifications are used to keep team members informed about the status of the pipeline automatically.

2. Step 2: Identify the correct purpose

   Speeding up execution, increasing stages, or reducing script size are unrelated to email notifications.

3. Final Answer:

   To automatically inform team members about pipeline success or failure -> Option C

4. Quick Check:

   Email notifications = Inform team automatically [OK]

Hint: Email notifications alert teams about pipeline results [OK]

Common Mistakes:

• Thinking email notifications speed up pipelines
• Confusing notifications with pipeline structure changes
• Assuming notifications reduce script size

2. Which Jenkins pipeline syntax correctly sends an email notification only on failure using the post section?

easy

A. post { failure { emailext to: '[e-mail]', subject: 'Build Failed', body: 'Check the logs.' } }

B. post { always { emailext to: '[e-mail]', subject: 'Build Failed', body: 'Check the logs.' } }

C. post { success { emailext to: '[e-mail]', subject: 'Build Failed', body: 'Check the logs.' } }

D. post { failure { mail to: '[e-mail]', subject: 'Build Failed', body: 'Check the logs.' } }

Solution

1. Step 1: Identify correct post condition for failure

   The failure block runs only when the pipeline fails, which is correct here.

2. Step 2: Check the email sending syntax

   emailext is the correct step for sending emails with extended options; mail is less common and may lack features.

3. Final Answer:

   post { failure { emailext to: '[e-mail]', subject: 'Build Failed', body: 'Check the logs.' } } -> Option A

4. Quick Check:

   Failure + emailext = Correct syntax [OK]

Hint: Use 'post { failure { emailext ... } }' for failure emails [OK]

Common Mistakes:

• Using 'always' instead of 'failure' for failure-only emails
• Using 'success' block for failure notifications
• Using 'mail' instead of 'emailext' without plugin support

3. Given this Jenkins pipeline snippet, what will happen when the build succeeds?

post {
  success {
    emailext to: '[e-mail]', subject: 'Build Success', body: 'Good job!'
  }
  failure {
    emailext to: '[e-mail]', subject: 'Build Failed', body: 'Please check.'
  }
}

medium

A. Both success and failure emails are sent

B. An email with subject 'Build Failed' is sent to [e-mail]

C. No email is sent

D. An email with subject 'Build Success' is sent to [e-mail]

Solution

1. Step 1: Understand post conditions for success

   The success block triggers only when the build finishes successfully.

2. Step 2: Identify which email is sent on success

   The email with subject 'Build Success' is sent to '[e-mail]' in the success block.

3. Final Answer:

   An email with subject 'Build Success' is sent to [e-mail] -> Option D

4. Quick Check:

   Success block sends success email [OK]

Hint: Success block emails only on successful builds [OK]

Common Mistakes:

• Confusing failure email with success email
• Thinking no email is sent on success
• Assuming both emails send regardless of build result

4. You wrote this Jenkins pipeline snippet to send failure emails, but no emails are sent on failure:

post {
  failure {
    mail to: '[e-mail]', subject: 'Build Failed', body: 'Fix it!'
  }
}

What is the likely problem?

medium

A. The 'failure' block should be 'always' to send emails on failure

B. The 'mail' step requires proper configuration; use 'emailext' instead

C. The 'to' field must be inside quotes like "to: '[e-mail]'"

D. The 'body' field is missing a required parameter

Solution

1. Step 1: Check the email step used

   The mail step is basic and may not work without proper setup; emailext from the Email Extension plugin is recommended for reliable emails.

2. Step 2: Confirm correct step for failure emails

   Using emailext ensures emails are sent with more options and better support in pipelines.

3. Final Answer:

   The 'mail' step requires proper configuration; use 'emailext' instead -> Option B

4. Quick Check:

   Use emailext for failure emails [OK]

Hint: Use 'emailext' not 'mail' for reliable email notifications [OK]

Common Mistakes:

• Using 'mail' without proper configuration
• Confusing 'failure' with 'always' block
• Incorrect quoting of parameters

5. You want to send an email notification only if the build fails and the failure is caused by a test failure. Which Jenkins pipeline snippet correctly implements this logic?

hard

A. post {
failure {
script {
if (currentBuild.rawBuild.getLog(100).any { it.contains('TEST-FAILURE') }) {
emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!'
}
}
}
}

B. post {
always {
emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!'
}
}

C. post {
failure {
emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!'
}
}

D. post {
success {
emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!'
}
}

Solution

1. Step 1: Understand the requirement for conditional email on test failure

   The email should send only if the build fails and the failure is due to test failures, so a condition checking the build log is needed.

2. Step 2: Analyze the options for conditional logic

   post { failure { script { if (currentBuild.rawBuild.getLog(100).any { it.contains('TEST-FAILURE') }) { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } } } uses a script block to check the build log for 'TEST-FAILURE' text before sending the email, matching the requirement exactly.

3. Step 3: Exclude other options

   post { always { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } sends email always, ignoring failure condition. post { failure { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } sends email on any failure, not just test failures. post { success { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } sends email on success, which is incorrect.

4. Final Answer:

   post { failure { script { if (currentBuild.rawBuild.getLog(100).any { it.contains('TEST-FAILURE') }) { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } } } -> Option A

5. Quick Check:

   Conditional script in failure block = post { failure { script { if (currentBuild.rawBuild.getLog(100).any { it.contains('TEST-FAILURE') }) { emailext to: '[e-mail]', subject: 'Test Failure', body: 'Tests failed!' } } } } [OK]

Hint: Use script block to check logs inside failure post section [OK]

Common Mistakes:

• Sending emails on all failures without checking cause
• Using 'always' or 'success' blocks incorrectly
• Not using script block for conditional logic