Welcome to our service
'\n });\n\n expect(email).toHaveEmailSubject(/Welcome/);\n expect(email).toHaveHtmlContent('our service');\n });\n});\n```\n\n## Custom Matchers\n\n### Basic Email Assertions\n\n```typescript\nexpect(email).toHaveEmailRecipient('user@example.com');\nexpect(email).toHaveEmailSender('noreply@example.com');\nexpect(email).toHaveEmailSubject('Welcome');\nexpect(email).toHaveEmailSubject(/Welcome/); // Regex support\n```\n\n### Content Assertions\n\n```typescript\nexpect(email).toHaveEmailContent('Hello World');\nexpect(email).toHaveHtmlContent('Hello
');\nexpect(email).toHaveTextContent('Plain text');\n```\n\n### Template Assertions\n\n```typescript\nexpect(email).toHaveCompletedTemplate();\nexpect(email).toHaveTemplateVariable('userName', 'John Doe');\nexpect(email).toNotHaveUnreplacedVariables();\n```\n\n### Compliance Assertions\n\n```typescript\nexpect(email).toBeCompliantEmail('US');\nexpect(email).toHaveUnsubscribeLink();\nexpect(email).toHavePhysicalAddress();\n```\n\n### Async Assertions\n\n```typescript\nawait expect(email).toHaveBeenDelivered();\nawait expect(email).toHaveBeenDeliveredWithin(5000);\n```\n\n### Schema Validation\n\n```typescript\nconst schema = {\n type: 'object',\n properties: {},\n required: ['from', 'to', 'subject']\n};\n\nexpect(email).toSatisfyEmailSchema(schema);\n```\n\n## Test Utilities\n\n### Generate Test Emails\n\n```typescript\nimport { generateTestEmail, generateCompliantEmail } from '@bernierllc/vitest-email-testing';\n\n// Basic test email\nconst email = generateTestEmail({\n from: 'sender@example.com',\n subject: 'Custom Subject'\n});\n\n// Compliant email\nconst compliantEmail = generateCompliantEmail('US');\n```\n\n### Email Sender Mocking\n\n```typescript\nimport { createEmailSenderMock } from '@bernierllc/vitest-email-testing';\n\nconst mock = createEmailSenderMock();\nmock.mockSendSuccess({ delay: 100 });\n\n// Test your code\nawait sendEmail('user@example.com');\n\n// Verify\nexpect(mock.send.calls).toHaveLength(1);\n```\n\n### Batch Testing\n\n```typescript\nimport { batchSendEmails } from '@bernierllc/vitest-email-testing';\n\nconst emails = await batchSendEmails(100, (index) =>\n generateTestEmail({ to: `user${index}@example.com` })\n);\n```\n\n## Concurrent Testing\n\n```typescript\ndescribe.concurrent('Email Performance', () => {\n test('send 100 emails', async () => {\n const emails = await batchSendEmails(100, (i) =>\n generateTestEmail({ to: `user${i}@example.com` })\n );\n\n expect(emails).toHaveLength(100);\n });\n});\n```\n\n## Configuration Options\n\n```typescript\nemailTesting({\n smtp: {\n port: 2525,\n host: 'localhost'\n },\n environment: {\n isolation: 'per-test',\n cleanup: 'auto',\n timeout: 30000\n },\n vitest: {\n concurrent: true,\n globalSetup: true,\n snapshotFormat: 'email-optimized'\n },\n watchTemplates: {\n enabled: true,\n patterns: ['templates/**/*.html'],\n rerunTests: true\n }\n})\n```\n\n## API Reference\n\n### Types\n\n- `EmailData` - Email data structure\n- `EmailMatcher` - Email matching criteria\n- `EmailSchema` - Email validation schema\n- `ComplianceRegion` - Compliance region type\n- `EmailTestingConfig` - Plugin configuration\n\n### Functions\n\n- `emailTesting(config?)` - Vitest plugin\n- `installEmailMatchers()` - Install custom matchers\n- `createEmailSenderMock(sender?)` - Create email sender mock\n- `generateTestEmail(overrides?)` - Generate test email\n- `generateCompliantEmail(region?)` - Generate compliant email\n- `waitForCondition(condition, options?)` - Wait for condition\n\n## Integration Documentation\n\n### Integration Status\n\n**Logger:** Not applicable (testing utility)\n**NeverHub:** Not applicable (testing utility)\n\nThis package is a testing utility and does not require runtime integrations with @bernierllc/logger or @bernierllc/neverhub-adapter. It is designed to be a standalone testing tool that works independently of application infrastructure.\n\n### Usage with Other @bernierllc Packages\n\nThis package can be used to test email functionality in any @bernierllc service package:\n\n```typescript\n// Testing @bernierllc/email-service\nimport { describe, test, expect } from 'vitest';\nimport { EmailService } from '@bernierllc/email-service';\nimport { createEmailSenderMock } from '@bernierllc/vitest-email-testing';\n\ndescribe('EmailService', () => {\n test('sends welcome email', async () => {\n const mock = createEmailSenderMock();\n const service = new EmailService({ sender: mock });\n\n await service.sendWelcome('user@example.com');\n\n expect(mock.send.calls[0]).toHaveEmailSubject('Welcome');\n });\n});\n```\n\n### Graceful Degradation\n\nAs a testing utility, this package operates independently and does not depend on external services. All functionality is self-contained within the test environment.\n\n## License\n\nCopyright (c) 2025 Bernier LLC. See LICENSE.md for details.\n","readmeFilename":"README.md"}