mime-mail-0.4.11: Compose MIME email messages.

Safe HaskellNone
LanguageHaskell98

Network.Mail.Mime

Contents

Synopsis

Datatypes

newtype Boundary Source

MIME boundary between parts of a message.

Constructors

Boundary 

Fields

unBoundary :: Text
 

data Mail Source

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

emptyMail :: Address -> Mail Source

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

type Alternatives = [Part] Source

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

data Part Source

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
 

data Encoding Source

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

Render a message

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

Render a Mail with a given RandomGen for producing boundaries.

renderMail' :: Mail -> IO ByteString Source

Like renderMail, but generates a random boundary.

Sending messages

sendmail :: ByteString -> IO () Source

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

sendmailCustom Source

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.

sendmailCustomCaptureOutput :: FilePath -> [String] -> ByteString -> IO (ByteString, ByteString) Source

Like sendmailCustom, but also returns sendmail's output to stderr and stdout as strict ByteStrings.

Since 0.4.9

renderSendMail :: Mail -> IO () Source

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

renderSendMailCustom Source

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 Source

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' Source

Arguments

:: Address

to

-> Address

from

-> Text

subject

-> Text

body

-> Mail 

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

simpleMailInMemory Source

Arguments

:: Address

to

-> Address

from

-> Text

subject

-> Text

plain body

-> Text

HTML body

-> [(Text, Text, ByteString)]

content type, file name and contents of attachments

-> Mail 

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

Since 0.4.7

Utilities

addPart :: Alternatives -> Mail -> Mail Source

Add an Alternative to the Mails parts.

To e.g. add a plain text body use > addPart [plainPart body] (emptyMail from)

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

Add an attachment from a file and construct a Part.

addAttachmentBS Source

Arguments

:: Text

content type

-> Text

file name

-> ByteString

content

-> Mail 
-> Mail 

Add an attachment from a ByteString and construct a Part.

Since 0.4.7

addAttachmentsBS :: [(Text, Text, ByteString)] -> Mail -> Mail Source

Since 0.4.7

renderAddress :: Address -> Text Source

Format an E-Mail address according to the name-addr form (see: RFC5322 § 3.4 "Address specification", i.e: [display-name] '<'addr-spec'>') This can be handy for adding custom headers that require such format.

Since: 0.4.11

htmlPart :: Text -> Part Source

Construct a UTF-8-encoded html Part.

plainPart :: Text -> Part Source

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

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

Generates a random sequence of alphanumerics of the given length.

quotedPrintable :: Bool -> ByteString -> Builder Source

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.