kioslaves/imap4

imapParser Class Reference

Inheritance diagram for imapParser:

IMAP4Protocol List of all members.

Detailed Description

Definition at line 187 of file imapparser.h.


Public Types

enum  IMAP_STATE { ISTATE_NO, ISTATE_CONNECT, ISTATE_LOGIN, ISTATE_SELECT }

Public Member Functions

 imapParser ()
virtual ~imapParser ()
enum IMAP_STATE getState ()
void setState (enum IMAP_STATE state)
const QString getCurrentBox ()
imapCommand * sendCommand (imapCommand *aCmd)
imapCommand * doCommand (imapCommand *aCmd)
bool clientLogin (const QString &aUser, const QString &aPass, QString &resultInfo)
bool clientAuthenticate (KIO::SlaveBase *slave, KIO::AuthInfo &ai, const QString &aFQDN, const QString &aAuth, bool isSSL, QString &resultInfo)
int parseLoop ()
void parseUntagged (parseString &result)
void parseRecent (ulong value, parseString &result)
void parseResult (QByteArray &result, parseString &rest, const QString &command=QString::null)
void parseCapability (parseString &result)
void parseFlags (parseString &result)
void parseList (parseString &result)
void parseLsub (parseString &result)
void parseListRights (parseString &result)
void parseMyRights (parseString &result)
void parseSearch (parseString &result)
void parseStatus (parseString &result)
void parseExists (ulong value, parseString &result)
void parseExpunge (ulong value, parseString &result)
void parseAcl (parseString &result)
void parseAnnotation (parseString &result)
void parseNamespace (parseString &result)
void parseQuotaRoot (parseString &result)
void parseQuota (parseString &result)
void parseCustom (parseString &result)
void parseOtherUser (parseString &result)
void parseDelegate (parseString &result)
void parseOutOfOffice (parseString &result)
void parseFetch (ulong value, parseString &inWords)
mailHeader * parseEnvelope (parseString &inWords)
void parseAddressList (parseString &inWords, QPtrList< mailAddress > &list)
const mailAddress & parseAddress (parseString &inWords, mailAddress &buffer)
void parseBody (parseString &inWords)
mimeHeader * parseBodyStructure (parseString &inWords, QString &section, mimeHeader *inHeader=0)
mimeHeader * parseSimplePart (parseString &inWords, QString &section, mimeHeader *localPart=0)
QAsciiDict< QString > parseParameters (parseString &inWords)
QAsciiDict< QString > parseDisposition (parseString &inWords)
virtual void parseRelay (const QByteArray &buffer)
virtual void parseRelay (ulong)
virtual bool parseRead (QByteArray &buffer, ulong len, ulong relay=0)
virtual bool parseReadLine (QByteArray &buffer, ulong relay=0)
virtual void parseWriteLine (const QString &)
void parseSentence (parseString &inWords)
QCString parseLiteralC (parseString &inWords, bool relay=false, bool stopAtBracket=false, int *outlen=0)
QByteArray parseLiteral (parseString &inWords, bool relay=false, bool stopAtBracket=false)
imapCache * getLastHandled ()
const QStringList & getResults ()
const imapInfo & getStatus ()
const imapInfo & getSelected ()
const QByteArray & getContinuation ()
bool hasCapability (const QString &)
void removeCapability (const QString &cap)
QString namespaceForBox (const QString &box)

Static Public Member Functions

static QCString b2c (const QByteArray &ba)
static QCString parseOneWordC (parseString &inWords, bool stopAtBracket=FALSE, int *len=0)
static bool parseOneNumber (parseString &inWords, ulong &num)
static void parseURL (const KURL &_url, QString &_box, QString &_section, QString &_type, QString &_uid, QString &_validity, QString &_info)
static void skipWS (parseString &inWords)

Protected Attributes

enum IMAP_STATE currentState
QString currentBox
imapInfo selectInfo
imapInfo lastStatus
QStringList imapCapabilities
QValueList< imapList > listResponses
QPtrList< imapCommand > sentQueue
QPtrList< imapCommand > completeQueue
QStringList unhandled
QByteArray continuation
QString seenUid
imapCache * lastHandled
ulong commandCounter
QStringList lastResults
QMap< QString, QString > namespaceToDelimiter
QStringList imapNamespaces

