Safe Haskell | None |
---|---|
Language | Haskell98 |
Rendering common header fields. This module is intended to be imported qualified:
import qualified Network.Email.Header.Render as R
Synopsis
- data RenderOptions = RenderOptions {}
- data Encoding
- defaultRenderOptions :: RenderOptions
- data Doc
- renderHeaders :: RenderOptions -> [(HeaderName, Doc)] -> Headers
- date :: ZonedTime -> (HeaderName, Doc)
- from :: [Mailbox] -> (HeaderName, Doc)
- sender :: Mailbox -> (HeaderName, Doc)
- replyTo :: [Recipient] -> (HeaderName, Doc)
- to :: [Recipient] -> (HeaderName, Doc)
- cc :: [Recipient] -> (HeaderName, Doc)
- bcc :: Maybe [Recipient] -> (HeaderName, Doc)
- messageID :: MessageID -> (HeaderName, Doc)
- inReplyTo :: [MessageID] -> (HeaderName, Doc)
- references :: [MessageID] -> (HeaderName, Doc)
- subject :: Text -> (HeaderName, Doc)
- comments :: Text -> (HeaderName, Doc)
- keywords :: [Text] -> (HeaderName, Doc)
- resentDate :: ZonedTime -> (HeaderName, Doc)
- resentFrom :: [Mailbox] -> (HeaderName, Doc)
- resentSender :: Mailbox -> (HeaderName, Doc)
- resentTo :: [Recipient] -> (HeaderName, Doc)
- resentCc :: [Recipient] -> (HeaderName, Doc)
- resentBcc :: Maybe [Recipient] -> (HeaderName, Doc)
- resentMessageID :: MessageID -> (HeaderName, Doc)
- mimeVersion :: Int -> Int -> (HeaderName, Doc)
- contentType :: MimeType -> Parameters -> (HeaderName, Doc)
- contentTransferEncoding :: CI ByteString -> (HeaderName, Doc)
- contentID :: MessageID -> (HeaderName, Doc)
Rendering options
data RenderOptions Source #
Rendering options.
Instances
Eq RenderOptions Source # | |
Defined in Network.Email.Header.Doc (==) :: RenderOptions -> RenderOptions -> Bool # (/=) :: RenderOptions -> RenderOptions -> Bool # | |
Show RenderOptions Source # | |
Defined in Network.Email.Header.Doc showsPrec :: Int -> RenderOptions -> ShowS # show :: RenderOptions -> String # showList :: [RenderOptions] -> ShowS # |
The encoding used for binary characters in an encoded word.
QP | Quoted-printable encoding. Spaces are represented with underscores, and undisplayable characters are represented as hex pairs. |
Base64 | Base 64 encoding of all characters. |
Instances
Bounded Encoding Source # | |
Enum Encoding Source # | |
Defined in Network.Email.Header.Doc | |
Eq Encoding Source # | |
Ord Encoding Source # | |
Defined in Network.Email.Header.Doc | |
Read Encoding Source # | |
Show Encoding Source # | |
defaultRenderOptions :: RenderOptions Source #
Default rendering options, which uses a line width of 80, and indent of 2, and utf-8 quated-printable encoding.
Rendering
A formatted email header.
renderHeaders :: RenderOptions -> [(HeaderName, Doc)] -> Headers Source #
Render a list of headers.
Origination date field
Originator fields
Destination address fields
Identification fields
references :: [MessageID] -> (HeaderName, Doc) Source #
Create a References:
field.
Informational fields
Resent fields
resentDate :: ZonedTime -> (HeaderName, Doc) Source #
Create a Resent-Date:
field.
resentFrom :: [Mailbox] -> (HeaderName, Doc) Source #
Create a Resent-From:
field.
resentSender :: Mailbox -> (HeaderName, Doc) Source #
Create a Resent-Sender:
field.
resentMessageID :: MessageID -> (HeaderName, Doc) Source #
Create a Resent-Message-ID:
field.
MIME fields
mimeVersion :: Int -> Int -> (HeaderName, Doc) Source #
Create a MIME-Version:
field.
contentType :: MimeType -> Parameters -> (HeaderName, Doc) Source #
Create a Content-Type:
field.
contentTransferEncoding :: CI ByteString -> (HeaderName, Doc) Source #
Create a Content-Transfer-Encoding:
field.