Interface MailSenderService

interface MailSenderService {
sendCampaignEmail(message: Message): Promise<SendResponse>;
sendTransactionalEmail(message: Message): Promise<SendResponse>;
}

Index

Methods

sendCampaignEmail sendTransactionalEmail

Methods

sendCampaignEmail

sendCampaignEmail(message: Message): Promise<SendResponse>
Sends a Campaign email with the specified message.
Parameters
- message: Message
  - Optionalbcc?: string | string[]
  - Optionalcc?: string | string[]
  - fromAddress: string
  - OptionalfromNameTemplate?: string
  - OptionalrecipientData?: Record<string | symbol, unknown>
  - OptionalreplyToAddress?: string
  - OptionalstatisticsMetaData?: StatisticsMetaData
  - OptionalsubjectTemplate?: string
  - Optionaltags?: string[]
  - OptionaltemplateData?: Record<string | symbol, unknown>
  - templateId: string
  - to: string
  - OptionaltrackingData?: Record<string | symbol, unknown>
Returns Promise<SendResponse>
The message id.

Throws
If mailgun throws an error.
- Defined in packages/services/src/services/MailSender/MailSenderService.ts:19

sendTransactionalEmail

sendTransactionalEmail(message: Message): Promise<SendResponse>
Sends Transactional email with the specified message.
Parameters
- message: Message
  - Optionalbcc?: string | string[]
  - Optionalcc?: string | string[]
  - fromAddress: string
  - OptionalfromNameTemplate?: string
  - OptionalrecipientData?: Record<string | symbol, unknown>
  - OptionalreplyToAddress?: string
  - OptionalstatisticsMetaData?: StatisticsMetaData
  - OptionalsubjectTemplate?: string
  - Optionaltags?: string[]
  - OptionaltemplateData?: Record<string | symbol, unknown>
  - templateId: string
  - to: string
  - OptionaltrackingData?: Record<string | symbol, unknown>
Returns Promise<SendResponse>
The message id.

Throws
If mailgun throws an error.
- Defined in packages/services/src/services/MailSender/MailSenderService.ts:37