Safe Haskell	None
Language	Haskell98

Network.Mail.Mime

Contents

Datatypes
Render a message
Sending messages
High-level Mail creation
Utilities

Synopsis

newtype Boundary = Boundary {
- unBoundary :: Text
}
data Mail = Mail {
- mailFrom :: Address
- mailTo :: [Address]
- mailCc :: [Address]
- mailBcc :: [Address]
- mailHeaders :: Headers
- mailParts :: [Alternatives]
}
emptyMail :: Address -> Mail
data Address = Address {
- addressName :: Maybe Text
- addressEmail :: Text
}
type Alternatives = [Part]
data Part = Part {
- partType :: Text
- partEncoding :: Encoding
- partDisposition :: Disposition
- partHeaders :: Headers
- partContent :: PartContent
}
data PartContent
- = PartContent ByteString
- | NestedParts [Part]
data Disposition
- = AttachmentDisposition Text
- | InlineDisposition Text
- | DefaultDisposition
data Encoding
- = None
- | Base64
- | QuotedPrintableText
- | QuotedPrintableBinary
data InlineImage = InlineImage {
- imageContentType :: Text
- imageContent :: ImageContent
- imageCID :: Text
}
data ImageContent
- = ImageFilePath FilePath
- | ImageByteString ByteString
type Headers = [(ByteString, Text)]
renderMail :: RandomGen g => g -> Mail -> (ByteString, g)
renderMail' :: Mail -> IO ByteString
sendmail :: ByteString -> IO ()
sendmailCustom :: FilePath -> [String] -> ByteString -> IO ()
sendmailCustomCaptureOutput :: FilePath -> [String] -> ByteString -> IO (ByteString, ByteString)
renderSendMail :: Mail -> IO ()
renderSendMailCustom :: FilePath -> [String] -> Mail -> IO ()
simpleMail :: Address -> Address -> Text -> Text -> Text -> [(Text, FilePath)] -> IO Mail
simpleMail' :: Address -> Address -> Text -> Text -> Mail
simpleMailInMemory :: Address -> Address -> Text -> Text -> Text -> [(Text, Text, ByteString)] -> Mail
simpleMailWithImages :: [Address] -> Address -> Text -> Text -> Text -> [InlineImage] -> [(Text, FilePath)] -> IO Mail
addPart :: Alternatives -> Mail -> Mail
addAttachment :: Text -> FilePath -> Mail -> IO Mail
addAttachments :: [(Text, FilePath)] -> Mail -> IO Mail
addAttachmentBS :: Text -> Text -> ByteString -> Mail -> Mail
addAttachmentsBS :: [(Text, Text, ByteString)] -> Mail -> Mail
renderAddress :: Address -> Text
htmlPart :: Text -> Part
plainPart :: Text -> Part
filePart :: Text -> FilePath -> IO Part
filePartBS :: Text -> Text -> ByteString -> Part
randomString :: RandomGen d => Int -> d -> (String, d)
quotedPrintable :: Bool -> ByteString -> Builder
relatedPart :: [Part] -> Part
addImage :: InlineImage -> IO Part
mkImageParts :: [InlineImage] -> IO [Part]

Datatypes

newtype Boundary Source #

MIME boundary between parts of a message.

Constructors

Boundary
Fields unBoundary :: Text

Instances

Eq Boundary Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: Boundary -> Boundary -> Bool # (/=) :: Boundary -> Boundary -> Bool #
Show Boundary Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Boundary -> ShowS # show :: Boundary -> String # showList :: [Boundary] -> ShowS #
Random Boundary Source #
Instance details Defined in Network.Mail.Mime Methods randomR :: RandomGen g => (Boundary, Boundary) -> g -> (Boundary, g) # random :: RandomGen g => g -> (Boundary, g) # randomRs :: RandomGen g => (Boundary, Boundary) -> g -> [Boundary] # randoms :: RandomGen g => g -> [Boundary] # randomRIO :: (Boundary, Boundary) -> IO Boundary # randomIO :: IO Boundary #

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

