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

Defined in Network.Email.Header.Doc

Methods

(==) :: RenderOptions -> RenderOptions -> Bool

(/=) :: RenderOptions -> RenderOptions -> Bool

Show RenderOptions

Defined in Network.Email.Header.Doc

Methods

showsPrec :: Int -> RenderOptions -> ShowS

show :: RenderOptions -> String

showList :: [RenderOptions] -> ShowS

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

Defined in Network.Email.Header.Doc

Methods

minBound :: Encoding

maxBound :: Encoding

Enum Encoding

Defined in Network.Email.Header.Doc

Methods

succ :: Encoding -> Encoding

pred :: Encoding -> Encoding

toEnum :: Int -> Encoding

fromEnum :: Encoding -> Int

enumFrom :: Encoding -> [Encoding]

enumFromThen :: Encoding -> Encoding -> [Encoding]

enumFromTo :: Encoding -> Encoding -> [Encoding]

enumFromThenTo :: Encoding -> Encoding -> Encoding -> [Encoding]

Eq Encoding

Defined in Network.Email.Header.Doc

Methods

(==) :: Encoding -> Encoding -> Bool

(/=) :: Encoding -> Encoding -> Bool

Ord Encoding

Defined in Network.Email.Header.Doc

Methods

compare :: Encoding -> Encoding -> Ordering

(<) :: Encoding -> Encoding -> Bool

(<=) :: Encoding -> Encoding -> Bool

(>) :: Encoding -> Encoding -> Bool

(>=) :: Encoding -> Encoding -> Bool

max :: Encoding -> Encoding -> Encoding

min :: Encoding -> Encoding -> Encoding

Read Encoding

Defined in Network.Email.Header.Doc

Methods

readsPrec :: Int -> ReadS Encoding

readList :: ReadS [Encoding]

readPrec :: ReadPrec Encoding

readListPrec :: ReadPrec [Encoding]

Show Encoding

Defined in Network.Email.Header.Doc

Methods

showsPrec :: Int -> Encoding -> ShowS

show :: Encoding -> String

showList :: [Encoding] -> ShowS

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

Defined in Network.Email.Header.Doc

Methods

fromString :: String -> Doc

Semigroup Doc

Defined in Network.Email.Header.Doc

Methods

(<>) :: Doc -> Doc -> Doc

sconcat :: NonEmpty Doc -> Doc

stimes :: Integral b => b -> Doc -> Doc

Monoid Doc

Defined in Network.Email.Header.Doc

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> 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.