Modulemime-mail-0.5.2Haskell2010

Network.Mail.Mime

Contents

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

Synopsis

newtype Boundary
data Mail
value emptyMail
data Address
type Alternatives
data Part
data PartContent
data Disposition
data Encoding
data InlineImage
data ImageContent
type Headers
value renderMail
value renderMail'
value sendmail
value sendmailCustom
value sendmailCustomCaptureOutput
value renderSendMail
value renderSendMailCustom
value simpleMail
value simpleMail'
value simpleMailInMemory
value simpleMailWithImages
value addPart
value addAttachment
value addAttachments
value addAttachmentBS
value addAttachmentsBS
value renderAddress
value htmlPart
value plainPart
value filePart
value filePartBS
value randomString
value quotedPrintable
value relatedPart
value addImage
value mkImageParts

Packagemime-mail-0.5.2
Exports38
LanguageHaskell2010
LicenceMIT
SourceMime.hs

Datatypes

newtypenewtype Boundary

Source#

MIME boundary between parts of a message.

Constructors

Boundary
- unBoundary :: Text

Instances3Eq, Show, Random

Eq BoundaryDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show BoundaryDefined in mime-mail-0.5.2 · Network.Mail.Mime
Random BoundaryDefined in mime-mail-0.5.2 · Network.Mail.Mime

datadata Mail

Source#

An entire mail message.

Constructors

Mail
- 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.

Instances4Eq, Show, Generic, Rep

Eq MailDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show MailDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic MailDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep Mail = D1 ('MetaData "Mail" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" '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])))))Defined in mime-mail-0.5.2 · Network.Mail.Mime

valueemptyMail :: Address -> Mail

Source#

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

datadata Address

Constructors

Address
- addressName :: Maybe Text
- addressEmail :: Text

Instances5Eq, Show, IsString, Generic, Rep

Eq AddressDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show AddressDefined in mime-mail-0.5.2 · Network.Mail.Mime
IsString AddressDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic AddressDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep Address = D1 ('MetaData "Address" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" '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)))Defined in mime-mail-0.5.2 · Network.Mail.Mime

typetype Alternatives = [Part]

Source#

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

datadata Part

Source#

A single part of a multipart message.

Constructors

Part
- partType :: Text
  content type
- partEncoding :: Encoding
- partDisposition :: Disposition
  The filename for this part, if it is to be sent with an attachment disposition.
- partHeaders :: Headers
- partContent :: PartContent

Instances4Eq, Show, Generic, Rep

Eq PartDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show PartDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic PartDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep Part = D1 ('MetaData "Part" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" '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)))))Defined in mime-mail-0.5.2 · Network.Mail.Mime

datadata PartContent

Source#

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

Constructors

PartContent ByteString
NestedParts [Part]

Instances4Eq, Show, Generic, Rep

Eq PartContentDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show PartContentDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic PartContentDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep PartContent = D1 ('MetaData "PartContent" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" 'False) (C1 ('MetaCons "PartContent" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "NestedParts" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Part])))Defined in mime-mail-0.5.2 · Network.Mail.Mime

datadata Disposition

Constructors

AttachmentDisposition Text
InlineDisposition Text
DefaultDisposition

Instances4Eq, Show, Generic, Rep

Eq DispositionDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show DispositionDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic DispositionDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep Disposition = D1 ('MetaData "Disposition" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" 'False) (C1 ('MetaCons "AttachmentDisposition" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "InlineDisposition" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "DefaultDisposition" 'PrefixI 'False) U1))Defined in mime-mail-0.5.2 · Network.Mail.Mime

datadata Encoding

Source#

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

None Base64 QuotedPrintableText QuotedPrintableBinary

Instances4Eq, Show, Generic, Rep

Eq EncodingDefined in mime-mail-0.5.2 · Network.Mail.Mime
Show EncodingDefined in mime-mail-0.5.2 · Network.Mail.Mime
Generic EncodingDefined in mime-mail-0.5.2 · Network.Mail.Mime
type Rep Encoding = D1 ('MetaData "Encoding" "Network.Mail.Mime" "mime-mail-0.5.2-GWJNJFr51vL5iwgspLD6co" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Base64" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "QuotedPrintableText" 'PrefixI 'False) U1 :+: C1 ('MetaCons "QuotedPrintableBinary" 'PrefixI 'False) U1))Defined in mime-mail-0.5.2 · Network.Mail.Mime

datadata InlineImage

Constructors

InlineImage
- imageContentType :: Text
- imageContent :: ImageContent
- imageCID :: Text

Instances1Show

Show InlineImageDefined in mime-mail-0.5.2 · Network.Mail.Mime

datadata ImageContent

Constructors

ImageFilePath FilePath
ImageByteString ByteString

Instances1Show

Show ImageContentDefined in mime-mail-0.5.2 · Network.Mail.Mime

typetype Headers = [(ByteString, Text)]

Render a message

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

Source#

Render a Mail with a given RandomGen for producing boundaries.

valuerenderMail' :: Mail -> IO ByteString

Source#

Like renderMail, but generates a random boundary.

Sending messages

valuesendmail :: ByteString -> IO ()

Source#

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

valuesendmailCustom

:: FilePath
sendmail executable path
-> [String]
sendmail command-line options
-> ByteString
mail message as lazy bytestring
-> IO ()

Source#

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

valuesendmailCustomCaptureOutput

Source#

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

Since 0.4.9

valuerenderSendMail :: Mail -> IO ()

Source#

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

valuerenderSendMailCustom

:: FilePath
sendmail executable path
-> [String]
sendmail command-line options
-> Mail
mail to render and send
-> IO ()

Source#

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

High-level Mail creation

valuesimpleMail

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

Source#

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.

valuesimpleMail'

:: Address
to
-> Address
from
-> Text
subject
-> Text
body
-> Mail

Source#

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

valuesimpleMailInMemory

:: Address
to
-> Address
from
-> Text
subject
-> Text
plain body
-> Text
HTML body
-> [(Text, Text, ByteString)]
content type, file name and contents of attachments
-> Mail

Source#

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

Since 0.4.7

valuesimpleMailWithImages

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

Source#

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

valueaddPart :: 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)

valueaddAttachment :: Text -> FilePath -> Mail -> IO Mail

Source#

Add an attachment from a file and construct a Part.

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

valueaddAttachmentBS

:: Text
content type
-> Text
file name
-> ByteString
content
-> Mail
-> Mail

Source#

Add an attachment from a ByteString and construct a Part.

Since 0.4.7

valueaddAttachmentsBS :: [(Text, Text, ByteString)] -> Mail -> Mail

Source#

Since 0.4.7

valuerenderAddress :: 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.

valuehtmlPart :: Text -> Part

Source#

Construct a UTF-8-encoded html Part.

valueplainPart :: Text -> Part

Source#

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

valuefilePart :: Text -> FilePath -> IO Part

Source#

Construct a BASE64-encoded file attachment Part

Since 0.5.0

valuefilePartBS :: Text -> Text -> ByteString -> Part

Source#

Construct a BASE64-encoded file attachment Part

Since 0.5.0

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

Source#

Generates a random sequence of alphanumerics of the given length.

valuequotedPrintable :: 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.

valuerelatedPart :: [Part] -> Part

Source#

Add a Related Part

valueaddImage :: InlineImage -> IO Part

Source#

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

Since 0.5.0

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