@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-mailing/api/index.md

@@ -0,0 +1,404 @@
+---
+title: '@breadstone/archipel-platform-mailing'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# @breadstone/archipel-platform-mailing
+
+## Classes
+
+| Class                                                        | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class.                       |
+| [DeliveryStrategyBase](Class.DeliveryStrategyBase)           | Represents the base class for all email delivery strategies. |
+| [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class.                       |
+| [LogDeliveryStrategy](Class.LogDeliveryStrategy)             | The `LogDeliveryStrategy` class.                             |
+| [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy)     | Delivers emails via the Mailgun API.                         |
+| [MailHealthIndicator](Class.MailHealthIndicator)             | Health indicator for mail service.                           |
+| [MailModule](Class.MailModule)                               | Represents the mail module.                                  |
+| [MailService](Class.MailService)                             | Represents the `MailService` class.                          |
+| [MailTemplateEngine](Class.MailTemplateEngine)               | The `MailTemplateEngine` class.                              |
+| [MailVerificationService](Class.MailVerificationService)     | Represents the `MailVerificationService` class.              |
+| [PostmarkDeliveryStrategy](Class.PostmarkDeliveryStrategy)   | The `PostmarkDeliveryStrategy` class.                        |
+| [ResendDeliveryStrategy](Class.ResendDeliveryStrategy)       | Delivers emails via the Resend API.                          |
+| [SendGridDeliveryStrategy](Class.SendGridDeliveryStrategy)   | Delivers emails via the SendGrid API.                        |
+| [SmtpDeliveryStrategy](Class.SmtpDeliveryStrategy)           | The `SmtpDeliveryStrategy` class.                            |
+| [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) | Represents the base class for template fetch strategies.     |
+
+## Interfaces
+
+| Interface                                                | Description                                                                  |
+| -------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| [IMailEvents](Interface.IMailEvents)                     | Represents the contract of events emitted by the mail domain.                |
+| [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
+
+## Type Aliases
+
+| Type Alias                                         | Description                                   |
+| -------------------------------------------------- | --------------------------------------------- |
+| [MailTemplateFormat](TypeAlias.MailTemplateFormat) | Union type of all supported template formats. |
+
+## Variables
+
+### MAIL_DELIVERY_STRATEGY
+
+```ts
+const MAIL_DELIVERY_STRATEGY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L15)
+
+Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`).
+
+---
+
+### MAIL_DELIVERY_STRATEGY_TOKEN
+
+```ts
+const MAIL_DELIVERY_STRATEGY_TOKEN: typeof MAIL_DELIVERY_STRATEGY_TOKEN;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L11)
+
+---
+
+### MAIL_HOST
+
+```ts
+const MAIL_HOST: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L78)
+
+Mail host checked by the health indicator.
+
+---
+
+### MAIL_MAILGUN_API_KEY
+
+```ts
+const MAIL_MAILGUN_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L49)
+
+API key for the Mailgun delivery service.
+
+---
+
+### MAIL_MAILGUN_DOMAIN
+
+```ts
+const MAIL_MAILGUN_DOMAIN: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L52)
+
+Mailgun domain (e.g. `mg.example.com`).
+
+---
+
+### MAIL_PORT
+
+```ts
+const MAIL_PORT: IConfigKey<number>;
+```
+
+Defined in: [platform-mailing/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L84)
+
+Mail port checked by the health indicator.
+
+---
+
+### MAIL_POSTMARK_API_KEY
+
+```ts
+const MAIL_POSTMARK_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L28)
+
+API key for the Postmark delivery service.
+
+---
+
+### MAIL_RESEND_API_KEY
+
+```ts
+const MAIL_RESEND_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L35)
+
+API key for the Resend delivery service.
+
+---
+
+### MAIL_SENDER_EMAIL
+
+```ts
+const MAIL_SENDER_EMAIL: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L18)
+
+Sender e-mail address shown in the `From` header.
+
+---
+
+### MAIL_SENDGRID_API_KEY
+
+```ts
+const MAIL_SENDGRID_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L42)
+
+API key for the SendGrid delivery service.
+
+---
+
+### MAIL_SMTP_HOST
+
+```ts
+const MAIL_SMTP_HOST: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L59)
+
+SMTP server host.
+
+---
+
+### MAIL_SMTP_PASSWORD
+
+```ts
+const MAIL_SMTP_PASSWORD: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L71)
+
+SMTP authentication password.
+
+---
+
+### MAIL_SMTP_PORT
+
+```ts
+const MAIL_SMTP_PORT: IConfigKey<number>;
+```
+
+Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
+
+SMTP server port.
+
+---
+
+### MAIL_SMTP_SECURE
+
+```ts
+const MAIL_SMTP_SECURE: IConfigKey<boolean>;
+```
+
+Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
+
+Whether the SMTP connection uses TLS.
+
+---
+
+### MAIL_SMTP_USER
+
+```ts
+const MAIL_SMTP_USER: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L68)
+
+SMTP authentication username.
+
+---
+
+### MAIL_TEMPLATE_ENGINE_FORMAT
+
+```ts
+const MAIL_TEMPLATE_ENGINE_FORMAT: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L21)
+
+Template engine format identifier (e.g. `handlebars`).
+
+---
+
+### MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN
+
+```ts
+const MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN: typeof MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L9)
+
+Central definition of injection tokens used by the mail module.
+Using constants instead of raw string literals prevents accidental typos
+and enables refactors with compile time safety.
+
+---
+
+### MAIL_TEMPLATE_STRATEGY
+
+```ts
+const MAIL_TEMPLATE_STRATEGY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
+
+Which template-fetch strategy to use (e.g. `file`, `blob`).
+
+---
+
+### MAIL_USER
+
+```ts
+const MAIL_USER: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L81)
+
+Mail user checked by the health indicator.
+
+---
+
+### MAILGUN_API_KEY
+
+```ts
+const MAILGUN_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/mailgun/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L12)
+
+API key for the Mailgun delivery service.
+
+---
+
+### MAILGUN_CONFIG_ENTRIES
+
+```ts
+const MAILGUN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [platform-mailing/src/mailgun/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L22)
+
+Configuration entries required by the Mailgun delivery provider.
+
+---
+
+### MAILGUN_DOMAIN
+
+```ts
+const MAILGUN_DOMAIN: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/mailgun/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L15)
+
+Mailgun domain (e.g. `mg.example.com`).
+
+---
+
+### PLATFORM_MAILING_CONFIG_ENTRIES
+
+```ts
+const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
+
+All configuration entries required by `platform-mailing`.
+
+---
+
+### POSTMARK_API_KEY
+
+```ts
+const POSTMARK_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L12)
+
+API key for the Postmark delivery service.
+
+---
+
+### POSTMARK_CONFIG_ENTRIES
+
+```ts
+const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
+
+Configuration entries required by the Postmark delivery provider.
+
+---
+
+### RESEND_API_KEY
+
+```ts
+const RESEND_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L12)
+
+API key for the Resend delivery service.
+
+---
+
+### RESEND_CONFIG_ENTRIES
+
+```ts
+const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
+
+Configuration entries required by the Resend delivery provider.
+
+---
+
+### SEND_MAIL_EVENT_KEY
+
+```ts
+const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents, 'sendMail'>;
+```
+
+Defined in: [platform-mailing/src/events/MailEventKeys.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/MailEventKeys.ts#L13)
+
+Event key registry for the mail domain events.
+
+---
+
+### SENDGRID_API_KEY
+
+```ts
+const SENDGRID_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L12)
+
+API key for the SendGrid delivery service.
+
+---
+
+### SENDGRID_CONFIG_ENTRIES
+
+```ts
+const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
+
+Configuration entries required by the SendGrid delivery provider.