Network.Email.Header.Doc

Header formatting and pretty-printing.

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

render :: RenderOptions -> Int -> Doc -> Builder

Render a document with the given options and initial position.

Construction

prim :: (RenderOptions -> Bool -> Layout Builder) -> Doc

Construct a primitive document from a layout function. The function takes two parameters: the rendering options, and a Bool which indicates whether the containing group is laid out horizontally instead of vertically.

group :: Doc -> Doc

Specify an alternative layout with all line breaks flattened.

builder :: Int -> Builder -> Doc

Construct a Doc from a Builder and a length.

string :: String -> Doc

Construct a Doc from a String.

byteString :: ByteString -> Doc

Construct a Doc from a ByteString.

text :: Text -> Doc

Construct a Builder from a Text.

Spacing

space :: Layout Builder

A space layout.

newline :: RenderOptions -> Layout Builder

A newline layout. This will emit a CRLF pair, break to a new line, and indent.

line :: Doc

A line break. If undone, behaves like a space.

linebreak :: Doc

A line break. If undone, behaves like mempty.

softline :: Doc

A space if the remaining layout fits, and a line break otherwise.

softbreak :: Doc

mempty if the remaining layout fits, and a line break otherwise.

(</>) :: Doc -> Doc -> Doc infixr 6

Concatenate with a softline in between.

Combinators

sep :: [Doc] -> Doc

Separate a list with spaces if it fits. Otherwise, separate with lines.

punctuate :: Monoid a => a -> [a] -> [a]

punctuate p xs appends p to every element of xs but the last.