/usr/include/KF5/KIMAP/kimap/copyjob.h is in libkf5imap-dev 17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | /*
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_COPYJOB_H
#define KIMAP_COPYJOB_H
#include "kimap_export.h"
#include "job.h"
#include "imapset.h"
namespace KIMAP
{
class Session;
struct Message;
class CopyJobPrivate;
/**
* Copies one or more messages to another mailbox.
*
* This job can only be run when the session is in the selected state.
*
* If the server supports ACLs, the user will need the
* Acl::Insert right on the target mailbox.
* In order to preserve message flags, the user may also need
* some combination of Acl::DeleteMessage,
* Acl::KeepSeen and Acl::Write on the
* target mailbox.
*/
class KIMAP_EXPORT CopyJob : public Job
{
Q_OBJECT
Q_DECLARE_PRIVATE(CopyJob)
friend class SessionPrivate;
public:
explicit CopyJob(Session *session);
virtual ~CopyJob();
/**
* Sets the destination mailbox.
*
* If the mailbox does not exist, the server should not create
* it automatically and the job should fail. Note, however,
* that a conforming server may create the mailbox automatically.
*
* @param mailBox the (unquoted) name of the mailbox where the
* messages should be copied to
*/
void setMailBox(const QString &mailBox);
/**
* The destination mailbox
*/
QString mailBox() const;
/**
* Sets the messages to be copied
*
* If sequence numbers are given, isUidBased() should be false. If UIDs
* are given, isUidBased() should be true.
*
* RFC 3501 is unclear as to what should happen if invalid sequence numbers
* are passed. If non-existent UIDs are passed, they will be ignored.
*
* @param set the sequence numbers or UIDs of the messages to be copied
*/
void setSequenceSet(const ImapSet &set);
/**
* The messages that will be copied.
*
* isUidBased() can be used to check whether the ImapSet contains
* sequence numbers or UIDs.
*
* @return the sequence numbers or UIDs of the messages to be copied
*/
ImapSet sequenceSet() const;
/**
* Set how the sequence set should be interpreted.
*
* @param uidBased if @c true the argument to setSequenceSet will be
* interpreted as UIDs, if @c false it will be interpreted
* as sequence numbers
*/
void setUidBased(bool uidBased);
/**
* How to interpret the sequence set.
*
* @return if @c true the result of sequenceSet() should be
* interpreted as UIDs, if @c false it should be interpreted
* as sequence numbers
*/
bool isUidBased() const;
/**
* The UIDs of the new copies of the messages
*
* This will be an empty set if no messages have been copied yet
* or if the server does not support the UIDPLUS extension.
*/
ImapSet resultingUids() const;
protected:
void doStart() override;
void handleResponse(const Response &response) override;
};
}
#endif
|