package sendmail

  1. Overview
  2. Docs
Implementation of the sendmail command

Install 

dune-project
 Dependency

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

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-v0.3.0.tbz
sha256=e191073dd4d984cd63e5a78debbc481e4fa1c5a543c756fedef9f82c40962c73
sha512=6c7279d2df763ec43f09a083feaf8285d4c90df22e9749dc404f8e96d34c5ec7f047b8c54f46c8e9e1d70fda603ab5c3ba3da99333d21c95e16ca9442fd1d573

doc/sendmail.tls/Sendmail_with_tls/index.html

Module Sendmail_with_tlsSource

Sourcemodule Context_with_tls : sig ... end
Sourcemodule type VALUE = sig ... end
Sourcemodule Value : sig ... end
Sourcemodule type S = sig ... end
Sourcetype domain = Colombe.Domain.t
Sourcetype reverse_path = Colombe.Reverse_path.t
Sourcetype forward_path = Colombe.Forward_path.t
Sourcetype mechanism = Sendmail.mechanism
Sourcetype authentication = Sendmail.authentication
Sourcetype ('a, 's) stream = ('a, 's) Sendmail.stream
Sourcetype error = [
  1. | `Tls of [ `Protocol of Value.error | `Tls_alert of Tls.Packet.alert_type | `Tls_failure of Tls.Engine.failure ]
  2. | `Protocol of [ `Protocol of Value.error | `Tls_alert of Tls.Packet.alert_type | `Tls_failure of Tls.Engine.failure ]
  3. | `Unsupported_mechanism
  4. | `Encryption_required
  5. | `Weak_mechanism
  6. | `Authentication_rejected
  7. | `Authentication_failed
  8. | `Authentication_required
  9. | `STARTTLS_unavailable
]
Sourceval pp_error : error Fmt.t
Sourceval sendmail : 's Colombe.Sigs.impl -> ('flow, 's) Colombe.Sigs.rdwr -> 'flow -> Context_with_tls.t -> Tls.Config.client -> ?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 tls_config ?authentication ~domain sender recipients mail where:

  • impl is the scheduler (unix, lwt or async)
  • rdwr read/write syscall
  • flow witness of the flow (can be a socket)
  • ctx context used by the process
  • tls_config TLS configuration used by STARTTLS
  • 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. It ensures to use STARTTLS (eg. RFC3207) while the process according TLS configuration tls_config. If authentication is given, it does the authentication only while TLS flow. Mail is sended only while TLS flow.