Email read (opened seen settings)

Effortlessly manage read status with MailSlurp: mark emails as read or unread manually or fetch only unread ones with the unreadOnly flag.

  • Table of contents

With MailSlurp received emails are marked as unread when they are processed. Unread emails are bold in the user interface and can be fetched with the unreadOnly flag with many wait for methods. Sometimes you may want to control the read behavior manually - for this you can use the email controller markAsRead method and pass a boolean:

Javascript example

You can use the markAsRead API method with any framework. Here is an example using the Javascript client.

import { MailSlurp } from 'mailslurp-client';

const timeout = 120001;
const mailslurp = new MailSlurp({ apiKey: process.env.apiKey });

describe("email read", () => {
test("can receive unread emails and set the read status", async () => {
const inbox = await mailslurp.createInbox()
await mailslurp.sendEmail(!,{ to: [inbox.emailAddress!], subject: 'hello'})
// can get an unread email
const emails = await mailslurp.waitForEmailCount(2,, timeout, true)

        // fetching email directly marks as read
        const email = await mailslurp.getEmail(emails[1].id!)

        // can set read value to true or false
        const emailPreview = await mailslurp.emailController.markAsRead(!, false)

Dashboard control

You can also set email seen settings on the email page using the settings dropdown.