package sendmail

You can search for identifiers within the package.

in-package search v0.2.0

package sendmail

sendmail
- Sendmail
sendmail.starttls
- Sendmail_with_starttls
  - Context_with_tls
  - Make_with_tls
    
    Value
  - S
    
    Value
  - VALUE
  - Value

Legend:
Library
Module
Module type
Parameter
Class
Class type

type domain = Colombe.Domain.t

type reverse_path = Colombe.Reverse_path.t

type forward_path = Colombe.Forward_path.t

type mechanism =

| PLAIN

type authentication = {

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

}

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

type error = [

| `Protocol of [ Colombe.Request.Encoder.error | Colombe.Reply.Decoder.error | `Unexpected_response of int * string list ]
| `Unsupported_mechanism
| `Encryption_required
| `Weak_mechanism
| `Authentication_rejected
| `Authentication_failed
| `Authentication_required

]

val pp_error : error Fmt.t

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.