core/at.quickme.kotlinmailer.email/Email

Email

class Email(source)

An immutable email message. Create one with emailBuilder.

Properties

val attachments: List<Attachment>

Attachments, including inline ones referenced by cid: URLs from the HTML body.

val bcc: List<EmailAddress>

Hidden recipients; they are only part of the envelope and never rendered into headers.

val cc: List<EmailAddress>

Visible carbon copy recipients.

val date: Instant?

The Date header; the time of rendering is used if null.

val Email.eml: String

This email as .eml (RFC 5322) string.

val from: EmailAddress

The author of the message.

val headers: List<Header>

Additional headers, rendered in the given order.

val html: String?

The HTML body.

val inReplyTo: List<String>

The Message-IDs this message replies to, without angle brackets.

val messageId: String

The Message-ID without angle brackets, e.g. 1234@example.com.

val recipients: List<EmailAddress>

All envelope recipients: to, cc and bcc without duplicates.

val references: List<String>

The Message-IDs of the thread, without angle brackets.

val replyTo: List<EmailAddress>

Addresses replies should be sent to.

val subject: String?

The subject line.

val text: String?

The plain text body.

val to: List<EmailAddress>

Visible primary recipients.

Functions

inline fun Email.copy(builder: EmailBuilder.() -> Unit = {}): Email

Copy this email, modify it with builder and build it with a new message id.

inline fun Email.forward(from: EmailAddress, builder: EmailBuilder.() -> Unit = {}): Email

Forward this email. The original is attached as message/rfc822.

fun newBuilder(): EmailBuilder

Create a builder pre-filled with this email's content and a new messageId.

fun Email.render(date: Instant = Clock.System.now()): RenderedEmail

Render this email to a MIME message.

inline fun Email.reply(from: EmailAddress, toAll: Boolean = false, builder: EmailBuilder.() -> Unit = {}): Email

Reply to this email. The new email is addressed to the Email.replyTo addresses (or Email.from), keeps the thread headers and quotes the original body.

suspend fun Email.send(mailer: Mailer = MailerManager.defaultMailer): SendReceipt

Send this email.

open override fun toString(): String