email_message v0.17.0 · OCaml Package

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:Headers.t ->
  raw_content:Email_message_kernel__.Email_raw_content.t ->
  t

val headers : t -> Headers.t

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

val modify_headers : t -> f:(Headers.t -> 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:Lf_or_crlf.t ->
  t ->
  Bigstring_shared.t

val to_string_monoid : 
  ?eol_except_raw_content:Lf_or_crlf.t ->
  t ->
  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: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: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 : sig ... end

module Map : sig ... end

module Set : sig ... end

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 : sig ... end

module Hash_set : sig ... end

module Hash_queue : sig ... end

module Bigstring_shared : sig ... end

module Content : sig ... end

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

module Raw_content : sig ... end

module Simple : sig ... end

module Headers : sig ... end

module Mimestring : sig ... end

module Octet_stream : sig ... end

module String_monoid : sig ... end

module Lf_or_crlf : sig ... end

module Stable : sig ... end

module Private : sig ... end

package email_message