summaryrefslogtreecommitdiffstats
path: root/kioslaves/imap4/imap4.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /kioslaves/imap4/imap4.h
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kioslaves/imap4/imap4.h')
-rw-r--r--kioslaves/imap4/imap4.h205
1 files changed, 205 insertions, 0 deletions
diff --git a/kioslaves/imap4/imap4.h b/kioslaves/imap4/imap4.h
new file mode 100644
index 000000000..b86a3815b
--- /dev/null
+++ b/kioslaves/imap4/imap4.h
@@ -0,0 +1,205 @@
+#ifndef _IMAP4_H
+#define _IMAP4_H
+/**********************************************************************
+ *
+ * imap4.h - IMAP4rev1 KIOSlave
+ * Copyright (C) 2001-2002 Michael Haeckel <haeckel@kde.org>
+ * Copyright (C) 1999 John Corey
+ *
+ * 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 jcorey@fruity.ath.cx
+ *
+ *********************************************************************/
+
+#include "imapparser.h"
+#include "mimeio.h"
+
+#include <kio/tcpslavebase.h>
+#include <qbuffer.h>
+
+#define IMAP_BUFFER 8192
+
+/** @brief type of object the url refers too */
+enum IMAP_TYPE
+{
+ ITYPE_UNKNOWN, /*< unknown type */
+ ITYPE_DIR, /*< Object is a directory. i.e. does not contain message, just mailboxes */
+ ITYPE_BOX, /*< Object is a mailbox. i.e. contains mails */
+ ITYPE_DIR_AND_BOX, /*< Object contains both mails and mailboxes */
+ ITYPE_MSG, /*< Object is a mail */
+ ITYPE_ATTACH /*< Object is an attachment */
+};
+
+/** @brief IOSlave derived class */
+class IMAP4Protocol:public
+ KIO::TCPSlaveBase,
+ public
+ imapParser,
+ public
+ mimeIO
+{
+
+public:
+
+ // reimplement the TCPSlave
+ IMAP4Protocol (const QCString & pool, const QCString & app, bool isSSL);
+ virtual ~IMAP4Protocol ();
+
+ virtual void openConnection();
+ virtual void closeConnection();
+
+ virtual void setHost (const QString & _host, int _port, const QString & _user,
+ const QString & _pass);
+ /**
+ * @brief get a message or part of a message
+ * the data is normally send as we get it from the server
+ * if you want the slave to decode the content (e.g. for attachments)
+ * then append an additional INFO=DECODE to the URL
+ */
+ virtual void get (const KURL & _url);
+ /**
+ * @brief stat a mailbox, message, attachment
+ */
+ virtual void stat (const KURL & _url);
+ virtual void slave_status ();
+ /**
+ * @brief delete a mailbox
+ */
+ virtual void del (const KURL & _url, bool isFile);
+ /**
+ * @brief Capabilites, NOOP, (Un)subscribe, Change status,
+ * Change ACL
+ */
+ virtual void special (const QByteArray & data);
+ /**
+ * @brief list a directory/mailbox
+ */
+ virtual void listDir (const KURL & _url);
+ virtual void setSubURL (const KURL & _url);
+ virtual void dispatch (int command, const QByteArray & data);
+ /**
+ * @brief create a mailbox
+ */
+ virtual void mkdir (const KURL & url, int permissions);
+ virtual void put (const KURL & url, int permissions, bool overwrite,
+ bool resume);
+ virtual void rename (const KURL & src, const KURL & dest, bool overwrite);
+ virtual void copy (const KURL & src, const KURL & dest, int permissions,
+ bool overwrite);
+
+ /** @brief reimplement the parser
+ * relay hook to send the fetched data directly to an upper level
+ */
+ virtual void parseRelay (const QByteArray & buffer);
+
+ /** @brief reimplement the parser
+ * relay hook to announce the fetched data directly to an upper level
+ */
+ virtual void parseRelay (ulong);
+
+ /** @brief reimplement the parser
+ * read at least len bytes */
+ virtual bool parseRead (QByteArray &buffer,ulong len,ulong relay=0);
+
+ /** @brief reimplement the parser
+ * @brief read at least a line (up to CRLF) */
+ virtual bool parseReadLine (QByteArray & buffer, ulong relay = 0);
+
+ /** @brief reimplement the parser
+ * @brief write argument to the server */
+ virtual void parseWriteLine (const QString &);
+
+ /** @brief reimplement the mimeIO */
+ virtual int outputLine (const QCString & _str, int len = -1);
+
+ /** @brief send out cached data to the application */
+ virtual void flushOutput(QString contentEncoding = QString::null);
+
+protected:
+
+ // select or examine the box if needed
+ bool assureBox (const QString & aBox, bool readonly);
+
+ ssize_t myRead(void *data, ssize_t len);
+
+ /**
+ * @brief Parses the given URL
+ * The return values are set by parsing the URL and querying the server
+ *
+ * If you set caching to true the server is not queried but the type is always
+ * set to ITYPE_DIR_AND_BOX
+ */
+ enum IMAP_TYPE
+ parseURL (const KURL & _url, QString & _box, QString & _section,
+ QString & _type, QString & _uid, QString & _validity,
+ QString & _hierarchyDelimiter, QString & _info,
+ bool cache = false);
+ QString getMimeType (enum IMAP_TYPE);
+
+ bool makeLogin ();
+
+ void outputLineStr (const QString & _str)
+ {
+ outputLine (_str.latin1 (), _str.length());
+ }
+ void doListEntry (const KURL & _url, int stretch, imapCache * cache = NULL,
+ bool withFlags = FALSE, bool withSubject = FALSE);
+
+ /**
+ * Send a list entry (folder) to the application
+ * If @p appendPath is true the foldername will be appended
+ * to the path of @p url
+ */
+ void doListEntry (const KURL & url, const QString & myBox,
+ const imapList & item, bool appendPath = true);
+
+ /** Send an ACL command which is identified by @p command */
+ void specialACLCommand( int command, QDataStream& stream );
+
+ /** Send an annotation command which is identified by @p command */
+ void specialAnnotateMoreCommand( int command, QDataStream& stream );
+ void specialQuotaCommand( int command, QDataStream& stream );
+
+ /** Search current folder, the search string is passed as SECTION */
+ void specialSearchCommand( QDataStream& );
+
+ /** Send a custom command to the server */
+ void specialCustomCommand( QDataStream& );
+
+private:
+
+ // This method behaves like the above method but takes an already encoded url,
+ // so you don't have to call KURL::url() for every mail.
+ void doListEntry (const QString & encodedUrl, int stretch, imapCache * cache = NULL,
+ bool withFlags = FALSE, bool withSubject = FALSE);
+
+ QString myHost, myUser, myPass, myAuth, myTLS;
+ int myPort;
+ bool mySSL;
+
+ bool relayEnabled, cacheOutput, decodeContent;
+ QByteArray outputCache;
+ QBuffer outputBuffer;
+ Q_ULONG outputBufferIndex;
+ KIO::filesize_t mProcessedSize;
+
+ char readBuffer[IMAP_BUFFER];
+ ssize_t readBufferLen;
+ int readSize;
+ QDateTime mTimeOfLastNoop;
+};
+
+#endif