Network.IMAP.Types

Documentation

type ErrorMessage = Text

A type alias used for an error message

type CommandId = ByteString

Each command sent to the server is identified by a random id. this alias helps noticing where this happens

data ConnectionState

Connection with the server can be in one of these states

Constructors

UndefinedState

Connected

Disconnected

Instances

Show ConnectionState

Methods

showsPrec :: Int -> ConnectionState -> ShowS

show :: ConnectionState -> String

showList :: [ConnectionState] -> ShowS

data IMAPConnection

Constructors

IMAPConnection

Fields

• connectionState :: TVar ConnectionState

  The current connection state

• untaggedQueue :: RollingQueue UntaggedResult

  Contains commands sent by the server which we didn't expect. Probably message and mailbox state updates

• imapState :: IMAPState

  Internal state of the library

data IMAPState

Constructors

IMAPState

Fields

• rawConnection :: !Connection

  The actual connection with the server from Network.Connection. Only use if you know what you're doing

• connectionContext :: ConnectionContext

  Context from Network.Connection

• responseRequests :: TQueue ResponseRequest

  Contains requests for response that weren't yet read by the watcher thread.

• serverWatcherThread :: TVar (Maybe ThreadId)

  Id of the thread the watcher executes on

• outstandingReqs :: TVar [ResponseRequest]

  All the unfulfilled requests the watcher thread knows about

• imapSettings :: IMAPSettings

  Configuration settings

type ParseResult = Either ErrorMessage CommandResult

data ResponseRequest

Constructors

ResponseRequest

Fields

• responseQueue :: TQueue CommandResult

  Thread that posted the request should watch this queue for responses to the request.

• respRequestId :: CommandId

  Id of the request, which is the same as the id sent to the server.

Instances

Eq ResponseRequest

Methods

(==) :: ResponseRequest -> ResponseRequest -> Bool

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

data IMAPSettings

Constructors

IMAPSettings

Fields

• imapTimeout :: Int
• untaggedQueueLength :: Int

data EmailAddress

Constructors

EmailAddress

Fields

• emailLabel :: Maybe Text
• emailRoute :: Maybe Text
• emailUsername :: Maybe Text
• emailDomain :: Maybe Text

Instances

Eq EmailAddress

Methods

(==) :: EmailAddress -> EmailAddress -> Bool

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

Show EmailAddress

Methods

showsPrec :: Int -> EmailAddress -> ShowS

show :: EmailAddress -> String

showList :: [EmailAddress] -> ShowS

data Flag

Constructors

FSeen

FAnswered

FFlagged

FDeleted

FDraft

FRecent

FAny

FOther Text

Instances

Eq Flag

Methods

(==) :: Flag -> Flag -> Bool

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

Ord Flag

Methods

compare :: Flag -> Flag -> Ordering

(<) :: Flag -> Flag -> Bool

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

(>) :: Flag -> Flag -> Bool

(>=) :: Flag -> Flag -> Bool

max :: Flag -> Flag -> Flag

min :: Flag -> Flag -> Flag

Show Flag

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

data Capability

Constructors

CIMAP4

CUnselect

CIdle

CNamespace

CQuota

CId

CExperimental Text

CChildren

CUIDPlus

CCompress Text

CEnable

CMove

CCondstore

CEsearch

CUtf8 Text

CAuth Text

CListExtended

CListStatus

CAppendLimit Int

COther Text (Maybe Text)

First parameter is the name of a capability and the second can contain a value, if the capability is of the form `NAME=VALUE`

Instances

Eq Capability

Methods

(==) :: Capability -> Capability -> Bool

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

Ord Capability

Methods

compare :: Capability -> Capability -> Ordering

(<) :: Capability -> Capability -> Bool

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

(>) :: Capability -> Capability -> Bool

(>=) :: Capability -> Capability -> Bool

max :: Capability -> Capability -> Capability

min :: Capability -> Capability -> Capability

Show Capability

Methods

showsPrec :: Int -> Capability -> ShowS

show :: Capability -> String

showList :: [Capability] -> ShowS

data TaggedResult

Always the last result of the command, contains it's metadata

