package email_message

  1. Overview
  2. Docs
E-mail message parser

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=3aa5c85da8530c277cf9e72e18861b235b3b872f08c87f118c04478433320ebb

doc/email_message.email_address/Email_address/index.html

Module Email_addressSource

Sourcemodule Domain : sig ... end
Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval create : ?prefix:string -> ?domain:Domain.t -> string -> t
Sourceval of_string : ?default_domain:string -> string -> t Core.Or_error.t
Sourceval of_string_exn : ?default_domain:string -> string -> t
Sourceval list_of_string : ?default_domain:string -> string -> t list Core.Or_error.t
Sourceval list_of_string_exn : ?default_domain:string -> string -> t list
Sourceval to_string : t -> string
Sourceval to_string_utf8 : t -> string
Sourceval list_to_header_value : t list -> string
Sourceval local_part : t -> string
Sourceval set_local_part : t -> string -> t
Sourceval domain : t -> Domain.t option
Sourceval set_domain : t -> Domain.t option -> t
Sourceval address_part : ?brackets:bool -> ?lowercase_domain:bool -> t -> t
Sourceval address_part_string : ?brackets:bool -> ?lowercase_domain:bool -> t -> string
Sourceval set_address_part : t -> string -> t Core.Or_error.t

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

Sourceval prefix : t -> string option
Sourceval 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.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
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval 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.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval 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).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
Sourcetype comparator_witness
Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
include Core.Hashable.S_plain with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
Sourceval hashable : t Base.Hashable.t
Sourcemodule Table : Core.Hashtbl.S_plain with type key = t
Sourcemodule Caseless : sig ... end
Sourcemodule Stable : sig ... end