Is your proposal related to a problem?

I believe a lot of this could be prevented by integrating emails into current e2e test flows.

There are many existing features that would greatly benefit from this, e.g. password reset, email verification, opt-in bookings, reminders, confirmations, etc. But also proposed features such as #8007.

Many different attempts to use emails in tests have already been made, this is merely the proposal of yet another way.

Current ideas

• querying the db

  cal.com/apps/web/playwright/auth/forgot-password.e2e.ts

  Lines 21 to 25 in 65384d7

  	await page.waitForSelector("text=Reset link sent");
  	// As a workaround, we query the db for the last created password request
  	// there should be one, otherwise we throw
  	const { id } = await prisma.resetPasswordRequest.findFirstOrThrow({

• using global vars

  cal.com/apps/web/playwright/integrations.e2e.ts

  Lines 138 to 144 in 65384d7

  	await page.waitForSelector("[data-testid=success-page]");
  	// Make sure we're navigated to the success page
  	await expect(page.locator("[data-testid=success-page]")).toBeVisible();
  	expect(global.E2E_EMAILS?.length).toBe(2);
  	expect(
  	global.E2E_EMAILS?.every((email) => (email.text as string).includes(`https://zoom.us/j/${meetingId}`))
  	).toBe(true);

• using mailhog + api test: email verification flow #9437 chore: mailhog #10521
  

Problems

• flaky tests
• non-e2e
• bypasses test isolation
• untested key features
• unmaintained software written in Go

Describe the solution you'd like

await bookFirstAvailable(page)
const email = await emails.waitForOne(hostEmailAddress)
await email.clickCta()
await expect(bookingConfirmedLocator).toBeVisible()

Key features:

• test isolation -> fully parallel support
• simple api that "just works"
• minimal or NO changes to existing code

Describe alternatives you've considered

• external APIs / cloud offerings
• mailhog & co
• existing packages

I believe all of these are incomplete, cumbersome so extend, or have other issues that make them unworkable.

Proposal

PR with working examples at #10560