lumenmail - v1.1.0

lumenmail/message

Email message builder module. Provides a fluent API for constructing RFC 5322 compliant email messages.

Types

Attachment

</>

An email attachment.

pub type Attachment {
  Attachment(
    filename: String,
    content_type: ContentType,
    data: BitArray,
    inline: Bool,
    content_id: option.Option(String),
  )
}

Constructors 

  • Attachment(
  filename: String,
  content_type: ContentType,
  data: BitArray,
  inline: Bool,
  content_id: option.Option(String),
)

ContentType

</>

Content type for email body parts.

pub type ContentType {
  TextPlain
  TextHtml
  MultipartAlternative
  MultipartMixed
  MultipartRelated
  ApplicationOctetStream
  Custom(mime_type: String)
}

Constructors 

  • TextPlain
  • TextHtml
  • MultipartAlternative
  • MultipartMixed
  • MultipartRelated
  • ApplicationOctetStream
  • Custom(mime_type: String)

Encoding

</>

Content transfer encoding.

pub type Encoding {
  SevenBit
  EightBit
  QuotedPrintable
  Base64
}

Constructors 

  • SevenBit
  • EightBit
  • QuotedPrintable
  • Base64
</>

An email header.

pub type Header {
  Header(name: String, value: String)
}

Constructors 

  • Header(name: String, value: String)

Message

</>

Email message structure.

pub type Message {
  Message(
    from: option.Option(types.Address),
    reply_to: option.Option(types.Address),
    to: List(types.Address),
    cc: List(types.Address),
    bcc: List(types.Address),
    subject: option.Option(String),
    text_body: option.Option(String),
    html_body: option.Option(String),
    attachments: List(Attachment),
    headers: List(Header),
    priority: Priority,
    message_id: option.Option(String),
    in_reply_to: option.Option(String),
    references: List(String),
  )
}

Constructors

Priority

</>

Priority level for emails.

pub type Priority {
  High
  Normal
  Low
}

Constructors 

  • High
  • Normal
  • Low

Values

add_reference

</> 
pub fn add_reference(message: Message, id: String) -> Message

Adds a reference message ID (for threading).

all_recipients

</> 
pub fn all_recipients(message: Message) -> List(types.Address)

Gets all recipients (to + cc + bcc).

attachment

</> 
pub fn attachment(
  message: Message,
  filename: String,
  content_type: ContentType,
  data: BitArray,
) -> Message

Adds an attachment.

bcc

</> 
pub fn bcc(message: Message, address: types.Address) -> Message

Adds a recipient to the BCC field.

bcc_email

</> 
pub fn bcc_email(message: Message, email: String) -> Message

Adds a recipient to BCC using just an email string.

bcc_many

</> 
pub fn bcc_many(
  message: Message,
  addresses: List(types.Address),
) -> Message

Sets multiple BCC recipients at once.

body

</> 
pub fn body(
  message: Message,
  text: String,
  html: String,
) -> Message

Sets both text and HTML body (multipart/alternative).

build

</> 
pub fn build(message: Message) -> Result(String, String)

Builds the raw email message as a string.

cc

</> 
pub fn cc(message: Message, address: types.Address) -> Message

Adds a recipient to the CC field.

cc_email

</> 
pub fn cc_email(message: Message, email: String) -> Message

Adds a recipient to CC using just an email string.

cc_many

</> 
pub fn cc_many(
  message: Message,
  addresses: List(types.Address),
) -> Message

Sets multiple CC recipients at once.

content_type_to_string

</> 
pub fn content_type_to_string(ct: ContentType) -> String

Converts content type to MIME string.

format_address

</> 
pub fn format_address(address: types.Address) -> String

Formats an address for use in email headers.

format_address_list

</> 
pub fn format_address_list(
  addresses: List(types.Address),
) -> String

Formats a list of addresses for use in email headers.

from

</> 
pub fn from(message: Message, address: types.Address) -> Message

Sets the sender address.

from_email

</> 
pub fn from_email(message: Message, email: String) -> Message

Sets the sender using just an email string.

from_name_email

</> 
pub fn from_name_email(
  message: Message,
  name: String,
  email: String,
) -> Message

Sets the sender with name and email.

generate_boundary

</> 
pub fn generate_boundary() -> String

Generates a random boundary string for multipart messages.

</> 
pub fn header(
  message: Message,
  name: String,
  value: String,
) -> Message

Adds a custom header.

html_body

</> 
pub fn html_body(message: Message, body: String) -> Message

Sets the HTML body.

in_reply_to

</> 
pub fn in_reply_to(message: Message, id: String) -> Message

Sets the In-Reply-To header (for threading).

inline_attachment

</> 
pub fn inline_attachment(
  message: Message,
  filename: String,
  content_type: ContentType,
  data: BitArray,
  content_id: String,
) -> Message

Adds an inline attachment (e.g., for images in HTML).

message_id

</> 
pub fn message_id(message: Message, id: String) -> Message

Sets the Message-ID header.

new

</> 
pub fn new() -> Message

Creates a new empty message builder.

priority

</> 
pub fn priority(message: Message, priority: Priority) -> Message

Sets the message priority.

reply_to

</> 
pub fn reply_to(
  message: Message,
  address: types.Address,
) -> Message

Sets the reply-to address.

subject

</> 
pub fn subject(message: Message, subject: String) -> Message

Sets the email subject.

text_body

</> 
pub fn text_body(message: Message, body: String) -> Message

Sets the plain text body.

to

</> 
pub fn to(message: Message, address: types.Address) -> Message

Adds a recipient to the To field.

to_email

</> 
pub fn to_email(message: Message, email: String) -> Message

Adds a recipient to To using just an email string.

to_many

</> 
pub fn to_many(
  message: Message,
  addresses: List(types.Address),
) -> Message

Sets multiple To recipients at once.

to_name_email

</> 
pub fn to_name_email(
  message: Message,
  name: String,
  email: String,
) -> Message

Adds a recipient with name and email to To field.

✨ Search Document