KIMAP::DeleteJob

Search for usage in LXR

#include <deletejob.h>

Inherits KIMAP::Job.

Public Member Functions

 DeleteJob (Session *session)
 
QString mailBox () const
 
void setMailBox (const QString &mailBox)
 

Protected Member Functions

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

Detailed Description

Delete a mailbox.

Note that some servers will refuse to delete a mailbox unless it is empty (ie: all mails have had their \Deleted flag set, and then the mailbox has been expunged).

This job can only be run when the session is in the authenticated (or selected) state.

If the server supports ACLs, you will need the Acl::DeleteMailbox right on the mailbox.

Definition at line 32 of file deletejob.h.

Constructor & Destructor Documentation

◆ DeleteJob()

DeleteJob::DeleteJob ( Session * session)
explicit

Definition at line 35 of file deletejob.cpp.

◆ ~DeleteJob()

DeleteJob::~DeleteJob ( )
override

Definition at line 40 of file deletejob.cpp.

Member Function Documentation

◆ doStart()

void DeleteJob::doStart ( )
overrideprotected

Definition at line 44 of file deletejob.cpp.

◆ handleResponse()

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

Definition at line 50 of file deletejob.cpp.

◆ mailBox()

QString DeleteJob::mailBox ( ) const

The mailbox that will be deleted.

Definition at line 80 of file deletejob.cpp.

◆ setMailBox()

void DeleteJob::setMailBox ( const QString & mailBox)

Set the mailbox to delete.

Definition at line 74 of file deletejob.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 Jun 7 2024 12:07:13 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.