package sendmail

You can search for identifiers within the package.

in-package search v0.2.0

Implementation of the sendmail command

Install

Dune Dependency

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

Authors

Maintainers

Sources

colombe-0.10.0.tbz

sha256=065ecfe82e867f4f8b267c5fcb7e9dd8fef424601b10bc731f5f2012fde81bda

sha512=7ed60b73420ab7a3950f9d0fe7b5d05d18eff48080cce1869adfd601c71a06ee01f818a0010e2c38b30d45305c99765339917123ff300ca0de375263c2ef544a

doc/sendmail/Sendmail/index.html

Module `Sendmail`Source

Sourcetype domain = Colombe.Domain.t

Sourcetype reverse_path = Colombe.Reverse_path.t

Sourcetype forward_path = Colombe.Forward_path.t

Sourcetype mechanism =

| PLAIN
| LOGIN

Sourcetype authentication = {

username : string;
password : string;
mechanism : mechanism;

}

Sourcetype ('a, 's) stream = unit -> ('a option, 's) Colombe.Sigs.io

Sourcetype error = [

| `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 ]
| `Unsupported_mechanism
| `Encryption_required
| `Weak_mechanism
| `Authentication_rejected
| `Authentication_failed
| `Authentication_required

]

Sourceval pp_error : error Fmt.t

Source

val 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.