• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • IdleJob
Public Slots | Signals | Public Member Functions | Protected Member Functions
KIMAP::IdleJob Class Reference

Idles the connection to the IMAP server. More...

#include <idlejob.h>

Inherits KIMAP::Job.

List of all members.

Public Slots

void stop ()

Signals

void mailBoxStats (KIMAP::IdleJob *job, const QString &mailBox, int messageCount, int recentCount)

Public Member Functions

 IdleJob (Session *session)
QString lastMailBox () const
int lastMessageCount () const
int lastRecentCount () const

Protected Member Functions

virtual void doStart ()
virtual void handleResponse (const Message &response)

Detailed Description

Idles the connection to the IMAP server.

This job can be run while the client has no other use for the connection, and the server will send updates about the selected mailbox.

Note that although the server may send a variety of responses while the job is running (including EXPUNGE, for example), only RECENT and EXISTS responses are actually reported by this job.

The job also processes updates in pairs - if the server sends an EXISTS update but not a RECENT one (because another client is changing the mailbox contents), this job will not report the update.

It only makes sense to run this job when the session is in the selected state.

This job requires that the server supports the IDLE capability, defined in RFC 2177.

Definition at line 63 of file idlejob.h.


Member Function Documentation

QString KIMAP::IdleJob::lastMailBox ( ) const

The last mailbox status that was reported.

This is just the session's selected mailbox.

Definition at line 142 of file idlejob.cpp.

int KIMAP::IdleJob::lastMessageCount ( ) const

The last message count that was reported.

The server will send updates about the number of messages in the mailbox when that number changes. This is the last number it reported.

Returns:
the last message count the server reported, or -1 if it has not reported a message count since the job started.

Definition at line 148 of file idlejob.cpp.

int KIMAP::IdleJob::lastRecentCount ( ) const

The last recent message count that was reported.

The server will send updates about the number of messages in the mailbox that are tagged with when that number changes. This is the last number it reported.

Returns:
the last recent message count the server reported, or -1 if it has not reported a recent message count since the job started.

Definition at line 154 of file idlejob.cpp.

void KIMAP::IdleJob::mailBoxStats ( KIMAP::IdleJob *  job,
const QString &  mailBox,
int  messageCount,
int  recentCount 
) [signal]

Signals that the server has notified that the total and recent message counts have changed.

Parameters:
jobthis object
mailBoxthe selected mailbox
messageCountthe new total message count reported by the server
recentCountthe new "recent message" count reported by the server
void KIMAP::IdleJob::stop ( ) [slot]

Stops the idle job.

Definition at line 83 of file idlejob.cpp.


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

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.4
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