Network.Mail.Mime

Datatypes

newtype Boundary

MIME boundary between parts of a message.

Constructors

Boundary

Fields

unBoundary :: Text

Instances

Show Boundary

Random Boundary

data Mail

An entire mail message.

Constructors

Mail

Fields

mailFrom :: Address

mailTo :: [Address]

mailCc :: [Address]

mailBcc :: [Address]

mailHeaders :: Headers

Other headers, excluding from, to, cc and bcc.

mailParts :: [Alternatives]

A list of different sets of alternatives. As a concrete example:

 mailParts = [ [textVersion, htmlVersion], [attachment1], [attachment1]]

Make sure when specifying alternatives to place the most preferred version last.

Instances

Show Mail

emptyMail :: Address -> Mail

A mail message with the provided from address and no other fields filled in.

data Address

Constructors

Address

Fields

addressName :: Maybe Text

addressEmail :: Text

Instances

Show Address

type Alternatives = [Part]

Multiple alternative representations of the same data. For example, you could provide a plain-text and HTML version of a message.

data Part

A single part of a multipart message.

Constructors

Part

Fields

partType :: Text

content type

partEncoding :: Encoding

partFilename :: Maybe Text

The filename for this part, if it is to be sent with an attachemnt disposition.

partHeaders :: Headers

partContent :: ByteString

Instances

Show Part

data Encoding

How to encode a single part. You should use Base64 for binary data.

Constructors

None

Base64

QuotedPrintableText

QuotedPrintableBinary

Instances

Show Encoding

type Headers = [(ByteString, Text)]

Render a message

renderMail :: RandomGen g => g -> Mail -> (ByteString, g)

Render a Mail with a given RandomGen for producing boundaries.

renderMail' :: Mail -> IO ByteString

Like renderMail, but generates a random boundary.

Sending messages

sendmail :: ByteString -> IO ()

Send a fully-formed email message via the default sendmail executable with default options.

sendmailCustom

Arguments

:: FilePath

sendmail executable path

-> [String]

sendmail command-line options

-> ByteString

mail message as lazy bytestring

-> IO ()

Send a fully-formed email message via the specified sendmail executable with specified options.

renderSendMail :: Mail -> IO ()

Render an email message and send via the default sendmail executable with default options.

renderSendMailCustom

Arguments

:: FilePath

sendmail executable path

-> [String]

sendmail command-line options

-> Mail

mail to render and send

-> IO ()

Render an email message and send via the specified sendmail executable with specified options.

High-level Mail creation

simpleMail

Arguments

:: Address

to

-> Address

from

-> Text

subject

-> Text

plain body

-> Text

HTML body

-> [(Text, FilePath)]

content type and path of attachments

-> IO Mail

A simple interface for generating an email with HTML and plain-text alternatives and some file attachments.

Note that we use lazy IO for reading in the attachment contents.

simpleMail'

Arguments

:: Address

to

-> Address

from

-> Text

subject

-> Text

body

-> Mail

A simple interface for generating an email with only plain-text body.

Utilities

addPart :: Alternatives -> Mail -> Mail

addAttachment :: Text -> FilePath -> Mail -> IO Mail

Add an attachment from a file and construct a Part.

addAttachments :: [(Text, FilePath)] -> Mail -> IO Mail

htmlPart :: Text -> Part

Construct a UTF-8-encoded html Part.

plainPart :: Text -> Part

Construct a UTF-8-encoded plain-text Part.

randomString :: RandomGen d => Int -> d -> (String, d)

Generates a random sequence of alphanumerics of the given length.

quotedPrintable :: Bool -> ByteString -> Builder

The first parameter denotes whether the input should be treated as text. If treated as text, then CRs will be stripped and LFs output as CRLFs. If binary, then CRs and LFs will be escaped.