#ifndef _IMAP4_H #define _IMAP4_H /********************************************************************** * * imap4.h - IMAP4rev1 KIOSlave * Copyright (C) 2001-2002 Michael Haeckel * 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 #include #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 TDEIO::TCPSlaveBase, public imapParser, public mimeIO { public: // reimplement the TCPSlave IMAP4Protocol (const TQCString & pool, const TQCString & app, bool isSSL); virtual ~IMAP4Protocol (); virtual void openConnection(); virtual void closeConnection(); virtual void setHost (const TQString & _host, int _port, const TQString & _user, const TQString & _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 TQByteArray & data); /** * @brief list a directory/mailbox */ virtual void listDir (const KURL & _url); virtual void setSubURL (const KURL & _url); virtual void dispatch (int command, const TQByteArray & 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 TQByteArray & 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 (TQByteArray &buffer,ulong len,ulong relay=0); /** @brief reimplement the parser * @brief read at least a line (up to CRLF) */ virtual bool parseReadLine (TQByteArray & buffer, ulong relay = 0); /** @brief reimplement the parser * @brief write argument to the server */ virtual void parseWriteLine (const TQString &); /** @brief reimplement the mimeIO */ virtual int outputLine (const TQCString & _str, int len = -1); /** @brief send out cached data to the application */ virtual void flushOutput(TQString contentEncoding = TQString()); protected: // select or examine the box if needed bool assureBox (const TQString & 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, TQString & _box, TQString & _section, TQString & _type, TQString & _uid, TQString & _validity, TQString & _hierarchyDelimiter, TQString & _info, bool cache = false); TQString getMimeType (enum IMAP_TYPE); bool makeLogin (); void outputLineStr (const TQString & _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 TQString & myBox, const imapList & item, bool appendPath = true); /** Send an ACL command which is identified by @p command */ void specialACLCommand( int command, TQDataStream& stream ); /** Send an annotation command which is identified by @p command */ void specialAnnotateMoreCommand( int command, TQDataStream& stream ); void specialQuotaCommand( int command, TQDataStream& stream ); /** Search current folder, the search string is passed as SECTION */ void specialSearchCommand( TQDataStream& ); /** Send a custom command to the server */ void specialCustomCommand( TQDataStream& ); 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 TQString & encodedUrl, int stretch, imapCache * cache = NULL, bool withFlags = FALSE, bool withSubject = FALSE); TQString myHost, myUser, myPass, myAuth, myTLS; int myPort; bool mySSL; bool relayEnabled, cacheOutput, decodeContent; TQByteArray outputCache; TQBuffer outputBuffer; TQ_ULONG outputBufferIndex; TDEIO::filesize_t mProcessedSize; char readBuffer[IMAP_BUFFER]; ssize_t readBufferLen; int readSize; TQDateTime mTimeOfLastNoop; }; #endif