types library Customisation

This library contains all the types used by the mailgun package.

Import this to create your own custom clients.

Classes

BaseClient

MGBaseClient is the base class for all clients.

BaseMessageParams

The base interface for message parameter classes.

IMessageClient

The IMessageClient interface defines methods for sending emails with the mailgun API.

MessageContent

The MessageContent class represents the content of an email.

MessageOptions

The possible extra options in the MessageParams class.

MessageParams

The MessageParams class is used to configure the request to the messages endpoint.

MimeMessageParams

The MimeMessageParams class is used to configure the request to the messages.mime endpoint.

Response

Response is the class returned by all the clients.

ResponseStatus

Enums

MessageContentType

Possible types of content for sending emails.

PlanType

Mailgun plan type

TrackingClicks

The possible values for the o:tracking-clicks option.

Typedefs

Callback = void Function(BaseResponse response)

Callback is a typedef for a callback function used in all clients.

Exceptions / Errors

InvalidPlanException

InvalidPlanException is thrown when a plan is invalid for a given operation.