kde-playground/kdepimlibs/kimap/createjob.h
2015-04-14 21:49:29 +00:00

76 lines
2 KiB
C++

/*
Copyright (c) 2009 Andras Mantia <amantia@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef KIMAP_CREATEJOB_H
#define KIMAP_CREATEJOB_H
#include "kimap_export.h"
#include "job.h"
namespace KIMAP {
class Session;
struct Message;
class CreateJobPrivate;
/**
* 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 hierachy
* delimiters.
*/
class KIMAP_EXPORT CreateJob : public Job
{
Q_OBJECT
Q_DECLARE_PRIVATE( CreateJob )
friend class SessionPrivate;
public:
explicit CreateJob( Session *session );
virtual ~CreateJob();
/**
* Set the name of the new mailbox
*
* @param mailBox an (unquoted) identifier that does not correspond
* to an existing mailbox name
*/
void setMailBox( const QString &mailBox );
/**
* The name of the mailbox that will be created
*/
QString mailBox() const;
protected:
virtual void doStart();
};
}
#endif