cypress-email-results

cypress-email-results

Easily email the test results after Cypress is done

Install

Add this plugin as a dev dependency to your Cypress project

# install using NPM
$ npm i -D cypress-email-results
# or using Yarn
$ yarn add -D cypress-email-results

Register the plugin from your cypress/plugins/index.js file

module.exports = (on, config) => {
  require('cypress-email-results')(on, config, {
    email: ['[e-mail]', '[e-mail]'],
  })
}

emailOnSuccess

You can set this plugin to only send an email if the test run has failed

module.exports = (on, config) => {
  require('cypress-email-results')(on, config, {
    email: ['[e-mail]', '[e-mail]'],
    emailOnSuccess: false,
  })
}

dry

You can print the email instead of sending it using the dry option

module.exports = (on, config) => {
  require('cypress-email-results')(on, config, {
    email: ['[e-mail]', '[e-mail]'],
    dry: true,
  })
}

Note: the email client is still initialized.

Using SendGrid

If you use SendGrid as your SMTP server, set the environment variables for the plugin to read, something like:

SENDGRID_HOST=smtp.sendgrid.net
SENDGRID_PORT=465
SENDGRID_USER=...
SENDGRID_PASSWORD=...
SENDGRID_FROM=...

Using non-SendGrid SMTP server

You can create your own smpt transport using nodemailer module.

// create your own SMTP transport
const transport = ...

module.exports = (on, config) => {
  require('cypress-email-results')(on, config, {
    email: ['[e-mail]', '[e-mail]'],
    // pass your transport object
    transport,
  })
}

As long as transport.sendEmail exists, the plugin will try to use it to send an email with results.

Single instance

Important: this plugin only sends the test results from the current Cypress instance. If you are using Cypress parallelization then each test runner will send its portion of the results.

Demo

Set the dry: true option and run npm run demo. To see the demo on CircleCI, run CI=1 CIRCLECI=1 npm run demo.

See also

• plugin cypress-json-results
• Cypress ethereal email example
• presentation Full End-to-End Testing for Your HTML Email Workflows

Small print

Author: Gleb Bahmutov <[e-mail]> © 2022

• @bahmutov
• glebbahmutov.com
• blog
• videos
• presentations
• cypress.tips
• Cypress Advent 2021

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2022 Gleb Bahmutov <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.