package email_message

  1. Overview
  2. Docs
package email_message
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Email end
type t
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val create : headers:Email_message__.Headers.t -> raw_content:Email_message__.Email_raw_content.t -> t
val headers : t -> Email_message__.Headers.t
val set_headers : t -> Email_message__.Headers.t -> t
val modify_headers : t -> f:(Email_message__.Headers.t -> Email_message__.Headers.t) -> t
val raw_content : t -> Email_message__.Email_raw_content.t
val set_raw_content : t -> Email_message__.Email_raw_content.t -> t
val modify_raw_content : t -> f: (Email_message__.Email_raw_content.t -> Email_message__.Email_raw_content.t) -> t
val 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

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

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

val of_string : string -> t
val to_string : ?eol_except_raw_content:[ `LF | `CRLF ] -> t -> string
val to_bigstring : ?eol_except_raw_content:[ `LF | `CRLF ] -> 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_intf.S with type t := t
include Base.Comparable_intf.Polymorphic_compare 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 ~cmp: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
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
include Base.Comparable_intf.Validate with type t := t
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
module Replace_polymorphic_compare : sig ... end
module Map : sig ... end
module Set : sig ... end
include Core.Hashable.S_plain with type t := t
include Core_kernel.Hashable.Common with type t := t
include sig ... end
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
module Table : sig ... end
module Hash_set : sig ... end
module Hash_queue : sig ... end
module Stable : 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
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