Member Enumeration Documentation

enum imapParser::IMAP_STATE
 

the different states the client can be in

Enumerator:
ISTATE_NO  Not connected.
ISTATE_CONNECT  Connected but not logged in.
ISTATE_LOGIN  Logged in.
ISTATE_SELECT  A folder is currently selected.

Definition at line 193 of file imapparser.h.

Member Function Documentation

bool imapParser::clientAuthenticate (  KIO::SlaveBase *  slave,
KIO::AuthInfo &  ai,
const QString &  aFQDN,
const QString &  aAuth,
bool  isSSL,
QString &  resultInfo
) 
 

non-plaintext login

Parameters:
aUser Username
aPass Password
aAuth authentication method
isSSL are we using SSL
resultInfo The resultinfo from the command
Returns:
success or failure

Definition at line 218 of file imapparser.cc.

bool imapParser::clientLogin (  const QString &  aUser,
const QString &  aPass,
QString &  resultInfo
) 
 

plaintext login

Parameters:
aUser Username
aPass Password
resultInfo The resultinfo from the command
Returns:
success or failure

Definition at line 149 of file imapparser.cc.

imapCommand * imapParser::doCommand (  imapCommand *  aCmd  ) 
 

perform a command and wait to parse the result

Parameters:
aCmd The command to perform
Returns:
The completed command

Definition at line 91 of file imapparser.cc.

imapCache* imapParser::getLastHandled (   )  [inline]
 

return the last handled foo

Todo:
work out what a foo is

Definition at line 395 of file imapparser.h.

const QStringList& imapParser::getResults (   )  [inline]
 

return the last results

Definition at line 401 of file imapparser.h.

const imapInfo& imapParser::getSelected (   )  [inline]
 

return the select info

Definition at line 412 of file imapparser.h.

enum IMAP_STATE imapParser::getState (   )  [inline]
 

Get the current state.

Definition at line 206 of file imapparser.h.

const imapInfo& imapParser::getStatus (   )  [inline]
 

return the last status code

Definition at line 407 of file imapparser.h.

bool imapParser::hasCapability (  const QString &   ) 
 

see if server has a capability

Definition at line 2048 of file imapparser.cc.

QString imapParser::namespaceForBox (  const QString &  box  ) 
 

find the namespace for the given box

Definition at line 2069 of file imapparser.cc.

void imapParser::parseAcl (  parseString &  result  ) 
 

parse a ACL line

Definition at line 723 of file imapparser.cc.

const mailAddress & imapParser::parseAddress (  parseString &  inWords,
mailAddress &  buffer
) 
 

parse an address and return the ref again

Definition at line 926 of file imapparser.cc.

void imapParser::parseAddressList (  parseString &  inWords,
QPtrList< mailAddress > &  list
) 
 

parse an address list and return a list of addresses

Definition at line 896 of file imapparser.cc.

void imapParser::parseAnnotation (  parseString &  result  ) 
 

parse a ANNOTATION line

Definition at line 734 of file imapparser.cc.

void imapParser::parseBody (  parseString &  inWords  ) 
 

parse the result of the body command

Definition at line 1337 of file imapparser.cc.

mimeHeader * imapParser::parseBodyStructure (  parseString &  inWords,
QString &  section,
mimeHeader *  inHeader = 0
) 
 

parse the body structure recursively

Definition at line 1209 of file imapparser.cc.

void imapParser::parseCapability (  parseString &  result  ) 
 

parse a CAPABILITY line

Definition at line 675 of file imapparser.cc.

void imapParser::parseCustom (  parseString &  result  ) 
 

parse a custom command line

Definition at line 794 of file imapparser.cc.

void imapParser::parseDelegate (  parseString &  result  ) 
 

parse a DELEGATE line

Definition at line 806 of file imapparser.cc.

QAsciiDict< QString > imapParser::parseDisposition (  parseString &  inWords  ) 
 

parse the disposition list (disposition (name value pairs)) the disposition has the key 'content-disposition'

