Classes
Classes
MailService
Constructor
constructor(config: MailServiceConfig)
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
config | MailServiceConfig | Yes |
Methods
send
Send a raw email (no template)
send(message: EmailMessage): Promise<SendResult>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
message | EmailMessage | Yes |
Returns:
Promise<SendResult> -
sendTemplate
Send using a template
sendTemplate(templateName: string, to: string | string[], subject: string, data: TemplateData): Promise<SendResult>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes | - Name of template file (without .hbs extension) |
to | string | string[] | Yes | - Recipient(s) |
subject | string | Yes | - Email subject |
data | TemplateData | Yes | - Template variables |
Returns:
Promise<SendResult> -
renderTemplate
Render a template without sending (useful for previews)
renderTemplate(templateName: string, data: TemplateData): string
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes | |
data | TemplateData | Yes |
Returns:
string -
TemplateEngine
Constructor
constructor(templatesDir: string)
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
templatesDir | string | Yes |
Methods
render
render(templateName: string, data: TemplateData): string
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes | |
data | TemplateData | Yes |
Returns:
string -
has
Check if a template exists
has(templateName: string): boolean
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes |
Returns:
boolean -
ConsoleAdapter
Constructor
constructor(config: ConsoleConfig)
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
config | ConsoleConfig | Yes |
Methods
send
send(message: EmailMessage): Promise<SendResult>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
message | EmailMessage | Yes |
Returns:
Promise<SendResult> -
verify
verify(): Promise<boolean>
Returns:
Promise<boolean> -
SendGridAdapter
Constructor
constructor(config: SendGridConfig)
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
config | SendGridConfig | Yes |
Methods
send
send(message: EmailMessage): Promise<SendResult>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
message | EmailMessage | Yes |
Returns:
Promise<SendResult> -
verify
verify(): Promise<boolean>
Returns:
Promise<boolean> -