KIMAP::CloseJob

#include <closejob.h>

Inherits KIMAP::Job.

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

Member Function Documentation

quint64 CloseJob::newHighestModSeq ( ) const

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 39 of file closejob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 23:12:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.