package sihl

  1. Overview
  2. Docs

Module Sihl.EmailSource

include module type of struct include Sihl_facade.Email end
Sourceval to_sexp : Sihl_contract.Email.t -> Sexplib0.Sexp.t
Sourceval to_yojson : Sihl_contract.Email.t -> Yojson.Safe.t
Sourceval of_yojson : Yojson.Safe.t -> Sihl_contract.Email.t option
Sourceval set_text : string -> Sihl_contract.Email.t -> Sihl_contract.Email.t
Sourceval set_html : string option -> Sihl_contract.Email.t -> Sihl_contract.Email.t
Sourceval create : ?html:string -> ?cc:string list -> ?bcc:string list -> sender:string -> recipient:string -> subject:string -> string -> Sihl_contract.Email.t
include Sihl_contract.Email.Sig
include Sihl_core.Container.Service.Sig
Sourceval inbox : unit -> Sihl_contract.Email.t list

inbox () returns the content of the development in-memory mailbox. Intercepted emails land here, they can be used during testing to make sure that certain emails were sent.

Sourceval clear_inbox : unit -> unit

clear_inbox () removes all the emails from the development in-memory mailbox. A subsequent call on `inbox ()` will return an empty list.

Sourceval send : Sihl_contract.Email.t -> unit Lwt.t

send email sends the email email. The returned Lwt.t fulfills if the underlying email transport acknowledges sending. In case of SMTP, this might take a while.

Sourceval bulk_send : Sihl_contract.Email.t list -> unit Lwt.t

bulk_send emails Sends the list of emails emails. If sending of one of them fails, the returned Lwt.t fails.

Sourcemodule Setup : sig ... end