package email_message

  1. Overview
  2. Docs
package email_message
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Email_message.EmailSource

include module type of struct include Email end
Sourcetype t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval create : headers:Email_message__.Headers.t -> raw_content:Email_message__.Email_raw_content.t -> t
Sourceval headers : t -> Email_message__.Headers.t
Sourceval set_headers : t -> Email_message__.Headers.t -> t
Sourceval modify_headers : t -> f:(Email_message__.Headers.t -> Email_message__.Headers.t) -> t
Sourceval raw_content : t -> Email_message__.Email_raw_content.t
Sourceval set_raw_content : t -> Email_message__.Email_raw_content.t -> t
Sourceval modify_raw_content : t -> f: (Email_message__.Email_raw_content.t -> Email_message__.Email_raw_content.t) -> t
Sourceval save : ?temp_file:string -> ?perm:Async.Unix.file_perm -> ?fsync:bool -> ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> string -> unit Async.Deferred.t

Efficiently save t to disk with little additional allocation.

?temp_file, ?perm, ?fsync are blindly passed to Writer.with_file_atomic

Sourceval to_bigstring_shared : ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> Bigstring_shared.t
Sourceval to_string_monoid : ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> String_monoid.t

String-builder-like module. Small-to-no memory overhead when unparsed.

Sourceval of_string : string -> t

Convert from string, in compliance with the RFC 2822 standard (standard email format, e.g. .eml but not mbox)

Sourceval to_string : ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> string

Convert to string, in compliance with the RFC 2822 standard (standard email format, e.g. .eml but not mbox)

Sourceval to_bigstring : ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> Core.Bigstring.t
Sourceval of_bigstring : Core.Bigstring.t -> t
Sourceval of_bigbuffer : Core.Bigbuffer.t -> t
include Core.Comparable.S_plain with type t := t
include Base.Comparable.S with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
Sourcemodule Map : sig ... end
Sourcemodule Set : sig ... end
include Core.Hashable.S_plain with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t Base__Ppx_compare_lib.compare
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : t Base__Ppx_hash_lib.hash_fold
Sourceval hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
Sourcemodule Table : sig ... end
Sourcemodule Hash_set : sig ... end
Sourcemodule Hash_queue : sig ... end
Sourcemodule Stable : sig ... end
Sourcemodule Content : sig ... end

The cost depends on the encoding of the content and the main media type.

Sourcemodule Raw_content : sig ... end
Sourcemodule Simple : sig ... end