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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/*
Copyright (c) 2007 Till Adam <adam@kde.org>
Copyright (c) 2017 Christian Mollekopf <mollekopf@kolabsys.com>
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 MAILDIR_H
#define MAILDIR_H
#include <QString>
#include <QStringList>
class QDateTime;
namespace KPIM {
class Maildir
{
public:
/**
Create a new Maildir object.
@param path The path to the maildir, if @p isRoot is @c false, that's the path
to the folder containing the cur/new/tmp folders, if @p isRoot is @c true this
is the path to a folder containing a number of maildirs.
@param isRoot Indicate whether this is a maildir containing mails and various
sub-folders or a container only containing maildirs.
*/
explicit Maildir( const QString& path = QString(), bool isRoot = false );
/* Copy constructor */
Maildir(const Maildir & rhs);
/* Copy operator */
Maildir& operator=(const Maildir & rhs);
/** Equality comparison */
bool operator==(const Maildir & rhs) const;
/* Destructor */
~Maildir();
/** Returns whether the maildir has all the necessary subdirectories,
* that they are readable, etc.
* @param createMissingFolders if true (the default), the cur/new/tmp folders are created if they are missing
*/
bool isValid( bool createMissingFolders = true ) const;
/**
* Returns whether this is a normal maildir or a container containing maildirs.
*/
bool isRoot() const;
/**
* Make a valid maildir at the path of this Maildir object. This involves
* creating the necessary subdirs, etc. Note that an empty Maildir is
* not valid, unless it is given valid path, or until create( ) is
* called on it.
*/
bool create();
/**
* Remove the maildir and everything it contains.
*/
bool remove();
/**
* Returns the path of this maildir.
*/
QString path() const;
/**
* Returns the name of this maildir.
*/
QString name() const;
/**
* Returns the list of items (mails) in the maildir. These are keys, which
* map to filenames, internally, but that's an implementation detail, which
* should not be relied on.
*/
QStringList entryList() const;
/** Returns the list of items (mails) in the maildirs "new" folder. These are keys, which
* map to filenames, internally, but that's an implementation detail, which
* should not be relied on.
*/
QStringList listNew() const;
/** Returns the list of items (mails) in the maildirs "cur" folder. These are keys, which
* map to filenames, internally, but that's an implementation detail, which
* should not be relied on.
*/
QStringList listCurrent() const;
/** Return the path to the "new" directory */
QString pathToNew() const;
/** Return the path to the "cur" directory */
QString pathToCurrent() const;
/**
* Returns the full path to the subdir (the NAME.directory folder ).
**/
QString subDirPath() const;
/**
* Return the full path to the file identified by key (it can be either in the "new" or "cur" folder
**/
QString findRealKey( const QString& key ) const;
/**
* Returns the list of subfolders, as names (relative paths). Use the
* subFolder method to get Maildir objects representing them.
*/
QStringList subFolderList() const;
/**
* Adds subfolder with the given @p folderName.
* @return an empty string on failure or the full path of the new subfolder
* on success
*/
QString addSubFolder( const QString& folderName );
/**
* Removes subfolder with the given @p folderName. Returns success or failure.
*/
bool removeSubFolder( const QString& folderName );
/**
* Returns a Maildir object for the given @p folderName. If such a folder
* exists, the Maildir object will be valid, otherwise you can call create()
* on it, to make a subfolder with that name.
*/
Maildir subFolder( const QString& folderName ) const;
/**
* Returns the parent Maildir object for this Maildir, if there is one (ie. this is not the root).
*/
Maildir parent() const;
/**
* Returns the size of the file in the maildir with the given @p key or \c -1 if key is not valid.
* @since 4.2
*/
qint64 size( const QString& key ) const;
/**
* Returns the modification time of the file in the maildir with the given @p key.
* @since 4.7
*/
QDateTime lastModified( const QString &key ) const;
/**
* Move all mails in new to cur
*/
void importNewMails();
/**
* Return the contents of the file in the maildir with the given @p key.
*/
QByteArray readEntry( const QString& key ) const;
enum Flag {
Forwarded = 0x1,
Replied = 0x2,
Seen = 0x4,
Flagged = 0x8,
Deleted = 0x10
};
Q_DECLARE_FLAGS(Flags, Flag);
/**
* Return the flags encoded in the maildir file name for an entry
**/
static Flags readEntryFlags( const QString& key );
/**
* Return the contents of the headers section of the file the maildir with the given @p file, that
* is a full path to the file. You can get it by using findRealKey(key) .
*/
static QByteArray readEntryHeadersFromFile( const QString& file );
/**
* Return the contents of the headers section of the file the maildir with the given @p key.
*/
QByteArray readEntryHeaders( const QString& key ) const;
/**
* Write the given @p data to a file in the maildir with the given @p key.
* Returns true in case of success, false in case of any error.
*/
bool writeEntry( const QString& key, const QByteArray& data );
/**
* Adds the given @p data to the maildir. Returns the key of the entry.
*/
QString addEntry( const QByteArray& data );
QString addEntryFromPath(const QString& path);
/**
* Removes the entry with the given @p key. Returns success or failure.
*/
bool removeEntry( const QString& key );
/**
* Change the flags for an entry specified by @p key. Returns the new key of the entry (the key might change because
* flags are stored in the unique filename).
*/
QString changeEntryFlags( const QString& key, const Flags& flags );
/**
* Moves this maildir into @p destination.
*/
bool moveTo( const Maildir &destination );
/**
* Renames this maildir to @p newName.
*/
bool rename( const QString &newName );
/**
* Moves the file with the given @p key into the Maildir @p destination.
* @returns The new file name inside @p destination.
*/
QString moveEntryTo( const QString& key, const KPIM::Maildir& destination );
/**
* Creates the maildir tree structure specific directory path that the
* given @p folderPath folder would have for its sub folders
* @param folderPath a maildir folder path
* @return the relative subDirPath for the given @p folderPath
*
* @see subDirNameForFolderName()
*/
static QString subDirPathForFolderPath( const QString &folderPath );
/**
* Creates the maildir tree structure specific directory name that the
* given @p folderName folder would have for its sub folders
* @param folderName a maildir folder name
* @return the relative subDirName for the given @p folderMame
*
* @see subDirPathForFolderPath()
*/
static QString subDirNameForFolderName( const QString &folderName );
/**
* Returns the key from the file identified by the full path @param file.
*/
static QString getKeyFromFile( const QString& file );
/**
* Returns the directory from a file.
*
* Strips key and new/cur/tmp.
* The returned path is ended with a trailing slash.
*/
static QString getDirectoryFromFile( const QString& file );
private:
void swap( const Maildir& );
class Private;
Private *d;
};
}
#endif // __MAILDIR_H__
|
