package email_message

You can search for identifiers within the package.

in-package search v0.2.0

E-mail message parser

Install

Dune 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.14.0.tar.gz

sha256=8785af9f579962a2ed67dfa5f1277695ee505d1115f835a39b03a0d68abf74a4

md5=7ded9a91a978ec40b3c2dacf4303d998

doc/email_message.email_address/Email_address/index.html

Module `Email_address`Source

Sourcemodule Domain : sig ... end

Sourcetype t

Sourceval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t

Sourceval create : ?prefix:string -> ?domain:Domain.t -> string -> t

Sourceval of_string : ?default_domain:string -> string -> t Core_kernel.Or_error.t

Sourceval of_string_exn : ?default_domain:string -> string -> t

Source

val list_of_string : 
  ?default_domain:string ->
  string ->
  t list Core_kernel.Or_error.t

Sourceval list_of_string_exn : ?default_domain:string -> string -> t list

Sourceval to_string : 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

Source

val address_part_string : 
  ?brackets:bool ->
  ?lowercase_domain:bool ->
  t ->
  string

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

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.

Sourceval 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

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 comparator : (t, comparator_witness) Base.Comparator.comparator

Sourceval validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check

Sourceval validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check

Source

val validate_bound : 
  min:t Base.Maybe_bound.t ->
  max:t Base.Maybe_bound.t ->
  t Base.Validate.check

Source

module Replace_polymorphic_compare : 
  Base.Comparable.Polymorphic_compare with type t := t

Source

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

Source

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

Sourceval compare : t -> t -> Base.Int.t

Source

val hash_fold_t : 
  Ppx_hash_lib.Std.Hash.state ->
  t ->
  Ppx_hash_lib.Std.Hash.state

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

Sourceval hashable : t Base.Hashable.t

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

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

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

Sourcemodule Caseless : sig ... end

Sourcemodule Stable : sig ... end

package email_message

Install

Dune Dependency

Authors

Maintainers

Sources

doc/email_message.email_address/Email_address/index.html

Module Email_addressSource

Module `Email_address`Source