https://github.com/haskell-github-trust/smtp-mail
Simple email sending via SMTP
https://github.com/haskell-github-trust/smtp-mail
Last synced: 9 months ago
JSON representation
Simple email sending via SMTP
- Host: GitHub
- URL: https://github.com/haskell-github-trust/smtp-mail
- Owner: haskell-github-trust
- License: other
- Created: 2024-03-29T01:13:17.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-19T04:43:29.000Z (9 months ago)
- Last Synced: 2025-04-23T03:48:17.706Z (9 months ago)
- Language: Haskell
- Homepage: https://hackage.haskell.org/package/smtp-mail
- Size: 98.6 KB
- Stars: 5
- Watchers: 11
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
SMTP-MAIL
=========
Making it easy to send SMTP emails from Haskell.
```
cabal install smtp-mail
```
### Sending with an SMTP server
```haskell
{-# 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 "
HTML
"
mail = simpleMail from to cc bcc subject [body, html]
main = sendMail host mail
```
or with an attachment:
```haskell
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:
```haskell
main = sendMailWithLogin host user pass mail
```
or, using STARTTLS:
```haskell
main = sendMailSTARTTLS host mail
```
or, using SMTPS:
```haskell
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:
```haskell
-- 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/` 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](https://nixos.org), enable [flakes](https://nixos.wiki/wiki/Flakes) and execute
`nix flake check` to execute the test. Success is signalled by a return code of `0`.