Testing

beforeEach(() => Mail.fake());
afterEach(() => Mail.restore());

it('sends a welcome email on signup', async () => {
  await registerUser({ name: 'John', email: 'john@example.com' });

  Mail.assertSent(WelcomeEmail, (mail) => mail.hasTo('john@example.com'));
});

jest.mock('nodemailer', () => ({
  createTransport: jest.fn().mockReturnValue({
    sendMail: jest.fn().mockResolvedValue({ messageId: 'test-id' }),
  }),
}));

BEFORE                                     AFTER
──────────────────────────────────────     ──────────────────────────────────────
jest.mock('nodemailer', ...)               Mail.fake()
sendMail.mock.calls[0][0].to              mail.hasTo('user@example.com')
no assertion on Mailable class            Mail.assertSent(WelcomeEmail)
breaks when provider changes              works with any provider

import { MailFake, AssertableMessage } from 'laramail/testing';

import { Mail } from 'laramail';

beforeEach(() => {
  Mail.fake();    // All emails will be stored, not sent
});

afterEach(() => {
  Mail.restore(); // Restore real mail system
});

// Assert WelcomeEmail was sent
Mail.assertSent(WelcomeEmail);

// Assert with conditions
Mail.assertSent(WelcomeEmail, (mail) => {
  return mail.hasTo('user@example.com') && mail.subjectContains('Welcome');
});

// Assert sent exactly 2 times
Mail.assertSentCount(WelcomeEmail, 2);

// Assert a specific mailable was NOT sent
Mail.assertNotSent(PasswordResetEmail);

// Assert nothing was sent at all
Mail.assertNothingSent();

// Assert WelcomeEmail was queued
Mail.assertQueued(WelcomeEmail);

// Assert with conditions
Mail.assertQueued(WelcomeEmail, (mail) => mail.hasTo('user@example.com'));

// Assert queued exactly once
Mail.assertQueuedCount(WelcomeEmail, 1);

// Assert nothing was queued
Mail.assertNothingQueued();

// Get all sent WelcomeEmails
const messages = Mail.sent(WelcomeEmail);

// Inspect the first one
const first = messages[0];
console.log(first.getTo());      // ['user@example.com']
console.log(first.getSubject()); // 'Welcome, John!'

const fake = Mail.fake();

// First 2 sends will return { success: false }
fake.simulateFailures(2);

// Test failover behavior...

fake.resetFailures(); // Stop simulating failures
fake.clear();         // Reset all state

import { Mail, Mailable } from 'laramail';

class WelcomeEmail extends Mailable {
  constructor(public userName: string) {
    super();
  }

  build() {
    return this
      .subject(`Welcome, ${this.userName}!`)
      .html(`<h1>Hello ${this.userName}!</h1>`)
      .from('noreply@example.com');
  }
}

class PasswordResetEmail extends Mailable {
  constructor(public resetUrl: string) {
    super();
  }

  build() {
    return this
      .subject('Reset Your Password')
      .html(`<a href="${this.resetUrl}">Reset</a>`);
  }
}

describe('User Registration', () => {
  beforeEach(() => {
    Mail.fake();
  });

  afterEach(() => {
    Mail.restore();
  });

  it('sends welcome email on registration', async () => {
    // Application code that sends email
    await Mail.to('john@example.com').send(new WelcomeEmail('John'));

    // Assertions
    Mail.assertSent(WelcomeEmail);
    Mail.assertSent(WelcomeEmail, (mail) => {
      return mail.hasTo('john@example.com') &&
             mail.hasSubject('Welcome, John!') &&
             mail.hasFrom('noreply@example.com') &&
             mail.htmlContains('Hello John');
    });
    Mail.assertSentCount(WelcomeEmail, 1);
    Mail.assertNotSent(PasswordResetEmail);
  });

  it('does not send email when validation fails', async () => {
    // Code that doesn't send email
    Mail.assertNothingSent();
  });

  it('queues welcome email for background sending', async () => {
    await Mail.to('john@example.com').queue(new WelcomeEmail('John'));

    Mail.assertQueued(WelcomeEmail);
    Mail.assertQueued(WelcomeEmail, (mail) => mail.hasTo('john@example.com'));
    Mail.assertNothingSent(); // Queued, not sent
  });
});

Mail.fake();
Mail.alwaysTo('staging@example.com'); // ignored in fake mode

await Mail.to('user@example.com').send(new WelcomeEmail());
Mail.assertSent(WelcomeEmail, (m) => m.hasTo('user@example.com')); // passes