correio - v0.1.0

correio/message

Immutable message construction. Delivery admission applies resource limits.

Types

Attachment

opaque </> 
pub opaque type Attachment

AttachmentView

</> 
pub type AttachmentView {
  AttachmentView(
    filename: String,
    content_type: String,
    bytes: BitArray,
    disposition: Disposition,
  )
}

Constructors 

  • AttachmentView(
  filename: String,
  content_type: String,
  bytes: BitArray,
  disposition: Disposition,
)

Body

</> 
pub type Body {
  Text(String)
  Html(String)
  Alternative(text: String, html: String)
}

Constructors 

  • Text(String)
  • Html(String)
  • Alternative(text: String, html: String)

Disposition

</> 
pub type Disposition {
  AttachmentFile
  Inline(content_id: String)
}

Constructors 

  • AttachmentFile
  • Inline(content_id: String)

Limits

opaque </> 
pub opaque type Limits

Message

opaque </> 
pub opaque type Message

MessageError

</> 
pub type MessageError {
  InvalidSubject
  EmptyBody
  InvalidHeader
  ReservedHeader
  InvalidAttachment
  InvalidLimits
  TooManyRecipients
  TooManyHeaders
  HeaderTooLarge
  BodyTooLarge
  AttachmentTooLarge
  SubmissionTooLarge
  EncodingFailed
}

Constructors 

  • InvalidSubject
  • EmptyBody
  • InvalidHeader
  • ReservedHeader
  • InvalidAttachment
  • InvalidLimits
  • TooManyRecipients
  • TooManyHeaders
  • HeaderTooLarge
  • BodyTooLarge
  • AttachmentTooLarge
  • SubmissionTooLarge
  • EncodingFailed

View

</>

A read-only projection. Constructing a View cannot construct a Message.

pub type View {
  View(
    from: address.Address,
    to: List(address.Address),
    cc: List(address.Address),
    bcc: List(address.Address),
    subject: String,
    body: Body,
    reply_to: option.Option(address.Address),
    envelope_sender: address.Address,
    headers: List(#(String, String)),
    attachments: List(Attachment),
  )
}

Constructors

Values

add_bcc

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

add_cc

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

add_to

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

attach

</> 
pub fn attach(
  message: Message,
  attachment: Attachment,
) -> Message

attachment

</> 
pub fn attachment(
  filename: String,
  content_type: String,
  bytes: BitArray,
  disposition: Disposition,
) -> Result(Attachment, MessageError)

attachment_view

</> 
pub fn attachment_view(attachment: Attachment) -> AttachmentView

default_limits

</> 
pub fn default_limits() -> Limits

Defaults: 100 recipients, 50 custom headers, 8 KiB header values, 1 MiB body content, 10 MiB per attachment and 25 MiB encoded submission.

envelope

</> 
pub fn envelope(
  message: Message,
) -> #(address.Address, List(address.Address))
</> 
pub fn header(
  message: Message,
  name: String,
  value: String,
) -> Result(Message, MessageError)

Custom field bodies preserve structured ASCII syntax. Unicode custom field bodies and physical lines longer than 998 bytes are refused. Unicode subject and display-name encoding remains available through their dedicated APIs.

limits

</> 
pub fn limits(
  recipients: Int,
  headers: Int,
  header_bytes: Int,
  body_bytes: Int,
  attachment_bytes: Int,
  submission_bytes: Int,
) -> Result(Limits, MessageError)

maximum_submission_bytes

</> 
pub fn maximum_submission_bytes(limits: Limits) -> Int

new

</> 
pub fn new(
  from from: address.Address,
  to to: address.Address,
  subject subject: String,
  body body: Body,
) -> Result(Message, MessageError)

set_envelope_sender

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

set_reply_to

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

validate

</> 
pub fn validate(
  message: Message,
  limits: Limits,
) -> Result(Nil, MessageError)

view

</> 
pub fn view(message: Message) -> View
✨ Search Document