• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

kioslave/imap4

IMAP4Protocol Class Reference

#include <imap4.h>

Inheritance diagram for IMAP4Protocol:

Inheritance graph
[legend]

List of all members.


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.


Public Member Functions

 IMAP4Protocol (const QByteArray &pool, const QByteArray &app, bool isSSL)
virtual void openConnection ()
virtual void closeConnection ()
virtual void setHost (const QString &_host, quint16 _port, const QString &_user, const QString &_pass)
virtual void get (const KUrl &_url)
virtual void stat (const KUrl &_url)
virtual void slave_status ()
virtual void del (const KUrl &_url, bool isFile)
virtual void special (const QByteArray &data)
virtual void listDir (const KUrl &_url)
virtual void setSubURL (const KUrl &_url)
virtual void dispatch (int command, const QByteArray &data)
virtual void mkdir (const KUrl &url, int permissions)
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 copy (const KUrl &src, const KUrl &dest, int permissions, KIO::JobFlags flags)
virtual void parseRelay (const QByteArray &buffer)
virtual void parseRelay (ulong)
virtual bool parseRead (QByteArray &buffer, long len, long relay=0)
virtual bool parseReadLine (QByteArray &buffer, long relay=0)
virtual void parseWriteLine (const QString &)
virtual int outputLine (const QByteArray &_str, int len=-1)
virtual void flushOutput (const QString &contentEncoding=QString())

Protected Member Functions

bool assureBox (const QString &aBox, bool readonly)
ssize_t myRead (void *data, ssize_t len)
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)
void doListEntry (const KUrl &_url, int stretch, imapCache *cache=NULL, bool withFlags=false, bool withSubject=false)
void doListEntry (const KUrl &url, const QString &myBox, const imapList &item, bool appendPath=true)
void specialACLCommand (int command, QDataStream &stream)
void specialAnnotateMoreCommand (int command, QDataStream &stream)
void specialQuotaCommand (int command, QDataStream &stream)
void specialSearchCommand (QDataStream &)
void specialCustomCommand (QDataStream &)

Member Function Documentation

void IMAP4Protocol::get ( const KUrl &  _url  )  [virtual]

get a message or part of a message the data is normally sent 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

Definition at line 185 of file imap4.cpp.

void IMAP4Protocol::stat ( const KUrl &  _url  )  [virtual]

stat a mailbox, message, attachment

Definition at line 1832 of file imap4.cpp.

void IMAP4Protocol::del ( const KUrl &  _url,
bool  isFile 
) [virtual]

delete a mailbox

Definition at line 1073 of file imap4.cpp.

void IMAP4Protocol::special ( const QByteArray &  data  )  [virtual]

Capabilities, NOOP, (Un)subscribe, Change status, Change ACL.

Definition at line 1214 of file imap4.cpp.

void IMAP4Protocol::listDir ( const KUrl &  _url  )  [virtual]

list a directory/mailbox

Definition at line 397 of file imap4.cpp.

void IMAP4Protocol::mkdir ( const KUrl &  url,
int  permissions 
) [virtual]

create a mailbox

Definition at line 913 of file imap4.cpp.

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

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

Definition at line 640 of file imap4.cpp.

void IMAP4Protocol::parseRelay ( ulong  len  )  [virtual]

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

Definition at line 660 of file imap4.cpp.

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

reimplement the parser read at least len bytes

Definition at line 667 of file imap4.cpp.

bool IMAP4Protocol::parseReadLine ( QByteArray &  buffer,
long  relay = 0 
) [virtual]

reimplement the parser

read at least a line (up to CRLF)

Definition at line 704 of file imap4.cpp.

void IMAP4Protocol::parseWriteLine ( const QString &  aStr  )  [virtual]

reimplement the parser

write argument to the server

Definition at line 2172 of file imap4.cpp.

int IMAP4Protocol::outputLine ( const QByteArray &  _str,
int  len = -1 
) [virtual]

reimplement the mimeIO

Reimplemented from mimeIO.

Definition at line 2508 of file imap4.cpp.

void IMAP4Protocol::flushOutput ( const QString &  contentEncoding = QString()  )  [virtual]

send out cached data to the application

Definition at line 2537 of file imap4.cpp.

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]

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

Definition at line 2379 of file imap4.cpp.

void IMAP4Protocol::doListEntry ( const KUrl &  url,
const QString &  myBox,
const imapList &  item,
bool  appendPath = true 
) [protected]

Send a list entry (folder) to the application If appendPath is true the foldername will be appended to the path of url.

Definition at line 2280 of file imap4.cpp.

void IMAP4Protocol::specialACLCommand ( int  command,
QDataStream &  stream 
) [protected]

Send an ACL command which is identified by command.

Definition at line 1438 of file imap4.cpp.

void IMAP4Protocol::specialAnnotateMoreCommand ( int  command,
QDataStream &  stream 
) [protected]

Send an annotation command which is identified by command.

Definition at line 1647 of file imap4.cpp.

void IMAP4Protocol::specialSearchCommand ( QDataStream &  stream  )  [protected]

Search current folder, the search string is passed as SECTION.

Definition at line 1540 of file imap4.cpp.

void IMAP4Protocol::specialCustomCommand ( QDataStream &  stream  )  [protected]

Send a custom command to the server.

In 'normal' mode we send the command with all information in one go and retrieve the result.

In 'extended' mode we send a first header and push the data of the request in streaming mode.

Definition at line 1568 of file imap4.cpp.


The documentation for this class was generated from the following files:
  • imap4.h
  • imap4.cpp

kioslave/imap4

Skip menu "kioslave/imap4"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
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