Network.Email.Header.Types

Email header types.

Header types

type HeaderName = CI ByteString

An email header name.

type Header = (HeaderName, ByteString)

An email header.

type Headers = [Header]

A set of email headers, in order.

Email types

newtype Address

An email address.

Constructors

Address ByteString

Instances

Eq Address

Defined in Network.Email.Header.Types

Methods

(==) :: Address -> Address -> Bool

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

Ord Address

Defined in Network.Email.Header.Types

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

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

data Mailbox

A Mailbox receives mail.

Constructors

Mailbox

Fields

• displayName :: Maybe Text
• mailboxAddress :: Address

Instances

Eq Mailbox

Defined in Network.Email.Header.Types

Methods

(==) :: Mailbox -> Mailbox -> Bool

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

Show Mailbox

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> Mailbox -> ShowS

show :: Mailbox -> String

showList :: [Mailbox] -> ShowS

data Recipient

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

Defined in Network.Email.Header.Types

Methods

(==) :: Recipient -> Recipient -> Bool

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

Show Recipient

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> Recipient -> ShowS

show :: Recipient -> String

showList :: [Recipient] -> ShowS

newtype MessageID

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

Constructors

MessageID ByteString

Instances

Eq MessageID

Defined in Network.Email.Header.Types

Methods

(==) :: MessageID -> MessageID -> Bool

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

Ord MessageID

Defined in Network.Email.Header.Types

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

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> MessageID -> ShowS

show :: MessageID -> String

showList :: [MessageID] -> ShowS

data MimeType

A MIME type.

Constructors

MimeType

Fields

• mimeType :: CI ByteString
• mimeSubtype :: CI ByteString

Instances

Eq MimeType

Defined in Network.Email.Header.Types

Methods

(==) :: MimeType -> MimeType -> Bool

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

Ord MimeType

Defined in Network.Email.Header.Types

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

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> MimeType -> ShowS

show :: MimeType -> String

showList :: [MimeType] -> ShowS

type Parameters = Map (CI ByteString) ByteString

MIME content type parameters.

Exceptions

data HeaderException

Email header exceptions.

Constructors

MissingHeader HeaderName

A required header is missing.

HeaderParseError Header String

A header field could not be parsed.

Instances

Show HeaderException

Defined in Network.Email.Header.Types

Methods

showsPrec :: Int -> HeaderException -> ShowS

show :: HeaderException -> String

showList :: [HeaderException] -> ShowS

Exception HeaderException

Defined in Network.Email.Header.Types

Methods

toException :: HeaderException -> SomeException

fromException :: SomeException -> Maybe HeaderException

displayException :: HeaderException -> String