Constructors

TaggedResult

Fields

• commandId :: CommandId

  Id of the command that completes

• resultState :: !ResultState

  State returned by the server side

• resultRest :: Text

  Rest of the result, usually the human-readable part

Instances

Eq TaggedResult

Methods

(==) :: TaggedResult -> TaggedResult -> Bool

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

Show TaggedResult

Methods

showsPrec :: Int -> TaggedResult -> ShowS

show :: TaggedResult -> String

showList :: [TaggedResult] -> ShowS

data ResultState

Tagged results can be in on of these three states

Constructors

OK

NO

BAD

Instances

Eq ResultState

Methods

(==) :: ResultState -> ResultState -> Bool

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

Show ResultState

Methods

showsPrec :: Int -> ResultState -> ShowS

show :: ResultState -> String

showList :: [ResultState] -> ShowS

data UntaggedResult

Untagged replies are the actual data returned in response to the commands.

Constructors

Flags [Flag]

A list of flags a mailbox has

Exists Integer

How many messages exist in a mailbox

Expunge Integer

Sequence id of a deleted message

Bye

Returned by the server when it cleanly disconnects

HighestModSeq Integer

Recent Integer

Number of recent messages

Messages Integer

Number of messages in a mailbox

Unseen Integer

Number of unseen messages

PermanentFlags [Flag]

UID Integer

UID of a message

MessageId Integer

A sequence id of a message |UID that will be given to the next message added to this mailbox

UIDNext Integer

UIDValidity Integer

A triple of mailbox name, it's UIDValidity value and message UID is always unique for a given message

OKResult Text

Result of an OK response

NOResult Text

Result of a NO response

BADResult Text

Result of a BAD response

Capabilities [Capability]

What server advertises that it supports |Response to the LIST command

ListR

Fields

• flags :: [NameAttribute]

  flags that a mailbox has |Character sequence that marks a new level of hierarchy in the inbox name (usually a slash)

• hierarchyDelimiter :: Text
• inboxName :: Text

  Name of the mailbox

Fetch [UntaggedResult]

Fetch response, contains many responses |Status of a mailbox, will contain many different responses inside

StatusR Text [UntaggedResult]

Search [Integer]

A list of message IDs or UIDs fullfilling the search criterions

Envelope

A parsed ENVELOPE reply, prefixed to avoid name clashes

Fields

• eDate :: Maybe Text
• eSubject :: Maybe Text
• eFrom :: Maybe [EmailAddress]
• eSender :: Maybe [EmailAddress]
• eReplyTo :: Maybe [EmailAddress]
• eTo :: Maybe [EmailAddress]
• eCC :: Maybe [EmailAddress]
• eBCC :: Maybe [EmailAddress]
• eInReplyTo :: Maybe Text
• eMessageId :: Maybe Text

InternalDate Text

Size Integer

Message size

Unknown ByteString

An unsupported value

Body ByteString

Message body, or headers

BodyStructure ByteString

An unparsed bodystructure

Extension ByteString ExtensionPayload

A format extension

Instances

Eq UntaggedResult

Methods

(==) :: UntaggedResult -> UntaggedResult -> Bool

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

Show UntaggedResult

Methods

showsPrec :: Int -> UntaggedResult -> ShowS

show :: UntaggedResult -> String

showList :: [UntaggedResult] -> ShowS

data ExtensionPayload

Constructors

ExtInt Integer

ExtLabels [ByteString]

Instances

Eq ExtensionPayload

Methods

(==) :: ExtensionPayload -> ExtensionPayload -> Bool

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

Show ExtensionPayload

Methods

showsPrec :: Int -> ExtensionPayload -> ShowS

show :: ExtensionPayload -> String

showList :: [ExtensionPayload] -> ShowS

data NameAttribute

Constructors

Noinferiors

Noselect

Marked

Unmarked

HasNoChildren

OtherNameAttr Text

Instances

Eq NameAttribute

Methods

(==) :: NameAttribute -> NameAttribute -> Bool

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

Ord NameAttribute

Methods

compare :: NameAttribute -> NameAttribute -> Ordering

