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
|
/*
* Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef MAILCOMMON_ITEMCONTEXT_H
#define MAILCOMMON_ITEMCONTEXT_H
#include "mailcommon_export.h"
#include "mailcommon/searchpattern.h"
#include <Collection>
#include <Item>
namespace MailCommon {
/**
* @short A helper class for the filtering process
*
* The item context is used to pass the item together with meta data
* through the filter chain.
* This allows to 'record' all actions that shall be taken and execute them
* at the end of the filter chain.
*/
class MAILCOMMON_EXPORT ItemContext
{
public:
/**
* Creates an item context for the given @p item.
* @p requestedPart the part requested for the item (Envelope, Header or CompleteMessage)
*/
ItemContext(const Akonadi::Item &item, bool needsFullPayload);
/**
* Returns the item of the context.
*/
Akonadi::Item &item();
/**
* Sets the target collection the item should be moved to.
*/
void setMoveTargetCollection(const Akonadi::Collection &collection);
/**
* Returns the target collection the item should be moved to, or an invalid
* collection if the item should not be moved at all.
*/
Akonadi::Collection moveTargetCollection() const;
/**
* Marks that the item's payload has been changed and needs to be written back.
*/
void setNeedsPayloadStore();
/**
* Returns whether the item's payload needs to be written back.
*/
bool needsPayloadStore() const;
/**
* Marks that the item's flags has been changed and needs to be written back.
*/
void setNeedsFlagStore();
/**
* Returns whether the item's flags needs to be written back.
*/
bool needsFlagStore() const;
/** Returns true if the full payload was requested for the item or not.
* Full payload is needed to change the headers or the body */
bool needsFullPayload() const;
void setDeleteItem();
bool deleteItem() const;
private:
enum ItemContextAction {
None = 0,
PlayloadStore = 1,
FlagStore = 2,
DeleteItem = 4,
FullPayload = 8
};
Q_DECLARE_FLAGS(ItemContextActions, ItemContextAction)
Akonadi::Item mItem;
Akonadi::Collection mMoveTargetCollection;
ItemContextActions mItemContextAction;
};
}
#endif
|
