Email notification plugin in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Email Notification plugin in Jenkins?

It sends email alerts about build results to specified recipients, helping teams stay informed about build status.

beginner

Which Jenkins section do you configure the Email Notification plugin in?

In the Jenkins system configuration under 'Manage Jenkins' > 'Configure System', you set SMTP server and default email settings.

intermediate

What information is required to set up SMTP in Jenkins Email Notification plugin?

You need the SMTP server address, port, and optionally authentication credentials like username and password.

beginner

How do you specify recipients for email notifications in a Jenkins job?

In the job configuration, under 'Post-build Actions', add 'Editable Email Notification' and enter recipient email addresses.

intermediate

What triggers can you use to send emails with the Email Notification plugin?

You can send emails on build success, failure, unstable builds, or always after a build completes.

Where do you configure the SMTP server for Jenkins Email Notification plugin?

A Manage Plugins

B Manage Jenkins > Configure System

C Job Build History

D Manage Nodes

SMTP settings are configured globally under 'Manage Jenkins' > 'Configure System'.

Which plugin allows sending customizable emails after a Jenkins build?

A Pipeline plugin

B Git plugin

C Email Notification plugin

D Docker plugin

The Email Notification plugin is designed to send emails after builds.

How do you add email recipients for notifications in a Jenkins job?

A In Post-build Actions, add Editable Email Notification

B In Build Triggers, select Email option

C In Source Code Management section

D In Build Environment settings

Recipients are set in the 'Editable Email Notification' section under Post-build Actions.

Which of these is NOT a typical trigger for sending emails in Jenkins Email Notification plugin?

A Build success

B Build failure

C Build unstable

D Code commit

Code commit is not a trigger for email; build results are triggers.

What information is NOT needed to configure SMTP in Jenkins Email Notification plugin?

A Recipient email address

B SMTP port

C SMTP authentication credentials

D SMTP server address

Recipient emails are set per job, not in SMTP configuration.

Explain how to set up email notifications in Jenkins using the Email Notification plugin.

Think about global setup first, then job-specific settings.

Describe common triggers for sending emails with Jenkins Email Notification plugin and why they are useful.

Triggers relate to build outcomes.

Practice

1. What is the main purpose of the Jenkins Email Notification plugin?

easy

A. To deploy applications to servers

B. To automatically send emails about build status

C. To monitor server CPU usage

D. To create new Jenkins jobs

Solution

1. Step 1: Understand the plugin's function

   The Email Notification plugin is designed to send emails automatically when a build finishes.

2. Step 2: Identify the correct purpose

   It helps keep the team informed by sending build status emails without manual effort.

3. Final Answer:

   To automatically send emails about build status -> Option B

4. Quick Check:

   Email Notification plugin = automatic build emails [OK]

Hint: Email plugin = auto send build status emails [OK]

Common Mistakes:

• Confusing with deployment tools
• Thinking it monitors server health
• Assuming it creates jobs

2. Which of the following is the correct syntax to enable email notifications in a Jenkins pipeline script?

easy

A. sendEmail(subject: 'Build Status', body: 'Build completed', to: '[e-mail]')

B. emailNotify(subject: 'Build Status', body: 'Build completed', to: '[e-mail]')

C. emailext(subject: 'Build Status', body: 'Build completed', to: '[e-mail]')

D. notifyEmail(subject: 'Build Status', body: 'Build completed', to: '[e-mail]')

Solution

1. Step 1: Recall Jenkins pipeline email syntax

   The Email Extension plugin uses the emailext step to send emails.

2. Step 2: Match the correct function name and parameters

   Only emailext(subject: 'Build Status', body: 'Build completed', to: '[e-mail]') uses emailext with correct parameters: subject, body, and to.

3. Final Answer:

   emailext(subject: 'Build Status', body: 'Build completed', to: '[e-mail]') -> Option C

4. Quick Check:

   Use emailext for email notifications [OK]

Hint: Use 'emailext' step for Jenkins email notifications [OK]

Common Mistakes:

• Using incorrect function names
• Missing required parameters
• Confusing with other plugins

3. Given this Jenkins pipeline snippet:

pipeline {
  agent any
  stages {
    stage('Build') {
      steps {
        echo 'Building...'
      }
    }
  }
  post {
    failure {
      emailext(
        subject: 'Build Failed',
        body: 'Please check the build logs.',
        to: '[e-mail]'
      )
    }
  }
}

What happens if the build fails?

medium

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

B. No email is sent because the syntax is wrong

C. An email is sent only if the build succeeds

D. The build will retry automatically

Solution

1. Step 1: Analyze the post-failure block

   The post { failure { ... } } block runs only if the build fails.

2. Step 2: Understand the emailext usage

   The emailext step sends an email with the given subject and body to the specified address.

3. Final Answer:

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

4. Quick Check:

   Post failure triggers email = An email with subject 'Build Failed' is sent to [e-mail] [OK]

Hint: Post failure block sends email on build failure [OK]

Common Mistakes:

• Thinking email sends on success
• Assuming syntax error without checking
• Confusing retry with email notification

4. You configured the Email Notification plugin but no emails are sent after build failures. Which is the most likely cause?

medium

A. SMTP server settings are missing or incorrect

B. The Jenkins job has no build steps

C. The build always succeeds

D. The plugin is not installed

Solution

1. Step 1: Check email sending prerequisites

   Jenkins needs correct SMTP server settings to send emails.

2. Step 2: Identify common misconfiguration

   If SMTP settings are missing or wrong, emails won't send even if plugin is configured.

3. Final Answer:

   SMTP server settings are missing or incorrect -> Option A

4. Quick Check:

   SMTP config missing = no emails sent [OK]

Hint: Verify SMTP settings to fix email sending issues [OK]

Common Mistakes:

• Ignoring SMTP configuration
• Assuming plugin auto-configures SMTP
• Thinking build steps affect email sending

5. You want to send an email notification only when the build status changes (e.g., from success to failure or failure to success). Which Email Notification plugin feature should you use?

hard

A. Use the 'Send e-mail for every unstable build' option

B. Use the 'Always send e-mail' option

C. Configure a post-build script to check status manually

D. Enable 'Send e-mail only on status change' in the plugin settings

Solution

1. Step 1: Understand the requirement

   The goal is to send emails only when build status changes, not every build.

2. Step 2: Identify plugin feature for status change

   The Email Notification plugin has an option named 'Send e-mail only on status change' to handle this.

3. Step 3: Compare other options

   Options A and D send emails more frequently; Configure a post-build script to check status manually requires manual scripting.

4. Final Answer:

   Enable 'Send e-mail only on status change' in the plugin settings -> Option D

5. Quick Check:

   Status change emails = enable plugin's status change option [OK]

Hint: Enable 'send only on status change' to reduce email noise [OK]

Common Mistakes:

• Choosing options that send emails every build
• Ignoring built-in plugin features
• Overcomplicating with manual scripts