Akonadi Mime

messageflags.h
1/*
2 * SPDX-FileCopyrightText: 2010 Klaralvdalens Datakonsult AB a KDAB Group company, <info@kdab.com>
3 * SPDX-FileCopyrightText: 2010 Leo Franchi <lfranchi@kde.org>
4 *
5 * SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7
8#pragma once
9
10#include "akonadi-mime_export.h"
11
12namespace KMime
13{
14class Message;
15}
16
17namespace Akonadi
18{
19class Item;
20
21/**
22 * @short Contains predefined message flag identifiers.
23 *
24 * This namespace contains identifiers of message flags that
25 * are used internally in the Akonadi server.
26 */
27namespace MessageFlags
28{
29/**
30 * The flag for a message being seen (i.e. opened by user).
31 */
32AKONADI_MIME_EXPORT extern const char Seen[];
33
34/**
35 * The flag for a message being deleted by the user.
36 */
37AKONADI_MIME_EXPORT extern const char Deleted[];
38
39/**
40 * The flag for a message being replied to by the user.
41 * @deprecated use Replied instead.
42 */
43AKONADI_MIME_EXPORT extern const char Answered[];
44
45/**
46 * The flag for a message being marked as flagged.
47 */
48AKONADI_MIME_EXPORT extern const char Flagged[];
49
50/**
51 * The flag for a message being marked with an error.
52 * @since 4.6
53 */
54AKONADI_MIME_EXPORT extern const char HasError[];
55
56/**
57 * The flag for a message being marked as having an attachment.
58 * @since 4.6
59 */
60AKONADI_MIME_EXPORT extern const char HasAttachment[];
61
62/**
63 * The flag for a message being marked as having an invitation.
64 * @since 4.6
65 */
66AKONADI_MIME_EXPORT extern const char HasInvitation[];
67
68/**
69 * The flag for a message being marked as sent.
70 * @since 4.6
71 */
72AKONADI_MIME_EXPORT extern const char Sent[];
73
74/**
75 * The flag for a message being marked as queued.
76 * @since 4.6
77 */
78AKONADI_MIME_EXPORT extern const char Queued[];
79
80/**
81 * The flag for a message being marked as replied.
82 * @since 4.6
83 */
84AKONADI_MIME_EXPORT extern const char Replied[];
85
86/**
87 * The flag for a message being marked as forwarded.
88 * @since 4.6
89 */
90AKONADI_MIME_EXPORT extern const char Forwarded[];
91
92/**
93 * The flag for a message being marked as action item to act on.
94 * @since 4.6
95 */
96AKONADI_MIME_EXPORT extern const char ToAct[];
97
98/**
99 * The flag for a message being marked as watched.
100 * @since 4.6
101 */
102AKONADI_MIME_EXPORT extern const char Watched[];
103
104/**
105 * The flag for a message being marked as ignored.
106 * @since 4.6
107 */
108AKONADI_MIME_EXPORT extern const char Ignored[];
109
110/**
111 * The flag for a message being marked as signed.
112 * @since 4.6
113 */
114AKONADI_MIME_EXPORT extern const char Signed[];
115
116/**
117 * The flag for a message being marked as encrypted.
118 * @since 4.6
119 */
120AKONADI_MIME_EXPORT extern const char Encrypted[];
121
122/**
123 * The flag for a message being marked as spam.
124 * @since 4.6
125 */
126AKONADI_MIME_EXPORT extern const char Spam[];
127
128/**
129 * The flag for a message being marked as ham.
130 * @since 4.6
131 */
132AKONADI_MIME_EXPORT extern const char Ham[];
133
134/**
135 * Copies all message flags from a KMime::Message object
136 * into an Akonadi::Item object
137 * @since 4.14.6
138 */
139AKONADI_MIME_EXPORT void copyMessageFlags(KMime::Message &from, Akonadi::Item &to);
140}
141}
AKONADI_MIME_EXPORT const char HasInvitation[]
The flag for a message being marked as having an invitation.
AKONADI_MIME_EXPORT const char Watched[]
The flag for a message being marked as watched.
AKONADI_MIME_EXPORT const char Ham[]
The flag for a message being marked as ham.
AKONADI_MIME_EXPORT const char Encrypted[]
The flag for a message being marked as encrypted.
AKONADI_MIME_EXPORT const char ToAct[]
The flag for a message being marked as action item to act on.
AKONADI_MIME_EXPORT const char Answered[]
The flag for a message being replied to by the user.
AKONADI_MIME_EXPORT const char Replied[]
The flag for a message being marked as replied.
AKONADI_MIME_EXPORT const char Spam[]
The flag for a message being marked as spam.
AKONADI_MIME_EXPORT const char Seen[]
The flag for a message being seen (i.e.
AKONADI_MIME_EXPORT const char Forwarded[]
The flag for a message being marked as forwarded.
AKONADI_MIME_EXPORT void copyMessageFlags(KMime::Message &from, Akonadi::Item &to)
Copies all message flags from a KMime::Message object into an Akonadi::Item object.
AKONADI_MIME_EXPORT const char Deleted[]
The flag for a message being deleted by the user.
AKONADI_MIME_EXPORT const char HasError[]
The flag for a message being marked with an error.
AKONADI_MIME_EXPORT const char Ignored[]
The flag for a message being marked as ignored.
AKONADI_MIME_EXPORT const char Sent[]
The flag for a message being marked as sent.
AKONADI_MIME_EXPORT const char HasAttachment[]
The flag for a message being marked as having an attachment.
AKONADI_MIME_EXPORT const char Flagged[]
The flag for a message being marked as flagged.
AKONADI_MIME_EXPORT const char Queued[]
The flag for a message being marked as queued.
AKONADI_MIME_EXPORT const char Signed[]
The flag for a message being marked as signed.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:21:09 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.