| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.Mail.Mime
Synopsis
- newtype Boundary = Boundary {
- unBoundary :: Text
- data Mail = Mail {}
- 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
- 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
MIME boundary between parts of a message.
Constructors
| Boundary | |
Fields
| |
An entire mail message.
Constructors
Fields
| |
Instances
| Generic Mail Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show Mail Source # | |||||
| type Rep Mail Source # | |||||
Defined in Network.Mail.Mime type Rep Mail = D1 ('MetaData "Mail" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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 Source #
A mail message with the provided from address and no other
fields filled in.
Constructors
| Address | |
Fields
| |
Instances
| IsString Address Source # | |||||
Defined in Network.Mail.Mime Methods fromString :: String -> Address | |||||
| Generic Address Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show Address Source # | |||||
| Eq Address Source # | |||||
| type Rep Address Source # | |||||
Defined in Network.Mail.Mime type Rep Address = D1 ('MetaData "Address" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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] Source #
Multiple alternative representations of the same data. For example, you could provide a plain-text and HTML version of a message.
A single part of a multipart message.
Constructors
| Part | |
Fields
| |
Instances
| Generic Part Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show Part Source # | |||||
| Eq Part Source # | |||||
| type Rep Part Source # | |||||
Defined in Network.Mail.Mime type Rep Part = D1 ('MetaData "Part" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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 Source #
NestedParts are for multipart-related: One HTML part and some inline images
Constructors
| PartContent ByteString | |
| NestedParts [Part] |
Instances
| Generic PartContent Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show PartContent Source # | |||||
Defined in Network.Mail.Mime Methods showsPrec :: Int -> PartContent -> ShowS show :: PartContent -> String showList :: [PartContent] -> ShowS | |||||
| Eq PartContent Source # | |||||
Defined in Network.Mail.Mime | |||||
| type Rep PartContent Source # | |||||
Defined in Network.Mail.Mime type Rep PartContent = D1 ('MetaData "PartContent" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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 Source #
Constructors
| AttachmentDisposition Text | |
| InlineDisposition Text | |
| DefaultDisposition |
Instances
| Generic Disposition Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show Disposition Source # | |||||
Defined in Network.Mail.Mime Methods showsPrec :: Int -> Disposition -> ShowS show :: Disposition -> String showList :: [Disposition] -> ShowS | |||||
| Eq Disposition Source # | |||||
Defined in Network.Mail.Mime | |||||
| type Rep Disposition Source # | |||||
Defined in Network.Mail.Mime type Rep Disposition = D1 ('MetaData "Disposition" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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))) | |||||
How to encode a single part. You should use Base64 for binary data.
Constructors
| None | |
| Base64 | |
| QuotedPrintableText | |
| QuotedPrintableBinary |
Instances
| Generic Encoding Source # | |||||
Defined in Network.Mail.Mime Associated Types
| |||||
| Show Encoding Source # | |||||
| Eq Encoding Source # | |||||
| type Rep Encoding Source # | |||||
Defined in Network.Mail.Mime type Rep Encoding = D1 ('MetaData "Encoding" "Network.Mail.Mime" "mime-mail-0.5.1-71br3DXmQV59v5xPUP2s2H" '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 Source #
Constructors
| InlineImage | |
Fields
| |
Instances
| Show InlineImage Source # | |
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 # | |
Defined in Network.Mail.Mime Methods showsPrec :: Int -> ImageContent -> ShowS show :: ImageContent -> String showList :: [ImageContent] -> ShowS | |
Render a message
renderMail :: RandomGen g => g -> Mail -> (ByteString, g) Source #
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.
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.
Arguments
| :: FilePath | sendmail executable path |
| -> [String] | sendmail command-line options |
mail to render and send | |
| -> IO () |
Render an email message and send via the specified sendmail executable with specified options.
High-level Mail creation
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.
A simple interface for generating an email with only plain-text body.
Arguments
| :: Address | to |
| -> Address | from |
| -> Text | subject |
| -> Text | plain body |
| -> Text | HTML body |
| -> [(Text, Text, ByteString)] | content type, file name and contents of attachments |
A simple interface for generating an email with HTML and plain-text
alternatives and some ByteString attachments.
Since 0.4.7
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 #
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
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 #