KIMAP::ExpungeJob

Search for usage in LXR

#include <expungejob.h>

Inherits KIMAP::Job.

Public Member Functions

 ExpungeJob (Session *session)
 
quint64 newHighestModSeq () const
 
KIMAP::ImapSet vanishedMessages () const
 

Protected Member Functions

void doStart () override
 
void handleResponse (const Response &response) override
 

Detailed Description

Expunges the deleted messages in the selected mailbox.

This permanently removes any messages that have the \Deleted flag set in the selected mailbox.

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

If the server supports ACLs, the user will need the Acl::Expunge right on the mailbox.

Definition at line 32 of file expungejob.h.

Constructor & Destructor Documentation

◆ ExpungeJob()

ExpungeJob::ExpungeJob ( Session * session)
explicit

Definition at line 36 of file expungejob.cpp.

Member Function Documentation

◆ doStart()

void ExpungeJob::doStart ( )
overrideprotected

Definition at line 53 of file expungejob.cpp.

◆ handleResponse()

void ExpungeJob::handleResponse ( const Response & response)
overrideprotected

Definition at line 59 of file expungejob.cpp.

◆ newHighestModSeq()

quint64 ExpungeJob::newHighestModSeq ( ) const
nodiscard

Returns new highest modification sequence number.

This feature is only available when QRESYNC capability (RFC5162) is supported by the server and have been enabled on the current session.

See also
KIMAP::EnableJob
Since
5.16

Definition at line 47 of file expungejob.cpp.

◆ vanishedMessages()

KIMAP::ImapSet ExpungeJob::vanishedMessages ( ) const
nodiscard

Returns UIDs of messages that have been expunged.

This feature is only available when QRESYNC capability (RFC5162) is supported by the server and have been enabled on the current session.

See also
KIMAP::EnableJob
Since
5.16

Definition at line 41 of file expungejob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:56:18 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.