Module `Email.Simple`Source

Sourcemodule Mimetype : sig ... end

Sourcetype attachment_name = string

Sourcemodule Attachment : sig ... end

Sourcemodule Content : sig ... end

Sourcetype t = Email.t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

val create : 
  ?from:Email_address.t ->
  to_:Email_address.t list ->
  ?cc:Email_address.t list ->
  ?reply_to:Email_address.t ->
  subject:string ->
  ?id:string ->
  ?in_reply_to:string ->
  ?date:Core.Time.t ->
  ?auto_generated:unit ->
  ?extra_headers:(string * string) list ->
  ?attachments:(attachment_name * Content.t) list ->
  Content.t ->
  t

Sourceval make_id : unit -> string

A unique value to be used in a Message-Id header

Sourceval from : t -> Email_address.t option

Sourceval to_ : t -> Email_address.t list option

Sourceval cc : t -> Email_address.t list option

Sourceval subject : t -> string option

Sourceval id : t -> string option

Sourceval extract_body : ?content_type:Mimetype.t -> t -> string option

Source

val all_attachments : 
  ?look_through_attached_mails:bool ->
  t ->
  Attachment.t list

all_attachments looks recursively through the e-mail parts, looking for attachments. If ~look_through_attached_mails:true (the default), it will separately include both e-mail attachments as well as the attachments to those e-mails. Otherwise it will include e-mail attachments but not (separately) any of the attached e-mails' attachments.

Sourceval find_attachment : t -> attachment_name -> Attachment.t option

Sourceval all_related_parts : t -> (attachment_name * Content.t) list

Related parts are those that are included in a multi-part message with a "Content-ID" header. This content can be referenced by adding the "cid:" prefix and stripping the enclosing '<' and '>'.

For example (from https://tools.ietf.org/html/rfc2392):

    From: foo1@bar.net
    To: foo2@bar.net
    Subject: A simple example
    Mime-Version: 1.0
    Content-Type: multipart/related; boundary="boundary-example-1"; type=Text/HTML
    --boundary-example 1
    Content-Type: Text/HTML; charset=US-ASCII

    to the other body part, for example through a statement such as:
    <IMG SRC="cid:foo4*foo1@bar.net" ALT="IETF logo">

    --boundary-example-1

    Content-ID: <foo4*foo1@bar.net>
    Content-Type: IMAGE/GIF
    Content-Transfer-Encoding: BASE64

    R0lGODlhGAGgAPEAAP/////ZRaCgoAAAACH+PUNvcHlyaWdodCAoQykgMTk5
    NSBJRVRGLiBVbmF1dGhvcml6ZWQgZHVwbGljYXRpb24gcHJvaGliaXRlZC4A
    etc...

    --boundary-example-1--

Calling all_related_parts on this email would return a list of length one where the attachment_name is "foo4*foo1@bar.net" for the single entry.

Related parts are often used for inline images.

Sourceval find_related : t -> attachment_name -> Content.t option

Sourceval inline_parts : t -> Content.t list

Sourceval map_attachments : t -> f:(Attachment.t -> [ `Keep | `Replace of t ]) -> t

map_attachments recurses into message/rfc822 parts. However, if a message/rfc822 part is replaced, there is no further recursion.

Sourcemodule Expert : sig ... end

Sourcemodule Stable : sig ... end

package email_message

Module Email.SimpleSource

Module `Email.Simple`Source