A little library to parse or emit a Received field according RFC5321. It is able to notify which SMTP server serves the email (and track, by this way, on which way - TLS or not - the email was transmitted).
Published: 08 Mar 2023
Colombe - an implementation of SMTP protocol in OCaml
colombe is a little library which wants to implement the SMTP protocol according RFC5321. It is a low-level library used by some others projects to implements clients or servers.
The library does not handle properly an email. If you want to generate a proper email or introspect an email, you should be interested by mrmime.
As a client
The distribution provides
sendmail-lwt which are respectively:
An agnostic (to the system) implementation of an usual client with authentication
An agnostic (to the system) implementation of an usual client with authentication and
An LWT implementation of an usual client with authentication
Depending on your context:
If you want to communicate with a SMTP server which require a TLS connection (like,
sendmailwith a scheduler such as LWT or ASYNC (or UNIX) should be use.
sendmail-lwtis a specialization with LWT.
If you want to communicate with a SMTP server which handles (and surely requires)
sendmail.starttlswith a scheduler should be use.
Of course, a client can be more complex and can handle:
a well formed email
some usual metadata such as the timezone
If you are interested by that, you should look into facteur which wants to provide a little binary to send an email with a nice use between
mrmime and some others MirageOS projects.
As a server
colombe implements both sides. By this library, you are able to implement an SMTP server - if you are interested by that, you should look into ptt.
How to use
As we said, the library wants to be a low-level one. At least, the core does not handle properly eSMTP extensions or any high mechanisms such the authentication. It's mostly because the library wants to be used by a server implementation and a client implementation.
It only ensures a high abstracted interface on top of the low-level of the communication. The library defines only few parts of the SMTP protocol and a monadic interface to describe the state-machine while the communication with an other peer.
sendmail is a good example about how to use
colombe. It describes structurally the SMTP protocol (only what it really needs) and the state machine to send an email.
RFC5321 describes the SMTP protocols and some mechanisms such as the
Received: field. The distribution provides a way to introspect
Received: fields (and can produce a graph of them) or generate them from a server configuration.
colombe has received funding from the Next Generation Internet Initiative (NGI) within the framework of the DAPSI Project.