@breadstone/archipel-platform-mailing
Classes
| Class | Description |
|---|---|
| BlobTemplateFetchStrategy | The BlobTemplateFetchStrategy class. |
| DatabaseTemplateFetchStrategy | Template fetch strategy that loads templates from a database via the IMailTemplateRepository port. |
| DeliveryStrategyBase | Represents the base class for all email delivery strategies. |
| FileTemplateFetchStrategy | The FileTemplateFetchStrategy class. |
| MailDeliveryError | Domain error thrown when email delivery fails. |
| MailgunDeliveryStrategy | Delivers emails via the Mailgun API. |
| MailHealthIndicator | Health indicator for mail service. |
| MailModule | Represents the mail module. |
| MailService | Represents the MailService class. |
| MailTemplateEngine | The MailTemplateEngine class. |
| - | |
| PostmarkDeliveryStrategy | The PostmarkDeliveryStrategy class. |
| ResendDeliveryStrategy | Delivers emails via the Resend API. |
| SendGridDeliveryStrategy | Delivers emails via the SendGrid API. |
| SmtpConnectionVerifier | Verifies SMTP server connectivity. Does not validate individual email addresses — only checks whether the configured SMTP transport is reachable. |
| SmtpDeliveryStrategy | The SmtpDeliveryStrategy class. |
| TemplateFetchStrategyBase | Represents the base class for template fetch strategies. |
Interfaces
| Interface | Description |
|---|---|
| IMailAttachment | Represents an email attachment. |
| IMailEvents | Represents the contract of events emitted by the mail domain. |
| IMailModuleOptions | Options for configuring the MailModule. |
| IMailTemplate | Represents a single mail template record stored in a persistent store. |
| IMailTemplateRepository | Port interface for mail template persistence. |
| IMailTemplateVariants | Represents the in-memory structure for a single template (multiple formats). |
Type Aliases
| Type Alias | Description |
|---|---|
| MailTemplateFormat | Union type of all supported template formats. |
Variables
| Variable | Description |
|---|---|
| ALLOWED_ATTACHMENT_MIME_TYPES | Allowed MIME types for email attachments. |
| MAIL_DELIVERY_STRATEGY_TOKEN | - |
| MAIL_HOST | Mail host checked by the health indicator. |
| MAIL_MAILGUN_API_KEY | API key for the Mailgun delivery service. |
| MAIL_MAILGUN_DOMAIN | Mailgun domain (e.g. mg.example.com). |
| MAIL_PORT | Mail port checked by the health indicator. |
| MAIL_POSTMARK_API_KEY | API key for the Postmark delivery service. |
| MAIL_RESEND_API_KEY | API key for the Resend delivery service. |
| MAIL_SENDER_EMAIL | Sender e-mail address shown in the From header. |
| MAIL_SENDGRID_API_KEY | API key for the SendGrid delivery service. |
| MAIL_SMTP_HOST | SMTP server host. |
| MAIL_SMTP_PASSWORD | SMTP authentication password. |
| MAIL_SMTP_PORT | SMTP server port. |
| MAIL_SMTP_SECURE | Whether the SMTP connection uses TLS. |
| MAIL_SMTP_USER | SMTP authentication username. |
| MAIL_TEMPLATE_ENGINE_FORMAT | Template engine format identifier (e.g. handlebars). |
| MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN | 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_NAMES_TOKEN | - |
| MAIL_TEMPLATE_REPOSITORY_TOKEN | - |
| MAIL_USER | Mail user checked by the health indicator. |
| MAILGUN_API_KEY | API key for the Mailgun delivery service. |
| MAILGUN_CONFIG_ENTRIES | Configuration entries required by the Mailgun delivery provider. |
| MAILGUN_DOMAIN | Mailgun domain (e.g. mg.example.com). |
| MAX_ATTACHMENT_SIZE_BYTES | Maximum attachment size in bytes (25 MB). |
| PLATFORM_MAILING_CONFIG_ENTRIES | All configuration entries required by platform-mailing. |
| POSTMARK_API_KEY | API key for the Postmark delivery service. |
| POSTMARK_CONFIG_ENTRIES | Configuration entries required by the Postmark delivery provider. |
| RESEND_API_KEY | API key for the Resend delivery service. |
| RESEND_CONFIG_ENTRIES | Configuration entries required by the Resend delivery provider. |
| SEND_MAIL_EVENT_KEY | Event key registry for the mail domain events. |
| SENDGRID_API_KEY | API key for the SendGrid delivery service. |
| SENDGRID_CONFIG_ENTRIES | Configuration entries required by the SendGrid delivery provider. |
| SMTP_CONFIG_ENTRIES | Configuration entries required by the SMTP delivery provider. |
| SMTP_HOST | SMTP server host. |
| SMTP_PASSWORD | SMTP authentication password. |
| SMTP_PORT | SMTP server port. |
| SMTP_SECURE | Whether the SMTP connection uses TLS. |
| SMTP_USER | SMTP authentication username. |