KIMAP::CloseJob Class Reference

#include <closejob.h>

Public Member Functions
	CloseJob (Session *session)
quint64	newHighestModSeq () const

Protected Member Functions
void	doStart () override
void	handleResponse (const Response &response) 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). If the QRESYNC extension (RFC5162) is available on the server and has been enabled, the job will provide a new modification sequence after expunging the deleted messages.

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

Constructor & Destructor Documentation

CloseJob()

CloseJob::CloseJob ( Session * session )

explicit

Definition at line 31 of file closejob.cpp.

Member Function Documentation

doStart()

void CloseJob::doStart ( )

overrideprotected

Definition at line 36 of file closejob.cpp.

handleResponse()

void CloseJob::handleResponse ( const Response & response )

overrideprotected

Definition at line 48 of file closejob.cpp.

newHighestModSeq()

quint64 CloseJob::newHighestModSeq ( ) const

nodiscard

Returns new modification sequence number after expunging messages.

This value is only valid when server supports the QRESYNC extension (RFC5162) and it has been explicitly enabled on this session.

See also

KIMAP::EnableJob

Since

5.16

Definition at line 42 of file closejob.cpp.

---

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

• closejob.h
• closejob.cpp