kioslave/imap4
IMAP4Protocol Class Reference
IOSlave derived class. More...
#include <imap4.h>
Inheritance diagram for IMAP4Protocol:

Public Member Functions | |
virtual void | closeConnection () |
virtual void | copy (const KUrl &src, const KUrl &dest, int permissions, KIO::JobFlags flags) |
virtual void | del (const KUrl &_url, bool isFile) |
virtual void | dispatch (int command, const QByteArray &data) |
virtual void | flushOutput (const QString &contentEncoding=QString()) |
virtual void | get (const KUrl &_url) |
IMAP4Protocol (const QByteArray &pool, const QByteArray &app, bool isSSL) | |
virtual void | listDir (const KUrl &_url) |
virtual void | mkdir (const KUrl &url, int permissions) |
virtual void | openConnection () |
virtual int | outputLine (const QByteArray &_str, int len=-1) |
virtual bool | parseRead (QByteArray &buffer, long len, long relay=0) |
virtual bool | parseReadLine (QByteArray &buffer, long relay=0) |
virtual void | parseRelay (ulong) |
virtual void | parseRelay (const QByteArray &buffer) |
virtual void | parseWriteLine (const QString &) |
virtual void | put (const KUrl &url, int permissions, KIO::JobFlags flags) |
virtual void | rename (const KUrl &src, const KUrl &dest, KIO::JobFlags flags) |
virtual void | setHost (const QString &_host, quint16 _port, const QString &_user, const QString &_pass) |
virtual void | setSubURL (const KUrl &_url) |
virtual void | slave_status () |
virtual void | special (const QByteArray &data) |
virtual void | stat (const KUrl &_url) |
Protected Member Functions | |
bool | assureBox (const QString &aBox, bool readonly) |
void | doListEntry (const KUrl &url, const QString &myBox, const imapList &item, bool appendPath=true) |
void | doListEntry (const KUrl &_url, int stretch, imapCache *cache=NULL, bool withFlags=false, bool withSubject=false) |
QString | getMimeType (enum IMAP_TYPE) |
bool | makeLogin () |
ssize_t | myRead (void *data, ssize_t len) |
void | outputLineStr (const QString &_str) |
enum IMAP_TYPE | parseURL (const KUrl &_url, QString &_box, QString &_section, QString &_type, QString &_uid, QString &_validity, QString &_hierarchyDelimiter, QString &_info, bool cache=false) |
void | specialACLCommand (int command, QDataStream &stream) |
void | specialAnnotateMoreCommand (int command, QDataStream &stream) |
void | specialCustomCommand (QDataStream &) |
void | specialQuotaCommand (int command, QDataStream &stream) |
void | specialSearchCommand (QDataStream &) |
Detailed Description
IOSlave derived class.
- Note:
- References:
- RFC 2060 - Internet Message Access Protocol - Version 4rev1 - December 1996
- RFC 2192 - IMAP URL Scheme - September 1997
- RFC 1731 - IMAP Authentication Mechanisms - December 1994 (Discusses KERBEROSv4, GSSAPI, and S/Key)
- RFC 2195 - IMAP/POP AUTHorize Extension for Simple Challenge/Response
- September 1997 (CRAM-MD5 authentication method)
- RFC 2104 - HMAC: Keyed-Hashing for Message Authentication - February 1997
- RFC 2086 - IMAP4 ACL extension - January 1997
- http://www.ietf.org/internet-drafts/draft-daboo-imap-annotatemore-05.txt IMAP ANNOTATEMORE draft - April 2004.
Supported URLs:
imap://server/ imap://user:pass@server/ imap://user;AUTH=method:pass@server/ imap://server/folder/ *
These URLs cause the following actions (in order):
- Prompt for user/pass, list all folders in home directory
- Uses LOGIN to log in
- Uses AUTHENTICATE to log in
- List messages in folder
- Note:
- API notes: Not receiving the required write access for a folder means ERR_CANNOT_OPEN_FOR_WRITING. ERR_DOES_NOT_EXIST is reserved for folders.
Definition at line 50 of file imap4.h.
Member Function Documentation
void IMAP4Protocol::del | ( | const KUrl & | _url, | |
bool | isFile | |||
) | [virtual] |
void IMAP4Protocol::doListEntry | ( | const KUrl & | url, | |
const QString & | myBox, | |||
const imapList & | item, | |||
bool | appendPath = true | |||
) | [protected] |
void IMAP4Protocol::flushOutput | ( | const QString & | contentEncoding = QString() |
) | [virtual] |
void IMAP4Protocol::get | ( | const KUrl & | _url | ) | [virtual] |
void IMAP4Protocol::listDir | ( | const KUrl & | _url | ) | [virtual] |
void IMAP4Protocol::mkdir | ( | const KUrl & | url, | |
int | permissions | |||
) | [virtual] |
int IMAP4Protocol::outputLine | ( | const QByteArray & | _str, | |
int | len = -1 | |||
) | [virtual] |
bool IMAP4Protocol::parseRead | ( | QByteArray & | buffer, | |
long | len, | |||
long | relay = 0 | |||
) | [virtual] |
bool IMAP4Protocol::parseReadLine | ( | QByteArray & | buffer, | |
long | relay = 0 | |||
) | [virtual] |
void IMAP4Protocol::parseRelay | ( | ulong | len | ) | [virtual] |
void IMAP4Protocol::parseRelay | ( | const QByteArray & | buffer | ) | [virtual] |
enum IMAP_TYPE IMAP4Protocol::parseURL | ( | const KUrl & | _url, | |
QString & | _box, | |||
QString & | _section, | |||
QString & | _type, | |||
QString & | _uid, | |||
QString & | _validity, | |||
QString & | _hierarchyDelimiter, | |||
QString & | _info, | |||
bool | cache = false | |||
) | [protected] |
void IMAP4Protocol::parseWriteLine | ( | const QString & | aStr | ) | [virtual] |
void IMAP4Protocol::special | ( | const QByteArray & | data | ) | [virtual] |
void IMAP4Protocol::specialACLCommand | ( | int | command, | |
QDataStream & | stream | |||
) | [protected] |
void IMAP4Protocol::specialAnnotateMoreCommand | ( | int | command, | |
QDataStream & | stream | |||
) | [protected] |
void IMAP4Protocol::specialCustomCommand | ( | QDataStream & | stream | ) | [protected] |
void IMAP4Protocol::specialSearchCommand | ( | QDataStream & | stream | ) | [protected] |
void IMAP4Protocol::stat | ( | const KUrl & | _url | ) | [virtual] |
The documentation for this class was generated from the following files: