• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • CloseJob
Public Member Functions | Protected Member Functions | List of all members
KIMAP::CloseJob Class Reference

#include <closejob.h>

Inherits KIMAP::Job.

Public Member Functions

 CloseJob (Session *session)
 
- Public Member Functions inherited from KIMAP::Job
Session * session () const
 
virtual void start ()
 

Protected Member Functions

virtual void doStart ()
 
- Protected Member Functions inherited from KIMAP::Job
 Job (Session *session)
 
 Job (JobPrivate &dd)
 
HandlerResponse handleErrorReplies (const Message &response)
 

Additional Inherited Members

- Protected Types inherited from KIMAP::Job
enum  HandlerResponse { Handled = 0, NotHandled }
 
- Protected Attributes inherited from KIMAP::Job
JobPrivate *const d_ptr
 

Detailed Description

Closes the current mailbox.

This job can only be run when the session is in the selected state.

Permanently removes all messages that have the \Deleted flag set from the currently selected mailbox, and returns to the authenticated state from the selected state.

The server will not provide any notifications of which messages were expunged, so this is quicker than doing an expunge and then implicitly closing the mailbox (by selecting or examining another mailbox or logging out).

No messages are removed if the mailbox is open in a read-only state, or if the server supports ACLs and the user does not have the Acl::Expunge right on the mailbox.

Definition at line 52 of file closejob.h.


The documentation for this class was generated from the following files:
  • closejob.h
  • closejob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:25:18 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal