package email_message

  1. Overview
  2. Docs
E-mail message parser

Install

Dune Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

email_message-v0.15.0.tar.gz
sha256=f119c3ba577d7f8398a6ffa9c1e5e6f2712842c0409d41cfc5a408304efebf20

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
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 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
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
type comparator_witness
val comparator : (t, comparator_witness) Base__.Comparator.comparator
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 Base__Ppx_compare_lib.compare
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : t Base__Ppx_hash_lib.hash_fold
Sourceval hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
Sourcemodule Table : Core.Hashtbl.S_plain with type key = t
Sourcemodule Caseless : sig ... end
Sourcemodule Stable : 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