package email_message

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Domain : sig ... end
include module type of struct include Email_address end with module Domain := Domain
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val create : ?prefix:string -> ?domain:Domain.t -> string -> t
val of_string : ?default_domain:string -> string -> t Core_kernel.Or_error.t
val of_string_exn : ?default_domain:string -> string -> t
val list_of_string : ?default_domain:string -> string -> t list Core_kernel.Or_error.t
val list_of_string_exn : ?default_domain:string -> string -> t list
val to_string : t -> string
val list_to_header_value : t list -> string
val local_part : t -> string
val set_local_part : t -> string -> t
val domain : t -> Domain.t option
val set_domain : t -> Domain.t option -> t
val address_part : ?brackets:bool -> ?lowercase_domain:bool -> t -> t
val address_part_string : ?brackets:bool -> ?lowercase_domain:bool -> t -> string
val set_address_part : t -> string -> t Core_kernel.Or_error.t

set_address_part expects an email address without prefix or angle brackets e.g. USER@DOMAIN.

val prefix : t -> string option

set_prefix will remove angle brackets if given None, otherwise angle brackets are added before the given prefix.

val set_prefix : t -> string option -> t

set_prefix will remove angle brackets if given None, otherwise angle brackets are added before the given prefix.

include Core_kernel.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 = Email_address.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 = Email_address.Replace_polymorphic_compare
module Map = Email_address.Map
module Set = Email_address.Set
include Core_kernel.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 = Email_address.Table
module Hash_set = Email_address.Hash_set
module Hash_queue = Email_address.Hash_queue
module Caseless = Email_address.Caseless
module Stable = Email_address.Stable
val local_address : unit -> t
OCaml

Innovation. Community. Security.