Interface MailpitSendRequest

Request parameters for the sendMessage() API.

interface MailpitSendRequest {
    Attachments?: MailpitAttachmentRequest[];
    Bcc?: string[];
    Cc?: MailpitEmailAddressRequest[];
    From: MailpitEmailAddressRequest;
    Headers?: { [key: string]: string };
    HTML?: string;
    ReplyTo?: MailpitEmailAddressRequest[];
    Subject?: string;
    Tags?: string[];
    Text?: string;
    To: MailpitEmailAddressRequest[];
}

Index

Properties

Attachments? Bcc? Cc? From Headers? HTML? ReplyTo? Subject? Tags? Text? To

Properties

`Optional`Attachments

Attachments?: MailpitAttachmentRequest[]

Attachments

`Optional`Bcc

Bcc?: string[]

Bcc recipients email addresses only

`Optional`Cc

Cc?: MailpitEmailAddressRequest[]

CC recipients

From

From: MailpitEmailAddressRequest

Sender address

`Optional`Headers

Headers?: { [key: string]: string }

Optional message headers

Type Declaration

[key: string]: string
Header in key value

`Optional`HTML

HTML?: string

Message body (HTML)

`Optional`ReplyTo

ReplyTo?: MailpitEmailAddressRequest[]

Optional Reply-To recipients

`Optional`Subject

Subject?: string

Email message subject

`Optional`Tags

Tags?: string[]

Mailpit tags

`Optional`Text

Text?: string

Message body (text)

To

To: MailpitEmailAddressRequest[]

To recipients