Network.Email.Header.Render

Rendering common header fields. This module is intended to be imported qualified:

import qualified Network.Email.Header.Render as R

Rendering options

data RenderOptions

Rendering options.

Constructors

RenderOptions

Fields

lineWidth :: Int

The maximum line width.

indent :: Int

The indent of each line, in spaces.

charset :: Charset

The charset used to encode text outside US-ASCII range.

encoding :: Encoding

The header encoding used for encoded words.

Instances

Eq RenderOptions

Show RenderOptions

data Encoding

The encoding used for binary characters in an encoded word.

Constructors

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

Enum Encoding

Eq Encoding

Ord Encoding

Read Encoding

Show Encoding

defaultRenderOptions :: RenderOptions

Default rendering options, which uses a line width of 80, and indent of 2, and utf-8 quated-printable encoding.

Rendering

data Doc

A formatted email header.

Instances

IsString Doc

Monoid Doc

renderHeaders :: RenderOptions -> [(HeaderName, Doc)] -> Headers

Render a list of headers.

Origination date field

date :: ZonedTime -> (HeaderName, Doc)

Create a Date: field.

Originator fields

from :: [Mailbox] -> (HeaderName, Doc)

Create a From: field.

sender :: Mailbox -> (HeaderName, Doc)

Create a Sender: field.

replyTo :: [Recipient] -> (HeaderName, Doc)

Create a Reply-To: field.

Destination address fields

to :: [Recipient] -> (HeaderName, Doc)

Create a To: field.

cc :: [Recipient] -> (HeaderName, Doc)

Create a Cc: field.

bcc :: Maybe [Recipient] -> (HeaderName, Doc)

Create a Bcc: field.

Identification fields

messageID :: MessageID -> (HeaderName, Doc)

Create a Message-ID: field.

inReplyTo :: [MessageID] -> (HeaderName, Doc)

Create a In-Reply-To: field.

references :: [MessageID] -> (HeaderName, Doc)

Create a References: field.

Informational fields

subject :: Text -> (HeaderName, Doc)

Create a Subject: field.

comments :: Text -> (HeaderName, Doc)

Create a Comments: field.

keywords :: [Text] -> (HeaderName, Doc)

Create a Keywords: field.

Resent fields

resentDate :: ZonedTime -> (HeaderName, Doc)

Create a Resent-Date: field.

resentFrom :: [Mailbox] -> (HeaderName, Doc)

Create a Resent-From: field.

resentSender :: Mailbox -> (HeaderName, Doc)

Create a Resent-Sender: field.

resentTo :: [Recipient] -> (HeaderName, Doc)

Create a Resent-To: field.

resentCc :: [Recipient] -> (HeaderName, Doc)

Create a Resent-Cc: field.

resentBcc :: Maybe [Recipient] -> (HeaderName, Doc)

Create a Resent-Bcc: field.

resentMessageID :: MessageID -> (HeaderName, Doc)

Create a Resent-Message-ID: field.

MIME fields

mimeVersion :: Int -> Int -> (HeaderName, Doc)

Create a MIME-Version: field.

contentType :: MimeType -> Parameters -> (HeaderName, Doc)

Create a Content-Type: field.

contentTransferEncoding :: CI ByteString -> (HeaderName, Doc)

Create a Content-Transfer-Encoding: field.

contentID :: MessageID -> (HeaderName, Doc)

Create a Content-ID: field.