Network.Mail.Mime

Datatypes

newtype Boundary

MIME boundary between parts of a message.

Constructors

Boundary

Fields

• unBoundary :: Text

Instances

Eq Boundary

Defined in Network.Mail.Mime

Methods

(==) :: Boundary -> Boundary -> Bool

(/=) :: Boundary -> Boundary -> Bool

Show Boundary

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Boundary -> ShowS

show :: Boundary -> String

showList :: [Boundary] -> ShowS

Random Boundary

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]

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

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Mail -> ShowS

show :: Mail -> String

showList :: [Mail] -> ShowS

Generic Mail

Defined in Network.Mail.Mime

Associated Types

type Rep Mail :: Type -> Type

Methods

from :: Mail -> Rep Mail x

to :: Rep Mail x -> Mail

type Rep Mail

Defined in Network.Mail.Mime

type Rep Mail = D1 ('MetaData "Mail" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) (C1 ('MetaCons "Mail" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mailFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Address) :*: (S1 ('MetaSel ('Just "mailTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Address]) :*: S1 ('MetaSel ('Just "mailCc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Address]))) :*: (S1 ('MetaSel ('Just "mailBcc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Address]) :*: (S1 ('MetaSel ('Just "mailHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Headers) :*: S1 ('MetaSel ('Just "mailParts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Alternatives])))))

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

Eq Address

Defined in Network.Mail.Mime

Methods

(==) :: Address -> Address -> Bool

(/=) :: Address -> Address -> Bool

Show Address

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

IsString Address

Defined in Network.Mail.Mime

Methods

fromString :: String -> Address

Generic Address

Defined in Network.Mail.Mime

Associated Types

type Rep Address :: Type -> Type

Methods

from :: Address -> Rep Address x

to :: Rep Address x -> Address

type Rep Address

Defined in Network.Mail.Mime

type Rep Address = D1 ('MetaData "Address" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) (C1 ('MetaCons "Address" 'PrefixI 'True) (S1 ('MetaSel ('Just "addressName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "addressEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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
• partDisposition :: Disposition

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

• partHeaders :: Headers
• partContent :: PartContent

Instances

Eq Part

Defined in Network.Mail.Mime

Methods

(==) :: Part -> Part -> Bool

(/=) :: Part -> Part -> Bool

Show Part

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Part -> ShowS

show :: Part -> String

showList :: [Part] -> ShowS

Generic Part

Defined in Network.Mail.Mime

Associated Types

type Rep Part :: Type -> Type

Methods

from :: Part -> Rep Part x

to :: Rep Part x -> Part

type Rep Part

Defined in Network.Mail.Mime

type Rep Part = D1 ('MetaData "Part" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) (C1 ('MetaCons "Part" 'PrefixI 'True) ((S1 ('MetaSel ('Just "partType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "partEncoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Encoding)) :*: (S1 ('MetaSel ('Just "partDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Disposition) :*: (S1 ('MetaSel ('Just "partHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Headers) :*: S1 ('MetaSel ('Just "partContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PartContent)))))

data PartContent

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

Constructors

PartContent ByteString

NestedParts [Part]

Instances

Eq PartContent

Defined in Network.Mail.Mime

Methods

(==) :: PartContent -> PartContent -> Bool

(/=) :: PartContent -> PartContent -> Bool

Show PartContent

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> PartContent -> ShowS

show :: PartContent -> String

showList :: [PartContent] -> ShowS

Generic PartContent

Defined in Network.Mail.Mime

Associated Types

type Rep PartContent :: Type -> Type

Methods

from :: PartContent -> Rep PartContent x

to :: Rep PartContent x -> PartContent

type Rep PartContent

Defined in Network.Mail.Mime

type Rep PartContent = D1 ('MetaData "PartContent" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) (C1 ('MetaCons "PartContent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "NestedParts" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Part])))

data Disposition

Constructors

AttachmentDisposition Text

InlineDisposition Text

DefaultDisposition

Instances

Eq Disposition

Defined in Network.Mail.Mime

Methods

(==) :: Disposition -> Disposition -> Bool

(/=) :: Disposition -> Disposition -> Bool

Show Disposition

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Disposition -> ShowS

show :: Disposition -> String

showList :: [Disposition] -> ShowS

Generic Disposition

Defined in Network.Mail.Mime

Associated Types

type Rep Disposition :: Type -> Type

Methods

from :: Disposition -> Rep Disposition x

to :: Rep Disposition x -> Disposition

type Rep Disposition

Defined in Network.Mail.Mime

type Rep Disposition = D1 ('MetaData "Disposition" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) (C1 ('MetaCons "AttachmentDisposition" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "InlineDisposition" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "DefaultDisposition" 'PrefixI 'False) (U1 :: Type -> Type)))

data Encoding

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

Constructors

None

Base64

QuotedPrintableText

QuotedPrintableBinary

Instances

Eq Encoding

Defined in Network.Mail.Mime

Methods

(==) :: Encoding -> Encoding -> Bool

(/=) :: Encoding -> Encoding -> Bool

Show Encoding

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

Generic Encoding

Defined in Network.Mail.Mime

Associated Types

type Rep Encoding :: Type -> Type

Methods

from :: Encoding -> Rep Encoding x

to :: Rep Encoding x -> Encoding

type Rep Encoding

Defined in Network.Mail.Mime

type Rep Encoding = D1 ('MetaData "Encoding" "Network.Mail.Mime" "mime-mail-0.5.1-66CNjK9GzUy1UxWBoGDjk9" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Base64" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "QuotedPrintableText" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "QuotedPrintableBinary" 'PrefixI 'False) (U1 :: Type -> Type)))

data InlineImage

Constructors

InlineImage

Fields

• imageContentType :: Text
• imageContent :: ImageContent
• imageCID :: Text

Instances

Show InlineImage

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> InlineImage -> ShowS

show :: InlineImage -> String

showList :: [InlineImage] -> ShowS

data ImageContent

Constructors

ImageFilePath FilePath

ImageByteString ByteString

Instances

Show ImageContent

Defined in Network.Mail.Mime

Methods

showsPrec :: Int -> ImageContent -> ShowS

show :: ImageContent -> String

showList :: [ImageContent] -> ShowS

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.

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

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

Since 0.4.9

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.

simpleMailInMemory

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

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

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

Add an attachment from a file and construct a Part.

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

addAttachmentBS

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

Since 0.4.7

renderAddress :: Address -> Text

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

Construct a UTF-8-encoded html Part.

plainPart :: Text -> Part

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

filePart :: Text -> FilePath -> IO Part

Construct a BASE64-encoded file attachment Part

Since 0.5.0

filePartBS :: Text -> Text -> ByteString -> Part

Construct a BASE64-encoded file attachment Part

Since 0.5.0

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.

relatedPart :: [Part] -> Part

Add a Related Part

addImage :: InlineImage -> IO Part

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

Since 0.5.0

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