Show Mail Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Mail -> ShowS # show :: Mail -> String # showList :: [Mail] -> ShowS #

emptyMail :: Address -> Mail Source #

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

data Address Source #

Constructors

Address
Fields addressName :: Maybe Text addressEmail :: Text

Instances

Eq Address Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Show Address Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
IsString Address Source #
Instance details Defined in Network.Mail.Mime Methods fromString :: String -> Address #

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 partDisposition :: Disposition The filename for this part, if it is to be sent with an attachemnt disposition. partHeaders :: Headers partContent :: PartContent

Instances

Eq Part Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: Part -> Part -> Bool # (/=) :: Part -> Part -> Bool #
Show Part Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Part -> ShowS # show :: Part -> String # showList :: [Part] -> ShowS #

data PartContent Source #

NestedParts are for multipart-related: One HTML part and some inline images

Constructors

PartContent ByteString
NestedParts [Part]

Instances

Eq PartContent Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: PartContent -> PartContent -> Bool # (/=) :: PartContent -> PartContent -> Bool #
Show PartContent Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> PartContent -> ShowS # show :: PartContent -> String # showList :: [PartContent] -> ShowS #

data Disposition Source #

Constructors

AttachmentDisposition Text
InlineDisposition Text
DefaultDisposition

Instances

Eq Disposition Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: Disposition -> Disposition -> Bool # (/=) :: Disposition -> Disposition -> Bool #
Show Disposition Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Disposition -> ShowS # show :: Disposition -> String # showList :: [Disposition] -> ShowS #

data Encoding Source #

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

Constructors

None
Base64
QuotedPrintableText
QuotedPrintableBinary

Instances

Eq Encoding Source #
Instance details Defined in Network.Mail.Mime Methods (==) :: Encoding -> Encoding -> Bool # (/=) :: Encoding -> Encoding -> Bool #
Show Encoding Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> Encoding -> ShowS # show :: Encoding -> String # showList :: [Encoding] -> ShowS #

data InlineImage Source #

Constructors

InlineImage
Fields imageContentType :: Text imageContent :: ImageContent imageCID :: Text

Instances

Show InlineImage Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> InlineImage -> ShowS # show :: InlineImage -> String # showList :: [InlineImage] -> ShowS #

data ImageContent Source #

Constructors

ImageFilePath FilePath
ImageByteString ByteString

Instances

Show ImageContent Source #
Instance details Defined in Network.Mail.Mime Methods showsPrec :: Int -> ImageContent -> ShowS # show :: ImageContent -> String # showList :: [ImageContent] -> ShowS #

type Headers = [(ByteString, Text)] Source #

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

simpleMailWithImages Source #

Arguments

:: [Address]	to (multiple)
-> Address	from
-> Text	subject
-> Text	plain body
-> Text	HTML body
-> [InlineImage]
-> [(Text, FilePath)]	content type and path of attachments
-> IO Mail

An interface for generating an email with HTML and plain-text alternatives, some file attachments, and inline images. Note that we use lazy IO for reading in the attachment and inlined images. Inline images can be referred to from the HTML content using the src="cid:{{CONTENT-ID}}" syntax, where CONTENT-ID is the filename of the image.

Since 0.5.0

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.

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

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.

filePart :: Text -> FilePath -> IO Part Source #

Construct a BASE64-encoded file attachment Part

Since 0.5.0

filePartBS :: Text -> Text -> ByteString -> Part Source #

Construct a BASE64-encoded file attachment Part

Since 0.5.0

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.

relatedPart :: [Part] -> Part Source #

Add a Related Part

addImage :: InlineImage -> IO Part Source #

Add an inline image from a file and construct a Part.

Since 0.5.0

mkImageParts :: [InlineImage] -> IO [Part] Source #

Datatypes

Render a message

Sending messages

High-level Mail creation

Utilities

High-level `Mail` creation