Safe Haskell	Safe
Language	Haskell98

Network.Email.Header.Types

Contents

Header types
Email types
Exceptions

Description

Email header types.

Synopsis

Header types

type HeaderName = CI ByteString Source #

An email header name.

type Header = (HeaderName, ByteString) Source #

An email header.

type Headers = [Header] Source #

A set of email headers, in order.

Email types

newtype Address Source #

An email address.

Constructors

Address ByteString

Instances

Eq Address Source #
Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Ord Address Source #
Methods compare :: Address -> Address -> Ordering # (<) :: Address -> Address -> Bool # (<=) :: Address -> Address -> Bool # (>) :: Address -> Address -> Bool # (>=) :: Address -> Address -> Bool # max :: Address -> Address -> Address # min :: Address -> Address -> Address #
Show Address Source #
Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #

data Mailbox Source #

A Mailbox receives mail.

Constructors

Mailbox
Fields displayName :: Maybe Text mailboxAddress :: Address

Instances

Eq Mailbox Source #
Methods (==) :: Mailbox -> Mailbox -> Bool # (/=) :: Mailbox -> Mailbox -> Bool #
Show Mailbox Source #
Methods showsPrec :: Int -> Mailbox -> ShowS # show :: Mailbox -> String # showList :: [Mailbox] -> ShowS #

data Recipient Source #

A Recipient is used to indicate senders and recipients of messages. It may either be an individual Mailbox, or a named group of Mailboxes.

Constructors

Individual Mailbox
Group Text [Mailbox]

Instances

Eq Recipient Source #
Methods (==) :: Recipient -> Recipient -> Bool # (/=) :: Recipient -> Recipient -> Bool #
Show Recipient Source #
Methods showsPrec :: Int -> Recipient -> ShowS # show :: Recipient -> String # showList :: [Recipient] -> ShowS #

newtype MessageID Source #

A message identifier, which has a similar format to an email address.

Constructors

MessageID ByteString

Instances

Eq MessageID Source #
Methods (==) :: MessageID -> MessageID -> Bool # (/=) :: MessageID -> MessageID -> Bool #
Ord MessageID Source #
Methods compare :: MessageID -> MessageID -> Ordering # (<) :: MessageID -> MessageID -> Bool # (<=) :: MessageID -> MessageID -> Bool # (>) :: MessageID -> MessageID -> Bool # (>=) :: MessageID -> MessageID -> Bool # max :: MessageID -> MessageID -> MessageID # min :: MessageID -> MessageID -> MessageID #
Show MessageID Source #
Methods showsPrec :: Int -> MessageID -> ShowS # show :: MessageID -> String # showList :: [MessageID] -> ShowS #

data MimeType Source #

A MIME type.

Constructors

MimeType
Fields mimeType :: CI ByteString mimeSubtype :: CI ByteString

Instances

Eq MimeType Source #
Methods (==) :: MimeType -> MimeType -> Bool # (/=) :: MimeType -> MimeType -> Bool #
Ord MimeType Source #
Methods compare :: MimeType -> MimeType -> Ordering # (<) :: MimeType -> MimeType -> Bool # (<=) :: MimeType -> MimeType -> Bool # (>) :: MimeType -> MimeType -> Bool # (>=) :: MimeType -> MimeType -> Bool # max :: MimeType -> MimeType -> MimeType # min :: MimeType -> MimeType -> MimeType #
Show MimeType Source #
Methods showsPrec :: Int -> MimeType -> ShowS # show :: MimeType -> String # showList :: [MimeType] -> ShowS #

type Parameters = Map (CI ByteString) ByteString Source #

MIME content type parameters.

Exceptions

data HeaderException Source #

Email header exceptions.

Constructors

MissingHeader HeaderName	A required header is missing.
HeaderParseError Header String	A header field could not be parsed.

Instances

Show HeaderException Source #
Methods showsPrec :: Int -> HeaderException -> ShowS # show :: HeaderException -> String # showList :: [HeaderException] -> ShowS #
Exception HeaderException Source #
Methods toException :: HeaderException -> SomeException # fromException :: SomeException -> Maybe HeaderException # displayException :: HeaderException -> String #