package email_message

  1. Overview
  2. Docs
package email_message
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = string
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
val of_string : ?whitespace:Whitespace.t -> string -> t

Normalize the whitespace for processing/ if whitespace == `Raw this does nothing. if whitespace = `Normalize (default), strip leading/trailing whitespace on every line.

Normalize the whitespace for transport (insert the appropriate leading space). if whitespace == `Raw this does nothing. if whitespace == `Normalize (default), insert a leading space and indent subsequent lines with a tab (remove any other leading/trailing space on every line).

val to_string : ?whitespace:Whitespace.t -> t -> string

Normalize the whitespace for transport (insert the appropriate leading space). if whitespace == `Raw this does nothing. if whitespace == `Normalize (default), insert a leading space and indent subsequent lines with a tab (remove any other leading/trailing space on every line).

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 validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
include Core.Hashable.S_plain with type t := t
include Core_kernel.Hashable.Common with type t := t
val compare : t -> t -> Base.Int.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_kernel.Hashtbl.S_plain with type key = t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct