Introduction to MailDev

MailDev is an open-source tool designed to test your email functionalities in your development and testing environments. It simplifies the email testing process by capturing and displaying emails in a web interface, which is extremely useful for developers. With MailDev, you can easily test email templates, debug email sending issues, and integrate it into your automated testing workflows.

Getting Started with MailDev

Install MailDev globally using npm:

  npm install -g maildev

Start MailDev server:

  maildev

MailDev API Reference

MailDev offers various APIs to interact with emails programmatically. Here’s a rundown of some useful APIs:

1. List Emails

Get a list of all emails:

  
    GET /email
  

Example:

  
    const fetch = require('node-fetch');

    fetch('http://localhost:1080/email')
        .then(res => res.json())
        .then(emails => console.log(emails));
  

2. Retrieve Email by ID

Get a specific email message by ID:

  
    GET /email/:id
  

Example:

  
    fetch('http://localhost:1080/email/{emailId}')
      .then(res => res.json())
      .then(email => console.log(email));
  

3. Delete Email by ID

Delete a specific email by ID:

  
    DELETE /email/:id
  

Example:

  
    fetch('http://localhost:1080/email/{emailId}', { method: 'DELETE' })
        .then(() => console.log('Email deleted'));
  

4. Delete All Emails

Delete all emails:

  
    DELETE /email/all
  

Example:

  
    fetch('http://localhost:1080/email/all', { method: 'DELETE' })
        .then(() => console.log('All emails deleted'));
  

5. Retrieve Email Attachments

Get attachments of a specific email:

  
    GET /email/:id/attachments
  

Example:

  
    fetch('http://localhost:1080/email/{emailId}/attachments')
        .then(res => res.json())
        .then(attachments => console.log(attachments));
  

Example Application Using MailDev

Here’s a simple Node.js application that sends an email using nodemailer and tests it using MailDev:

  
    const nodemailer = require('nodemailer');
    const fetch = require('node-fetch');

    // Create transporter object using SMTP transport
    const transporter = nodemailer.createTransport({
      host: 'localhost',
      port: 1025,
      ignoreTLS: true,
    });

    // Setup email data
    const mailOptions = {
      from: '"Sender" ',
      to: 'receiver@example.com',
      subject: 'Hello',
      text: 'Hello world!',
      html: 'Hello world!',
    };

    // Send email
    transporter.sendMail(mailOptions, (error, info) => {
      if (error) {
        return console.log(error);
      }
      console.log('Message sent: %s', info.messageId);

      // Fetch emails from MailDev
      fetch('http://localhost:1080/email')
        .then(res => res.json())
        .then(emails => console.log('Emails:', emails));
    });
  

Run your MailDev server, and run this Node.js application to see the email being sent and captured by MailDev.

MailDev is a powerful tool that can significantly streamline your email testing workflows. Whether you are testing email notifications, verifying email templates, or integrating email tests in your CI/CD pipeline, MailDev provides a simple, efficient solution.

Hash: 1ec0af1acc2a1413daa544ab483246d98f6f798fadad0e9a46bdb78f78f41504