(<) :: NameAttribute -> NameAttribute -> Bool

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

(>) :: NameAttribute -> NameAttribute -> Bool

(>=) :: NameAttribute -> NameAttribute -> Bool

max :: NameAttribute -> NameAttribute -> NameAttribute

min :: NameAttribute -> NameAttribute -> NameAttribute

Show NameAttribute

Methods

showsPrec :: Int -> NameAttribute -> ShowS

show :: NameAttribute -> String

showList :: [NameAttribute] -> ShowS

data CommandResult

Command result consits of a sequence of untagged results followed by a single tagged result that specifies if the command overall succeeded. This is a sum type to bind those two types together

Constructors

Tagged TaggedResult

Untagged UntaggedResult

Instances

Eq CommandResult

Methods

(==) :: CommandResult -> CommandResult -> Bool

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

Show CommandResult

Methods

showsPrec :: Int -> CommandResult -> ShowS

show :: CommandResult -> String

showList :: [CommandResult] -> ShowS

type SimpleResult = Either ErrorMessage [UntaggedResult]

If you don't care about streaming you will get results in this simplified data type, in which the ErrorMessage comes from TaggedResult if it failed.

class Monad m => Universe m where

Every function that communicates with the outside world should run in the Universe monad, which provides an ability to use mocks when testing

Minimal complete definition

connectionPut', connectionGetChunk''

Methods

connectionPut' :: Connection -> ByteString -> m ()

connectionGetChunk'' :: Connection -> (ByteString -> (a, ByteString)) -> m a

Instances

Universe IO

Methods

connectionPut' :: Connection -> ByteString -> IO ()

connectionGetChunk'' :: Connection -> (ByteString -> (a, ByteString)) -> IO a

Universe (ListT IO)

Methods

connectionPut' :: Connection -> ByteString -> ListT IO ()

connectionGetChunk'' :: Connection -> (ByteString -> (a, ByteString)) -> ListT IO a

Universe (ListT IO)

Methods

connectionPut' :: Connection -> ByteString -> ListT IO ()

connectionGetChunk'' :: Connection -> (ByteString -> (a, ByteString)) -> ListT IO a

defaultImapSettings :: IMAPSettings

isFOther :: Flag -> Bool

isFAny :: Flag -> Bool

isFRecent :: Flag -> Bool

isFDraft :: Flag -> Bool

isFDeleted :: Flag -> Bool

isFFlagged :: Flag -> Bool

isFAnswered :: Flag -> Bool

isFSeen :: Flag -> Bool

isExtension :: UntaggedResult -> Bool

isBodyStructure :: UntaggedResult -> Bool

isBody :: UntaggedResult -> Bool

isUnknown :: UntaggedResult -> Bool

isSize :: UntaggedResult -> Bool

isInternalDate :: UntaggedResult -> Bool

isEnvelope :: UntaggedResult -> Bool

isSearch :: UntaggedResult -> Bool

isStatusR :: UntaggedResult -> Bool

isFetch :: UntaggedResult -> Bool

isListR :: UntaggedResult -> Bool

isCapabilities :: UntaggedResult -> Bool

isBADResult :: UntaggedResult -> Bool

isNOResult :: UntaggedResult -> Bool

isOKResult :: UntaggedResult -> Bool

isUIDValidity :: UntaggedResult -> Bool

isUIDNext :: UntaggedResult -> Bool

isMessageId :: UntaggedResult -> Bool

isUID :: UntaggedResult -> Bool

isPermanentFlags :: UntaggedResult -> Bool

isUnseen :: UntaggedResult -> Bool

isMessages :: UntaggedResult -> Bool

isRecent :: UntaggedResult -> Bool

isHighestModSeq :: UntaggedResult -> Bool

isBye :: UntaggedResult -> Bool

isExpunge :: UntaggedResult -> Bool

isExists :: UntaggedResult -> Bool

isFlags :: UntaggedResult -> Bool

isUntagged :: CommandResult -> Bool

isTagged :: CommandResult -> Bool

isDisconnected :: ConnectionState -> Bool

isConnected :: ConnectionState -> Bool

isUndefinedState :: ConnectionState -> Bool