KIMAP::CreateJob Class Reference

#include <createjob.h>

Public Member Functions
	CreateJob (Session *session)
QString	mailBox () const
void	setMailBox (const QString &mailBox)

Protected Member Functions
void	doStart () override
void	handleResponse (const Response &response) override

Detailed Description

Creates a new mailbox.

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.

Definition at line 33 of file createjob.h.

Constructor & Destructor Documentation

CreateJob()

CreateJob::CreateJob ( Session * session )

explicit

Definition at line 35 of file createjob.cpp.

~CreateJob()

CreateJob::~CreateJob ( )

override

Definition at line 40 of file createjob.cpp.

Member Function Documentation

doStart()

void CreateJob::doStart ( )

overrideprotected

Definition at line 44 of file createjob.cpp.

handleResponse()

void CreateJob::handleResponse ( const Response & response )

overrideprotected

Definition at line 50 of file createjob.cpp.

mailBox()

QString CreateJob::mailBox ( ) const

nodiscard

The name of the mailbox that will be created.

Definition at line 80 of file createjob.cpp.

setMailBox()

void CreateJob::setMailBox

(

const QString &

mailBox

)

Set the name of the new mailbox.

Parameters

mailBox

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

Definition at line 74 of file createjob.cpp.

---

The documentation for this class was generated from the following files:

• createjob.h
• createjob.cpp