smtp-mail: Simple email sending via SMTP

[ bsd3, library, network ] [ Propose Tags ]

This packages provides a simple interface for mail over SMTP. PLease see the README for more information.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.1.3.0, 0.1.4.0, 0.1.4.1, 0.1.4.2, 0.1.4.3, 0.1.4.4, 0.1.4.5, 0.1.4.6, 0.2.0.0, 0.2.0.1, 0.3.0.0
Change log CHANGELOG.md
Dependencies array, base (>=4.5 && <5), base16-bytestring, base64-bytestring, bytestring, connection, cryptonite, filepath, memory, mime-mail, network, network-bsd, text [details]
License BSD-3-Clause
Author Jason Hickner, Matt Parsons
Maintainer parsonsmatt@gmail.com
Category Network
Home page http://github.com/jhickner/smtp-mail
Source repo head: git clone git@github.com:jhickner/smtp-mail.git
Uploaded by typetetris at 2020-07-24T07:04:58Z
Distributions Debian:0.1.4.6, LTSHaskell:0.1.4.6, NixOS:0.3.0.0
Downloads 11869 total (40 in the last 30 days)
Rating 2.0 (votes: 3) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for smtp-mail-0.3.0.0

[back to package description]

SMTP-MAIL

Making it easy to send SMTP emails from Haskell.

cabal install smtp-mail

Sending with an SMTP server

{-# LANGUAGE OverloadedStrings #-}

import Network.Mail.SMTP

from       = Address Nothing "email@domain.com"
to         = [Address (Just "Jason Hickner") "email@domain.com"]
cc         = []
bcc        = []
subject    = "email subject"
body       = plainTextPart "email body"
html       = htmlPart "<h1>HTML</h1>"

mail = simpleMail from to cc bcc subject [body, html]

main = sendMail host mail

or with an attachment:

main = do
  attachment <- filePart "application/octet-stream" "path/to/attachment.zip"
  let mail = simpleMail from to cc bcc subject [body, html, attachment]
  sendMail host mail

or, with authentication:

main = sendMailWithLogin host user pass mail

or, using STARTTLS:

main = sendMailSTARTTLS host mail

or, using SMTPS:

main = sendMailTLS host mail

Note: sendMail' and sendMailWithLogin' variations are also provided if you want to specify a port as well as a hostname.

Sending with sendmail

If you'd like to use sendmail, the sendmail interface from Network.Mail.Mime is reexported as well:

-- send via the default sendmail executable with default options
renderSendMail mail

-- send via the specified executable with specified options
renderSendMailCustom filepath [opts] mail

For more complicated scenarios or for adding attachments or CC/BCC addresses you can import Network.Mail.Mime and construct Mail objects manually.

Thanks

This library is based on code from HaskellNet, which appears to be no longer maintained. I've cleaned up the error handling, added some API functions to make common operations easier, and switched to ByteStrings where applicable.

Developing

nix-integration-test/integration-test.nix contains a integration test, which uses nixos qemu vm tests to start a qemu vm with a postfix and use smtp-mail to send mails to that postfix.

Install nix and execute nix-build nix-integration-test/integration-test.nix to execute the test. Success is signalled by a return code of 0.

Unconveniently it can't be run via github actions or travis, as it needs kvm virtualization.