KIMAP::CreateJob Class

Creates a new mailbox. More...

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

Public Functions

CreateJob(KIMAP::Session *session)
virtual ~CreateJob() override
QString mailBox() const
void setMailBox(const QString &mailBox)

Detailed Description

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

This job will fail if the mailbox already exists.

If the server supports ACLs, the user must have the Acl::CreateMailbox permission on the parent mailbox. Note that what is meant by "parent mailbox" depends on the server: . and / are typical hierarchy delimiters.

Member Function Documentation

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

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

QString CreateJob::mailBox() const

The name of the mailbox that will be created

See also setMailBox().

void CreateJob::setMailBox(const QString &mailBox)

Set the name of the new mailbox

mailBox an (unquoted) identifier that does not correspond to an existing mailbox name

See also mailBox().