package sendmail

  1. Overview
  2. Docs
Implementation of the sendmail command

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (16)

Authors

  1. C
    Charles-Edouard Lecat
  2. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Maintainers

  1. C
    Charles-Edouard Lecat
  2. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Sources

colombe-0.8.0.tbz
sha256=9d3ad39d5b7af765947ff9ff01cec15e4226924d816827fc15c7ec1e5be7fff3
sha512=8f9a8aefd33426064fead137374b134ad30f90d653afcf4f30043c3e82764edaa17e9b5323c040da3d60a9c1f491d9d265a069ae4ac887685719ecc47c812308

doc/sendmail/Sendmail/index.html

Module SendmailSource

Sourcetype reverse_path = Colombe.Reverse_path.t
Sourcetype forward_path = Colombe.Forward_path.t
Sourcetype mechanism =
  1. | PLAIN
  2. | LOGIN
Sourcetype authentication = {
  1. username : string;
  2. password : string;
  3. mechanism : mechanism;
}
Sourcetype ('a, 's) stream = unit -> ('a option, 's) Colombe.Sigs.io
Sourcetype error = [
  1. | `Protocol of [ Colombe.Request.Encoder.error | Colombe.Reply.Decoder.error | `Unexpected_response of int * string list | `Invalid_base64_value of string | `Invalid_login_challenge of string ]
  2. | `Unsupported_mechanism
  3. | `Encryption_required
  4. | `Weak_mechanism
  5. | `Authentication_rejected
  6. | `Authentication_failed
  7. | `Authentication_required
]
Sourceval pp_error : error Fmt.t
Sourceval sendmail : 's Colombe.Sigs.impl -> ('flow, 's) Colombe.Sigs.rdwr -> 'flow -> Colombe.State.Context.t -> ?authentication:authentication -> domain:Colombe.Domain.t -> reverse_path -> forward_path list -> (string * int * int, 's) stream -> ((unit, error) result, 's) Colombe.Sigs.io

sendmail impl rdwr flow ctx ?authentication ~domain sender recipients mail where:

  • impl is the scheduler (unix, lwt or async)
  • rdwr read/write syscalls
  • flow witness of the flow (can be a socket)
  • ctx context used by the process
  • authentication authentication information used by the process
  • sender sender of the mail
  • recipients recipients of the mail
  • mail stream of the mail

This process try to send a mail according RFC4409. The process should be wrapped into a secured flow (like TLS). For a real use-case of sendmail, you should look into sendmail-lwt which takes care about the TLS layer.