KIMAP2::CloseJob Class Reference

#include <closejob.h>

Public Member Functions
	CloseJob (Session *session)

Protected Member Functions
void	doStart () override

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 53 of file closejob.h.

Constructor & Destructor Documentation

CloseJob()

CloseJob::CloseJob ( Session * session )

explicit

Definition at line 38 of file closejob.cpp.

~CloseJob()

CloseJob::~CloseJob ( )

virtual

Definition at line 43 of file closejob.cpp.

Member Function Documentation

doStart()

void CloseJob::doStart ( )

overrideprotected

Definition at line 47 of file closejob.cpp.

---

The documentation for this class was generated from the following files:

• closejob.h
• closejob.cpp