Skip to content

basalt / mailer/src / MailgunDriverOptions

Interface: MailgunDriverOptions ​

Defined in: mailer/src/drivers/mailgun.ts:11

Properties ​

apiKey ​

> apiKey: string

Defined in: mailer/src/drivers/mailgun.ts:13

Mailgun private API key.


baseUrl? ​

> optional baseUrl?: string

Defined in: mailer/src/drivers/mailgun.ts:19

Override the API base (default derived from region). Override in tests.


domain ​

> domain: string

Defined in: mailer/src/drivers/mailgun.ts:15

Your sending domain, e.g. mg.example.com.


fetch? ​

> optional fetch?: (input, init?) => Promise<Response>

Defined in: mailer/src/drivers/mailgun.ts:21

Injectable fetch (for tests). Default: global fetch.

Parameters ​

input ​

string | URL | Request

init? ​

RequestInit

Returns ​

Promise<Response>


region? ​

> optional region?: "us" | "eu"

Defined in: mailer/src/drivers/mailgun.ts:17

API region. Default: us.

Released under the MIT License.