package async_smtp

  1. Overview
  2. Docs
package async_smtp
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
type envelope = t
val sexp_of_envelope : envelope -> Ppx_sexp_conv_lib.Sexp.t
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
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 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 : sig ... end
module Map : sig ... end
module Set : sig ... end
include Core.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 : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val hashable : t Base.Hashable.t
module Table : sig ... end
module Hash_set : sig ... end
module Hash_queue : sig ... end
val add_header : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> name:string -> value:string -> t
val add_headers : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> (string * string) list -> t
val set_header : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> name:string -> value:string -> t
val add_header_at_bottom : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> name:string -> value:string -> t
val add_headers_at_bottom : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> (string * string) list -> t
val set_headers : t -> Email_message.Email_headers.t -> t
val set_header_at_bottom : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> name:string -> value:string -> t
val smash_and_add_header : ?whitespace:Email_message.Email_headers.Whitespace.t -> t -> name:string -> value:string -> t
val sender : t -> [ `Null | `Email of Email_address.t ]
val sender_args : t -> Async_smtp_types__.Sender_argument.t list
val string_sender : t -> string
val recipients : t -> Email_message.Email_address.t list
val rejected_recipients : t -> Email_message.Email_address.t list
val string_recipients : t -> string list
val route : t -> string option
val id : t -> Async_smtp_types__.Envelope_id.t
val create : ?id:Async_smtp_types__.Envelope_id.t -> sender:[ `Null | `Email of Email_address.t ] -> ?sender_args:Async_smtp_types__.Sender_argument.t list -> recipients:Email_message.Email_address.t list -> ?rejected_recipients:Email_message.Email_address.t list -> ?route:string -> email:Email_message.Email.t -> unit -> t
val create' : info:Async_smtp_types__.Envelope_info.t -> email:Email_message.Email.t -> t
val info : t -> Async_smtp_types__.Envelope_info.t
val email : t -> Email_message.Email.t
val set : ?sender:[ `Null | `Email of Email_address.t ] -> ?sender_args:Async_smtp_types__.Sender_argument.t list -> ?recipients:Email_message.Email_address.t list -> ?rejected_recipients:Email_message.Email_address.t list -> ?route:string option -> ?email:Email_message.Email.t -> t -> unit -> t
val set' : t -> ?info:Async_smtp_types__.Envelope_info.t -> ?email:Email_message.Email.t -> unit -> t
val modify_email : t -> f:(Email_message.Email.t -> Email_message.Email.t) -> t
val of_bodiless : Async_smtp_types__.Envelope_bodiless.t -> Email_message.Email.Raw_content.t -> t
val split_bodiless : t -> Async_smtp_types__.Envelope_bodiless.t * Email_message.Email.Raw_content.t
val with_bodiless : t -> (Async_smtp_types__.Envelope_bodiless.t -> Async_smtp_types__.Envelope_bodiless.t) -> t
module Stable : sig ... end
module Bodiless : sig ... end
module Sender : sig ... end
module Sender_argument : sig ... end
module Container : sig ... end
module Id : sig ... end
module Info : sig ... end
module Selector : sig ... end
module Retry_interval : sig ... end
module Routed : sig ... end