Library
Module
Module type
Parameter
Class
Class type
type error = Sendmail.error
val sendmail :
hostname:'a Domain_name.t ->
?port:int ->
domain:Colombe.Domain.t ->
authenticator:X509.Authenticator.t ->
?authentication:Sendmail.authentication ->
Colombe.Reverse_path.t ->
Colombe.Forward_path.t list ->
(unit -> (string * int * int) option Lwt.t) ->
(unit, error) result Lwt.t
sendmail ~hostname ?port ~domain ~authenticator ?authentication sender
recipients mail
where:
hostname
is the hostname of the peerport
the port of the SMTP peerdomain
is the domain of the sender (probably localhost
)authenticator
is the TLS authenticatorauthentication
is the username and the password of the usersender
is the senderrecipients
are recipients of the emailmail
stream of the mailThe connection already start a TLS connection to the peer. The peer is probably available on *:465
(the default of port
argument). The mail
stream must emit for each chunk a CRLF at the end. As an user of GMail, the call of sendmail
looks like:
open Mrmime
let my_domain = Colombe.Domain.of_string_exn (Unix.gethostname ())
let my_authentication =
{ Sendmail.username= "my_login"
; Sendmail.password= "my_password"
; Sendmail.mechanism= Sendmail.PLAIN }
let sender =
let open Mrmime.Mailbox in
let v = Local.[ "my"; "address"; "mail" ] @ Domain.(domain, [ "gmail"; "com" ]) in
Result.get_ok (Colombe_emile.to_reverse_path v)
(* "my.address.mail@gmail.com" *)
let destination =
let open Mrmime.Mailbox in
let v = Local.[ "to"; "joe" ] @ Domain.(domain, [ "gmail"; "com" ]) in
Result.get_ok (Colombe_emile.to_forward_path v)
(* "to.joe@gmail.com" *)
let run () = sendmail
~hostname:Domain_name.(host_exe (of_string_exn "gmail.com"))
~domain:my_domain
~authentictor
~authentication
sender [ destination ]
mail
let () = match Lwt_main.run (run ()) with
| Ok () -> ()
| Error err -> Format.eprintf "%a.\n%!" Sendmail.pp_error err
sendmail
does not strictly depend on mrmime
or emile
. However, we advise to use them to produce typed and well-formed mails. sendmail
does not handle properly contents of mails as are. It just emits the stream to the pipeline directly without any changes. Again, this job can be done by mrmime
- or yourself.
sendmail
starts by itself a TLS connection with the SMTP server.