package letters
Install
Dune Dependency
Authors
Maintainers
Sources
md5=258ddf3e1868e910091c3bbf80e74bf7
sha512=97f8df2e251c04f0e150c00959f6dc66e69324430b86e4b64b329ac00b77b2d21aac2e1b1d554f6ec08af1184ccd69d92ab7984ba7a13b8e983d1071f34b8e80
doc/letters/Letters/index.html
Module LettersSource
Configuration providing needed information to connect to the SMTP server.
val build_email :
from:string ->
recipients:recipient list ->
subject:string ->
body:body ->
(Mrmime.Mt.t, string) resultBuild an email using mrmime
This function is a helper function to simplify process of building an email with `mrmime`. It will return result type and wraps all exceptions into Error
from string representation of the email proved as a `from` field, this can be a different email address than the config.sender.
recipients list of email recipients
subject the single line string used as the email `subject` field
body string representation of the actual email message that can be either plain text or HTML message
Returns result indicating if built email is valid or Error if anything failed
val send :
config:Config.t ->
sender:string ->
recipients:recipient list ->
message:Mrmime.Mt.t ->
unit Lwt.tSend the previously generated email
This function expects valid configuration, list of recipients and finally a valid `mrmime` representation of the email message.
config valid configuration to connect the SMTP server.
recipients list of valid email addresses.
message valid `mrmime` representation of the email message.
Runs asynchronously using Lwt and retuns unit when the message is sent successfully. If anything fails during the process, throws an exception.