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

81 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_ACLJOBBASE_H
#define KIMAP_ACLJOBBASE_H
#include "kimap_export.h"
#include "acl.h"
#include "job.h"
namespace KIMAP {
class Session;
struct Message;
class AclJobBasePrivate;
/**
* Base class for jobs that operate on mailbox ACLs
*
* Provides support for the IMAP ACL extension, as defined by
* <a href="http://www.apps.ietf.org/rfc/rfc4314.html" title="IMAP ACL extension">RFC 4314</a>.
*
* This class cannot be used directly, you must subclass it and reimplement
* at least the doStart() method.
*/
class KIMAP_EXPORT AclJobBase : public Job
{
Q_OBJECT
Q_DECLARE_PRIVATE( AclJobBase )
friend class SessionPrivate;
public:
AclJobBase( Session *session );
virtual ~AclJobBase();
/**
* Used when subclassing to specify how the ACL will be modified.
*/
enum AclModifier {
Add = 0,
Remove,
Change
};
/**
* Set the mailbox to act on
*
* @param mailBox the name of an existing mailbox
*/
void setMailBox( const QString &mailBox );
/**
* The mailbox that will be acted upon.
*/
QString mailBox() const;
protected:
explicit AclJobBase( JobPrivate &dd );
};
}
#endif