Email notification plugin in Jenkins - Mini Project: Build & Apply

Email notification plugin

📖 Scenario: You are setting up a Jenkins job that sends email notifications after builds. This helps the team know the build status quickly.

🎯 Goal: Build a Jenkins pipeline script that configures email notifications using the Email Extension Plugin.

📋 What You'll Learn

Create a Jenkins pipeline script with a basic structure

Add a configuration variable for the recipient email address

Use the emailext step to send an email notification with build status

Print a confirmation message after sending the email

💡 Why This Matters

🌍 Real World

Teams use Jenkins email notifications to stay informed about build results without checking the Jenkins dashboard constantly.

💼 Career

Knowing how to configure Jenkins email notifications is a common task for DevOps engineers and CI/CD pipeline maintainers.

1

Create basic Jenkins pipeline script

Create a Jenkins pipeline script with a pipeline block and a stage named 'Build' that just echoes 'Building project...'.

Jenkins

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                // Your code here
            }
        }
    }
}

Hint

Use pipeline and stage blocks. Inside steps, use echo to print the message.

2

Add recipient email configuration

Add a variable called recipientEmail at the top of the script and set it to '[e-mail]'.

Jenkins

def recipientEmail = '[e-mail]'

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building project...'
            }
        }
    }
}

// Your code here

Hint

Define recipientEmail before the pipeline block.

3

Add email notification step

Inside the 'Build' stage steps, add an emailext step that sends an email to recipientEmail with subject 'Build Status' and body 'The build has completed.'.

Jenkins

def recipientEmail = '[e-mail]'

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building project...'
                // Your code here
            }
        }
    }
}

Hint

Use the emailext step with named parameters to, subject, and body.

4

Print confirmation after email sent

After the emailext step inside the 'Build' stage steps, add a echo statement that prints 'Email notification sent.'.

Jenkins

def recipientEmail = '[e-mail]'

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                echo 'Building project...'
                emailext(
                    to: recipientEmail,
                    subject: 'Build Status',
                    body: 'The build has completed.'
                )
                // Your code here
            }
        }
    }
}

Hint

Use echo 'Email notification sent.' after the emailext step.

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