Definition at line 1018 of file imapparser.cc.

mailHeader * imapParser::parseEnvelope (  parseString &  inWords  ) 
 

read a envelope from imap and parse the addresses

Definition at line 943 of file imapparser.cc.

void imapParser::parseExists (  ulong  value,
parseString &  result
) 
 

parse a EXISTS line

Definition at line 884 of file imapparser.cc.

void imapParser::parseExpunge (  ulong  value,
parseString &  result
) 
 

parse a EXPUNGE line

Definition at line 890 of file imapparser.cc.

void imapParser::parseFetch (  ulong  value,
parseString &  inWords
) 
 

parses the results of a fetch command processes it with the following sub parsers

Definition at line 1464 of file imapparser.cc.

void imapParser::parseFlags (  parseString &  result  ) 
 

parse a FLAGS line

Definition at line 681 of file imapparser.cc.

void imapParser::parseList (  parseString &  result  ) 
 

parse a LIST line

Definition at line 686 of file imapparser.cc.

void imapParser::parseListRights (  parseString &  result  ) 
 

parse a LISTRIGHTS line

Definition at line 712 of file imapparser.cc.

QCString imapParser::parseLiteralC (  parseString &  inWords,
bool  relay = false,
bool  stopAtBracket = false,
int *  outlen = 0
) 
 

parse a literal or word, may require more data

Definition at line 1909 of file imapparser.cc.

int imapParser::parseLoop (   ) 
 

main loop for the parser reads one line and dispatches it to the appropriate sub parser

Definition at line 1747 of file imapparser.cc.

void imapParser::parseLsub (  parseString &  result  ) 
 

parse a LSUB line

Definition at line 706 of file imapparser.cc.

void imapParser::parseMyRights (  parseString &  result  ) 
 

parse a MYRIGHTS line

Definition at line 831 of file imapparser.cc.

void imapParser::parseNamespace (  parseString &  result  ) 
 

parse a NAMESPACE line

Definition at line 1672 of file imapparser.cc.

bool imapParser::parseOneNumber (  parseString &  inWords,
ulong &  num
)  [static]
 

parse one number using parseOneWord

Definition at line 2041 of file imapparser.cc.

QCString imapParser::parseOneWordC (  parseString &  inWords,
bool  stopAtBracket = FALSE,
int *  len = 0
)  [static]
 

parse one word (maybe quoted) upto next space " ) ] }

Definition at line 1959 of file imapparser.cc.

void imapParser::parseOtherUser (  parseString &  result  ) 
 

parse a OTHER-USER line

Definition at line 801 of file imapparser.cc.

void imapParser::parseOutOfOffice (  parseString &  result  ) 
 

parse a OUT-OF-OFFICE line

Definition at line 820 of file imapparser.cc.

QAsciiDict< QString > imapParser::parseParameters (  parseString &  inWords  ) 
 

parse a parameter list (name value pairs)

Definition at line 1055 of file imapparser.cc.

void imapParser::parseQuota (  parseString &  result  ) 
 

parse a QUOTA line

Definition at line 753 of file imapparser.cc.

void imapParser::parseQuotaRoot (  parseString &  result  ) 
 

parse a QUOTAROOT line

Definition at line 777 of file imapparser.cc.

bool imapParser::parseRead (  QByteArray &  buffer,
ulong  len,
ulong  relay = 0
)  [virtual]
 

read at least len bytes

Reimplemented in IMAP4Protocol.

Definition at line 1823 of file imapparser.cc.

bool imapParser::parseReadLine (  QByteArray &  buffer,
ulong  relay = 0
)  [virtual]
 

read at least a line (up to CRLF)

Reimplemented in IMAP4Protocol.

Definition at line 1833 of file imapparser.cc.

void imapParser::parseRecent (  ulong  value,
parseString &  result
) 
 

parse a RECENT line

Definition at line 1666 of file imapparser.cc.

void imapParser::parseRelay (  ulong   )  [virtual]
 

relay hook to announce the fetched data directly to an upper level

Reimplemented in IMAP4Protocol.

Definition at line 1816 of file imapparser.cc.

