email_message v0.17.0 (latest)

type t

include Ppx_compare_lib.Comparable.S with type t := t

include Ppx_hash_lib.Hashable.S with type t := t

val sexp_of_t : t -> Sexplib0.Sexp.t

val create : 
  headers:Email_message_kernel.Headers.t ->
  raw_content:Email_message_kernel__.Email_raw_content.t ->
  t

val headers : t -> Email_message_kernel.Headers.t

val set_headers : t -> Email_message_kernel.Headers.t -> t

val modify_headers : 
  t ->
  f:(Email_message_kernel.Headers.t -> Email_message_kernel.Headers.t) ->
  t

val raw_content : t -> Email_message_kernel__.Email_raw_content.t

val set_raw_content : t -> Email_message_kernel__.Email_raw_content.t -> t

val modify_raw_content : 
  t ->
  f:
    (Email_message_kernel__.Email_raw_content.t ->
      Email_message_kernel__.Email_raw_content.t) ->
  t

val to_bigstring_shared : 
  ?eol_except_raw_content:Email_message_kernel.Lf_or_crlf.t ->
  t ->
  Email_message_kernel.Bigstring_shared.t

val to_string_monoid : 
  ?eol_except_raw_content:Email_message_kernel.Lf_or_crlf.t ->
  t ->
  Email_message_kernel.String_monoid.t

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

val of_string : string -> t

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

val to_string : 
  ?eol_except_raw_content:Email_message_kernel.Lf_or_crlf.t ->
  t ->
  string

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

val to_bigstring : 
  ?eol_except_raw_content:Email_message_kernel.Lf_or_crlf.t ->
  t ->
  Core.Bigstring.t

val of_bigstring : Core.Bigstring.t -> t

val of_bigbuffer : Core.Bigbuffer.t -> t

include Core.Comparable.S_plain with type t := t

include Base.Comparable.S with type t := t

include Base.Comparisons.S with type t := t

include Base.Comparisons.Infix 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

include Base.Comparator.S with type t := t

type comparator_witness

val comparator : (t, comparator_witness) Base.Comparator.comparator

val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check

val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check

val validate_bound : 
  min:t Core.Maybe_bound.t ->
  max:t Core.Maybe_bound.t ->
  t Validate.check

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons with type t := t

module Map : 
  Core.Map.S_plain
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

module Set : 
  Core.Set.S_plain
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

include Core.Hashable.S_plain with type t := t

include Ppx_compare_lib.Comparable.S with type t := t

val compare : t -> t -> int

include Ppx_hash_lib.Hashable.S with type t := t

val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state

val hash : t -> Base.Hash.hash_value

val hashable : t Base.Hashable.t

module Table : Core.Hashtbl.S_plain with type key = t

module Hash_set : Core.Hash_set.S_plain with type elt = t

module Hash_queue : Core.Hash_queue.S with type key = t

module Stable : sig ... end

val save : 
  ?temp_file:string ->
  ?perm:Async.Unix.file_perm ->
  ?fsync:bool ->
  ?eol_except_raw_content:Email_message_kernel.Lf_or_crlf.t ->
  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

module Content = Email_message_kernel.Content

module Raw_content = Email_message_kernel.Raw_content

module Simple : sig ... end

package email_message