cymap

cymap

Enables basic IMAP functionalities in Cypress. The point of the plugin is to make email content testing easy.

Install

npm i -D cymap

Import cymap tasks in cypress.config.js. and put cymapTasks object in on task.

const { defineConfig } = require("cypress");
const cymapTasks = require("cymap/src/cymapTasks")
module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on("task",{
        ...cymapTasks
      })
      // implement node event listeners here
    },
  },
});

Import cymap index in e2e.js

// Import commands.js using ES2015 syntax:
import './commands'
import "cymap/src/index"

Use

Functions

Set configuration data

cy.setConnectionConfig( {
        password:"socadscjfa",
        user:"[e-mail]",
        host:'imap.gmail.com',
        port:993,
        tls:true,
        tlsOptions: { rejectUnauthorized: false }
})

Needs to be called in before each.

Create connection

cy.createConnection()

Implicitly called inside the email functions.

Destroy connection

cy.destroyConnection()

Implicitly called inside the email functions.

Fetch all mail

cy.getAllMail()

Fetches all mail from the INBOX

Delete all mail

cy.deleteAllMail()

Deletes all mail from the INBOX. For gmail the mail is moved to Waste box

Get email by index

cy.getEmailByIndex(1)

Fetches email by index top down. Top email in the INBOX is under index 1.

Delete email by index

cy.deleteEmailByIndex(1)

Deletes email by index top down. Top email in the INBOX is under index 1.

cy.pasteHtml(html)

Pastes HTML to the DOM

Email

Email body example:

{
    "attachments": [],
    "headers": {},
    "headerLines": [...],
    "html": "<p>Hello World </p>",
    "text": "Hello World",
    "textAsHtml": "<p>Hello World</p>",
    "subject": "Hello World",
    "date": "2024-04-30T16:15:16.000Z",
    "to": {
        "value": [
            {
                "address": "[e-mail]",
                "name": ""
            }
        ],
        "html": "<span class=\"mp_address_group\"><a href=\"mailto:[e-mail]\" class=\"mp_address_email\">[e-mail]</a></span>",
        "text": "[e-mail]"
    },
    "from": {
        "value": [
            {
                "address": "[e-mail]",
                "name": ""
            }
        ],
        "html": "<span class=\"mp_address_group\"><a href=\"mailto:[e-mail]\" class=\"mp_address_email\">[e-mail]</a></span>",
        "text": "[e-mail]"
    },
    "messageId": "<[e-mail]>"
}

Examples

Fetch all mail

describe('tests getAllMail function', () => {
  before("Set configs and add mail", ()=>{
    cy.setConnectionConfig(config)
  })

  it('returns parsed body', ()=>{
    cy.getAllMail().then(mail=>{
      expect(mail.length).to.eq(4)
      mail.forEach(email=>{
        expect(email[0].subject).to.contain("Hello World")
      })
    })
  })
})

Fetch a mail and paste it to dom

 before("Set configs and add mail", ()=>{
    cy.setConnectionConfig(config)
  })

  it('returns parsed body', ()=>{
    cy.getEmailByIndex().then(email=>{
        cy.pasteHtml(email.html)
        cy.contains("Hello World").should("be.visible")
    })
  })

Delete all mail

before("Set configs and add mail", ()=>{
    cy.setConnectionConfig(config)
})

it('returns parsed body', ()=>{
    cy.deleteAllMail().then(isDeleted=>{
       cy.expect(isDeleted).to.eq(true)
    })
})

Delete email by index

before("Set configs and add mail", ()=>{
    cy.setConnectionConfig(config)
})

it('returns parsed body', ()=>{
    cy.deleteEmailByIndex(1).then(isDeleted=>{
       cy.expect(isDeleted).to.eq(true)
    })
})

Contributors

Filip Cica

TODO

waitForEmail()