File indexing completed on 2024-05-12 05:17:21
0001 /* 0002 Copyright (c) 2009 Andras Mantia <amantia@kde.org> 0003 0004 This library is free software; you can redistribute it and/or modify it 0005 under the terms of the GNU Library General Public License as published by 0006 the Free Software Foundation; either version 2 of the License, or (at your 0007 option) any later version. 0008 0009 This library is distributed in the hope that it will be useful, but WITHOUT 0010 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0011 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public 0012 License for more details. 0013 0014 You should have received a copy of the GNU Library General Public License 0015 along with this library; see the file COPYING.LIB. If not, write to the 0016 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 0017 02110-1301, USA. 0018 */ 0019 0020 #ifndef KIMAP2_CREATEJOB_H 0021 #define KIMAP2_CREATEJOB_H 0022 0023 #include "kimap2_export.h" 0024 0025 #include "job.h" 0026 0027 namespace KIMAP2 0028 { 0029 0030 class Session; 0031 struct Message; 0032 class CreateJobPrivate; 0033 0034 /** 0035 * Creates a new mailbox 0036 * 0037 * This job can only be run when the session is in the 0038 * authenticated (or selected) state. 0039 * 0040 * This job will fail if the mailbox already exists. 0041 * 0042 * If the server supports ACLs, the user must have the 0043 * Acl::CreateMailbox permission on the parent 0044 * mailbox. Note that what is meant by "parent mailbox" 0045 * depends on the server: . and / are typical hierachy 0046 * delimiters. 0047 */ 0048 class KIMAP2_EXPORT CreateJob : public Job 0049 { 0050 Q_OBJECT 0051 Q_DECLARE_PRIVATE(CreateJob) 0052 0053 friend class SessionPrivate; 0054 0055 public: 0056 explicit CreateJob(Session *session); 0057 virtual ~CreateJob(); 0058 0059 /** 0060 * Set the name of the new mailbox 0061 * 0062 * @param mailBox an (unquoted) identifier that does not correspond 0063 * to an existing mailbox name 0064 */ 0065 void setMailBox(const QString &mailBox); 0066 /** 0067 * The name of the mailbox that will be created 0068 */ 0069 QString mailBox() const; 0070 0071 protected: 0072 void doStart() override; 0073 void handleResponse(const Message &response) override; 0074 }; 0075 0076 } 0077 0078 #endif