void imapParser::parseRelay (  const QByteArray &  buffer  )  [virtual]
 

relay hook to send the fetched data directly to an upper level

Reimplemented in IMAP4Protocol.

Definition at line 1808 of file imapparser.cc.

void imapParser::parseResult (  QByteArray &  result,
parseString &  rest,
const QString &  command = QString::null
) 
 

parse a RESULT line

Definition at line 531 of file imapparser.cc.

void imapParser::parseSearch (  parseString &  result  ) 
 

parse a SEARCH line

Definition at line 838 of file imapparser.cc.

void imapParser::parseSentence (  parseString &  inWords  ) 
 

parse a parenthesized list

Definition at line 1626 of file imapparser.cc.

mimeHeader * imapParser::parseSimplePart (  parseString &  inWords,
QString &  section,
mimeHeader *  localPart = 0
) 
 

parse only one not nested part

Definition at line 1088 of file imapparser.cc.

void imapParser::parseStatus (  parseString &  result  ) 
 

parse a STATUS line

Definition at line 848 of file imapparser.cc.

void imapParser::parseUntagged (  parseString &  result  ) 
 

parses all untagged responses and passes them on to the following parsers

Definition at line 341 of file imapparser.cc.

void imapParser::parseURL (  const KURL &  _url,
QString &  _box,
QString &  _section,
QString &  _type,
QString &  _uid,
QString &  _validity,
QString &  _info
)  [static]
 

extract the box,section,list type, uid, uidvalidity,info from an url

Definition at line 1851 of file imapparser.cc.

void imapParser::parseWriteLine (  const QString &   )  [virtual]
 

write argument to server

Reimplemented in IMAP4Protocol.

Definition at line 1843 of file imapparser.cc.

imapCommand * imapParser::sendCommand (  imapCommand *  aCmd  ) 
 

do setup and send the command to parseWriteLine

Parameters:
aCmd The command to perform
Returns:
The completed command

Definition at line 104 of file imapparser.cc.

void imapParser::setState (  enum IMAP_STATE  state  )  [inline]
 

Set the current state.

Definition at line 208 of file imapparser.h.

Member Data Documentation

QByteArray imapParser::continuation [protected]
 

the last continuation request (there MUST not be more than one pending)

Definition at line 471 of file imapparser.h.

QString imapParser::currentBox [protected]
 

the box selected

Definition at line 447 of file imapparser.h.

enum IMAP_STATE imapParser::currentState [protected]
 

the current state we're in

Definition at line 444 of file imapparser.h.

QStringList imapParser::imapCapabilities [protected]
 

the results from the capabilities, split at ' '

Definition at line 456 of file imapparser.h.

QStringList imapParser::imapNamespaces [protected]
 

list of namespaces in the form: section=namespace=delimiter section is 0 (personal), 1 (other users) or 2 (shared)

Definition at line 492 of file imapparser.h.

QStringList imapParser::lastResults [protected]
 

the results from search/acl commands

Definition at line 480 of file imapparser.h.

imapInfo imapParser::lastStatus [protected]
 

the results from the last status command

Definition at line 453 of file imapparser.h.

QValueList< imapList > imapParser::listResponses [protected]
 

the results from list/lsub/listrights commands

Definition at line 459 of file imapparser.h.

QMap<QString, QString> imapParser::namespaceToDelimiter [protected]
 

namespace prefix - delimiter association The namespace is cleaned before so that it does not contain the delimiter

Definition at line 486 of file imapparser.h.

QString imapParser::seenUid [protected]
 

the last uid seen while a fetch

Definition at line 474 of file imapparser.h.

imapInfo imapParser::selectInfo [protected]
 

here we store the result from select/examine and unsolicited updates

Definition at line 450 of file imapparser.h.

QPtrList< imapCommand > imapParser::sentQueue [protected]
 

queues handling the running commands

Definition at line 462 of file imapparser.h.

QStringList imapParser::unhandled [protected]
 

everything we didn't handle, everything but the greeting is bogus

Definition at line 468 of file imapparser.h.

The documentation for this class was generated from the following files:

kioslaves/imap4

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys