1 | /* |
2 | Copyright (c) 2009 Kevin Ottens <ervin@kde.org> |
3 | |
4 | This library is free software; you can redistribute it and/or modify it |
5 | under the terms of the GNU Library General Public License as published by |
6 | the Free Software Foundation; either version 2 of the License, or (at your |
7 | option) any later version. |
8 | |
9 | This library is distributed in the hope that it will be useful, but WITHOUT |
10 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
11 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public |
12 | License for more details. |
13 | |
14 | You should have received a copy of the GNU Library General Public License |
15 | along with this library; see the file COPYING.LIB. If not, write to the |
16 | Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
17 | 02110-1301, USA. |
18 | */ |
19 | |
20 | #ifndef KIMAP_LISTJOB_H |
21 | #define KIMAP_LISTJOB_H |
22 | |
23 | #include "kimap_export.h" |
24 | |
25 | #include "job.h" |
26 | |
27 | namespace KIMAP { |
28 | |
29 | class Session; |
30 | struct Message; |
31 | class ListJobPrivate; |
32 | |
33 | struct KIMAP_EXPORT MailBoxDescriptor |
34 | { |
35 | QString name; |
36 | QChar separator; |
37 | |
38 | inline bool operator==(const MailBoxDescriptor &other) const |
39 | { |
40 | return other.name == name && other.separator == separator; |
41 | } |
42 | |
43 | inline bool operator<(const MailBoxDescriptor &other) const |
44 | { |
45 | return other.name < name || ( other.name == name && other.separator < separator ); |
46 | } |
47 | }; |
48 | |
49 | class KIMAP_EXPORT ListJob : public Job |
50 | { |
51 | Q_OBJECT |
52 | Q_DECLARE_PRIVATE( ListJob ) |
53 | |
54 | friend class SessionPrivate; |
55 | |
56 | public: |
57 | enum Option { |
58 | NoOption = 0x0, /**< List only subscribed mailboxes. (Uses the LSUB IMAP command.) */ |
59 | IncludeUnsubscribed, /**< List subscribed and unsubscribed mailboxes. (Uses the LIST IMAP command.) */ |
60 | IncludeFolderRoleFlags /**< List subscribed and unsubscribed mailboxes with flags to identify standard mailboxes whose name may be localized. |
61 | The server must support the XLIST extension. */ |
62 | }; |
63 | |
64 | explicit ListJob( Session *session ); |
65 | virtual ~ListJob(); |
66 | |
67 | KIMAP_DEPRECATED void setIncludeUnsubscribed( bool include ); |
68 | KIMAP_DEPRECATED bool isIncludeUnsubscribed() const; |
69 | |
70 | void setOption( Option option ); |
71 | Option option() const; |
72 | |
73 | void setQueriedNamespaces( const QList<MailBoxDescriptor> &namespaces ); |
74 | QList<MailBoxDescriptor> queriedNamespaces() const; |
75 | |
76 | KIMAP_DEPRECATED QList<MailBoxDescriptor> mailBoxes() const; |
77 | KIMAP_DEPRECATED QMap< MailBoxDescriptor, QList<QByteArray> > flags() const; |
78 | |
79 | Q_SIGNALS: |
80 | void mailBoxesReceived( const QList<KIMAP::MailBoxDescriptor> &descriptors, |
81 | const QList< QList<QByteArray> > &flags ); |
82 | |
83 | protected: |
84 | virtual void doStart(); |
85 | virtual void handleResponse(const Message &response); |
86 | |
87 | private: |
88 | Q_PRIVATE_SLOT( d_func(), void emitPendings() ) |
89 | |
90 | /** |
91 | * @brief Converts a mailbox descriptor's name to uppercase if it is the Inbox or an Inbox subfolder. |
92 | * This is according to the RFC3501, 5.1. Mailbox Naming section. |
93 | * |
94 | * @param descriptor the descriptor to convert, conversion happens in place |
95 | **/ |
96 | void convertInboxName( KIMAP::MailBoxDescriptor &descriptor ); |
97 | }; |
98 | |
99 | } |
100 | |
101 | #endif |
102 | |