package email_message

You can search for identifiers within the package.

in-package search v0.2.0

E-mail message parser

Install

dune-project

Dependency

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

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

email_message-v0.13.0.tar.gz

sha256=56ff395814d5644317d72983952f54658bad49a979717e68f76fb230fc1b16b2

md5=a19f9522600fbc20f16eaa5be90b1ffe

doc/email_message.email_address/Email_address/index.html

Module `Email_address`

module Domain : sig ... end

type t

val sexp_of_t : t -> Ppx_sexp_conv_lib.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

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.

val arg_type : t Core_kernel.Command.Arg_type.t

include Core_kernel.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 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 : 
  Base.Comparable.Polymorphic_compare with type t := t

module Map : 
  Core_kernel.Map.S_plain
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

module Set : 
  Core_kernel.Set.S_plain
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

include Core_kernel.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 : 
  Ppx_hash_lib.Std.Hash.state ->
  t ->
  Ppx_hash_lib.Std.Hash.state

val hash : t -> Ppx_hash_lib.Std.Hash.hash_value

val hashable : t Base.Hashable.t

module Table : Core_kernel.Hashtbl.S_plain with type key = t

module Hash_set : Core_kernel.Hash_set.S_plain with type elt = t

module Hash_queue : Core_kernel.Hash_queue.S with type key = t

module Caseless : sig ... end

module Stable : sig ... end