KIMAP::DeleteJob Class
Delete a mailbox. More...
| Header: | #include <KIMAP/DeleteJob> |
| CMake: | find_package(KPim6IMAP REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::IMAP) |
| Inherits: | KIMAP::Job |
Public Functions
| DeleteJob(KIMAP::Session *session) | |
| virtual | ~DeleteJob() override |
| QString | mailBox() const |
| void | setMailBox(const QString &mailBox) |
Detailed Description
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.
Member Function Documentation
[explicit] DeleteJob::DeleteJob(KIMAP::Session *session)
[override virtual noexcept] DeleteJob::~DeleteJob()
QString DeleteJob::mailBox() const
The mailbox that will be deleted.
See also setMailBox().
void DeleteJob::setMailBox(const QString &mailBox)
Set the mailbox to delete.
See also mailBox().