davidalphafox / letters

Letters is an OCaml library for creating and sending emails over SMTP using LWT

✉ Letters ·

Letters is a library for creating and sending emails over SMTP using Lwt.

Setup

opam switch create . ocaml-base-compiler.4.08.1
opam install --deps-only -y . --with-test

Build

dune build

Run Tests

First create ethereal.email account and store account details

curl -d '{ "requestor": "letters", "version": "0.1.0" }' "https://api.nodemailer.com/user" -X POST -H "Content-Type: application/json" > ethereal_account.json

Currently using ethereal.email service requires non-released version of colombe and you need to check out the project, commit edf757c58fce58c170c63e8a92d3bc81fe4d32ff contains the needed fix. Then the version with the fix needs to be pinned in the build env:

cd /path/to/colombe
opam switch /path/to/letters
# Follow instructions to evaluate the environment
git switch --detach edf757c58fce58c170c63e8a92d3bc81fe4d32ff
opam pin .
# Finally, return back to letters project
cd /path/to/letters

Then execute the tests

dune test

And finally review that the email is correctly generated in the service:

• login to https://ethereal.email/login using credentials from the ethereal_account.json
• check the content of messages: https://ethereal.email/messages

Credits

This project is build on colombe and mrmime libraries and use facteur as starting point.

License

Copyright (c) 2020 Miko Nieminen

Distributed under the MIT License.