KIMAP::ExpungeJob Class

Expunges the deleted messages in the selected mailbox. More...

Header: #include <KIMAP/ExpungeJob>
CMake: find_package(KPim6IMAP REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::IMAP)
Inherits: KIMAP::Job

Public Functions

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

Detailed Description

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.

Member Function Documentation

[explicit] ExpungeJob::ExpungeJob(KIMAP::Session *session)

[override virtual noexcept] ExpungeJob::~ExpungeJob()

quint64 ExpungeJob::newHighestModSeq() const

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.

KIMAP::ImapSet ExpungeJob::vanishedMessages() const

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.