Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kioslaves

kioslaves imapparser.h Go to the documentation of this file. #ifndef _IMAPPARSER_H #define _IMAPPARSER_H /********************************************************************** * * imapparser.h - IMAP4rev1 Parser * Copyright (C) 2001-2002 Michael Haeckel <haeckel@kde.org> * Copyright (C) 2000 s.carstens@gmx.de * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * Send comments and bug fixes to s.carstens@gmx.de * *********************************************************************/ #include <qstringlist.h> #include <qvaluelist.h> #include <qptrlist.h> #include <qasciidict.h> #include <kio/authinfo.h> #include <kio/slavebase.h> #include "imaplist.h" #include "imapcommand.h" #include "imapinfo.h" #include "mailheader.h" class KURL; class QString; class mailAddress; class mimeHeader; class parseString { public: parseString() { pos = 0; } char operator[](uint i) const { return data[i + pos]; } bool isEmpty() const { return pos >= data.size(); } QCString cstr() const { if (pos >= data.size()) return QCString(); return QCString(data.data() + pos, data.size() - pos + 1); } int find(char c, int index = 0) { int res = data.find(c, index + pos); return (res == -1) ? res : (res - pos); } // Warning: does not check for going past end of "data" void takeLeft(QCString& dest, uint len) const { dest.resize(len + 1); qmemmove(dest.data(), data.data() + pos, len); } // Warning: does not check for going past end of "data" void takeLeftNoResize(QCString& dest, uint len) const { qmemmove(dest.data(), data.data() + pos, len); } // Warning: does not check for going past end of "data" void takeMid(QCString& dest, uint start, uint len) const { dest.resize(len + 1); qmemmove(dest.data(), data.data() + pos + start, len); } // Warning: does not check for going past end of "data" void takeMidNoResize(QCString& dest, uint start, uint len) const { qmemmove(dest.data(), data.data() + pos + start, len); } void clear() { data.resize(0); pos = 0; } uint length() { return data.size() - pos; } void fromString(const QString &s) { clear(); data.duplicate(s.latin1(), s.length()); } QByteArray data; uint pos; }; class imapCache { public: imapCache () { myHeader = NULL; mySize = 0; myFlags = 0; myUid = 0; } ~imapCache () { if (myHeader) delete myHeader; } mailHeader *getHeader () { return myHeader; } void setHeader (mailHeader * inHeader) { myHeader = inHeader; } ulong getSize () { return mySize; } void setSize (ulong inSize) { mySize = inSize; } ulong getUid () { return myUid; } void setUid (ulong inUid) { myUid = inUid; } ulong getFlags () { return myFlags; } void setFlags (ulong inFlags) { myFlags = inFlags; } QCString getDate () { return myDate; } void setDate (const QCString & _str) { myDate = _str; } void clear() { if (myHeader) delete myHeader; myHeader = NULL; mySize = 0; myFlags = 0; myDate = QCString(); myUid = 0; } protected: mailHeader * myHeader; ulong mySize; ulong myFlags; ulong myUid; QCString myDate; }; class imapParser { public: enum IMAP_STATE { ISTATE_NO, ISTATE_CONNECT, ISTATE_LOGIN, ISTATE_SELECT }; public: imapParser (); virtual ~ imapParser (); enum IMAP_STATE getState () { return currentState; } void setState(enum IMAP_STATE state) { currentState = state; } /* @brief return the currently selected mailbox */ const QString getCurrentBox () { return rfcDecoder::fromIMAP(currentBox); }; 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); // reimplement these 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 &); // generic parser routines void parseSentence (parseString & inWords); QCString parseLiteralC(parseString & inWords, bool relay = false, bool stopAtBracket = false, int *outlen = 0); inline QByteArray parseLiteral (parseString & inWords, bool relay = false, bool stopAtBracket = false) { int len = 0; // string size // Choice: we can create an extra QCString, or we can get the buffer in // the wrong size to start. Let's try option b. QCString tmp = parseLiteralC(inWords, relay, stopAtBracket, &len); return QByteArray().duplicate(tmp.data(), len); } // static parser routines, can be used elsewhere static QCString b2c(const QByteArray &ba) { return QCString(ba.data(), ba.size() + 1); } 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); imapCache *getLastHandled () { return lastHandled; }; const QStringList & getResults () { return lastResults; }; const imapInfo & getStatus () { return lastStatus; }; const imapInfo & getSelected () { return selectInfo; }; const QByteArray & getContinuation () { return continuation; }; bool hasCapability (const QString &); void removeCapability (const QString & cap); static inline void skipWS (parseString & inWords) { char c; while (!inWords.isEmpty() && ((c = inWords[0]) == ' ' || c == '\t' || c == '\r' || c == '\n')) { inWords.pos++; } } QString namespaceForBox( const QString & box ); protected: enum IMAP_STATE currentState; QString currentBox; imapInfo selectInfo; imapInfo lastStatus; QStringList imapCapabilities; QValueList < imapList > listResponses; QPtrList < imapCommand > sentQueue; // no autodelete QPtrList < imapCommand > completeQueue; // autodelete !! QStringList unhandled; QByteArray continuation; QString seenUid; imapCache *lastHandled; ulong commandCounter; QStringList lastResults; QMap<QString, QString> namespaceToDelimiter; QStringList imapNamespaces; private: imapParser & operator = (const imapParser &); // hide the copy ctor }; #endif kioslaves Skip menu "kioslaves" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Class Members Related Pages API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal