|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \class QMailMessageHeaderFieldFwd |
|
44 \preliminary |
|
45 \brief The QMailMessageHeaderFieldFwd class declares enumerations used by QMailMessageHeaderField |
|
46 |
|
47 QMailMessageHeaderFieldFwd allows QMailMessageHeaderField::FieldType |
|
48 to be used without including all of \c qmailmessage.h. |
|
49 */ |
|
50 |
|
51 /*! |
|
52 \enum QMailMessageHeaderFieldFwd::FieldType |
|
53 |
|
54 This enum type is used to describe the formatting of field content. |
|
55 |
|
56 \value StructuredField The field content should be parsed assuming it is structured according to the specification for RFC 2045 'Content-Type' fields. |
|
57 \value UnstructuredField The field content has no internal structure. |
|
58 */ |
|
59 |
|
60 /*! |
|
61 \class QMailMessageContentDispositionFwd |
|
62 \preliminary |
|
63 \brief The QMailMessageContentDispositionFwd class declares enumerations used by QMailMessageContentDisposition |
|
64 |
|
65 QMailMessageContentDispositionFwd allows QMailMessageContentDisposition::DispositionType |
|
66 to be used without including all of \c qmailmessage.h. |
|
67 */ |
|
68 |
|
69 /*! |
|
70 \enum QMailMessageContentDispositionFwd::DispositionType |
|
71 |
|
72 This enum type is used to describe the disposition of a message part. |
|
73 |
|
74 \value Attachment The part data should be presented as an attachment. |
|
75 \value Inline The part data should be presented inline. |
|
76 \value None The disposition of the part is unknown. |
|
77 */ |
|
78 |
|
79 /*! |
|
80 \class QMailMessageBodyFwd |
|
81 \preliminary |
|
82 \brief The QMailMessageBodyFwd class declares enumerations used by QMailMessageBody |
|
83 |
|
84 QMailMessageBodyFwd allows QMailMessageBody::TransferEncoding and QMailMessageBody::EncodingStatus |
|
85 to be used without including all of \c qmailmessage.h. |
|
86 */ |
|
87 |
|
88 /*! |
|
89 \enum QMailMessageBodyFwd::TransferEncoding |
|
90 |
|
91 This enum type is used to describe a type of binary to text encoding. |
|
92 Encoding types used here are documented in |
|
93 \l {http://www.ietf.org/rfc/rfc2045.txt}{RFC 2045} "Format of Internet Message Bodies" |
|
94 |
|
95 \value NoEncoding The encoding is not specified. |
|
96 \value SevenBit The data is not encoded, but contains only 7-bit ASCII data. |
|
97 \value EightBit The data is not encoded, but contains data using only 8-bit characters which form a superset of ASCII. |
|
98 \value Base64 A 65-character subset of US-ASCII is used, enabling 6 bits to be represented per printable character. |
|
99 \value QuotedPrintable A method of encoding that tends to leave text similar to US-ASCII unmodified for readability. |
|
100 \value Binary The data is not encoded to any limited subset of octet values. |
|
101 |
|
102 \sa QMailCodec |
|
103 */ |
|
104 |
|
105 /*! |
|
106 \enum QMailMessageBodyFwd::EncodingStatus |
|
107 |
|
108 This enum type is used to describe the encoding status of body data. |
|
109 |
|
110 \value AlreadyEncoded The body data is already encoded to the necessary encoding. |
|
111 \value RequiresEncoding The body data is unencoded, and thus requires encoding for transmission. |
|
112 */ |
|
113 |
|
114 /*! |
|
115 \enum QMailMessageBodyFwd::EncodingFormat |
|
116 |
|
117 This enum type is used to describe the format in which body data should be presented. |
|
118 |
|
119 \value Encoded The body data should be presented in encoded form. |
|
120 \value Decoded The body data should be presented in unencoded form. |
|
121 */ |
|
122 |
|
123 /*! |
|
124 \class QMailMessagePartContainerFwd |
|
125 \preliminary |
|
126 \brief The QMailMessagePartContainerFwd class declares enumerations used by QMailMessagePartContainer |
|
127 |
|
128 QMailMessagePartContainerFwd allows QMailMessagePartContainerFwd::MultipartType |
|
129 to be used without including all of \c qmailmessage.h. |
|
130 */ |
|
131 |
|
132 /*! |
|
133 \enum QMailMessagePartContainerFwd::MultipartType |
|
134 |
|
135 This enumerated type is used to describe the multipart encoding of a message or message part. |
|
136 |
|
137 \value MultipartNone The container does not hold parts. |
|
138 \value MultipartSigned The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc1847.txt}{RFC 1847} "multipart/signed" |
|
139 \value MultipartEncrypted The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc1847.txt}{RFC 1847} "multipart/encrypted" |
|
140 \value MultipartMixed The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2046.txt}{RFC 2046} "multipart/mixed" |
|
141 \value MultipartAlternative The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2046.txt}{RFC 2046} "multipart/alternative" |
|
142 \value MultipartDigest The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2046.txt}{RFC 2046} "multipart/digest" |
|
143 \value MultipartParallel The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2046.txt}{RFC 2046} "multipart/parallel" |
|
144 \value MultipartRelated The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2387.txt}{RFC 2387} "multipart/related" |
|
145 \value MultipartFormData The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc2388.txt}{RFC 2388} "multipart/form-data" |
|
146 \value MultipartReport The container holds parts encoded according to \l {http://www.ietf.org/rfc/rfc3462.txt}{RFC 3462} "multipart/report" |
|
147 */ |
|
148 |
|
149 /*! |
|
150 \class QMailMessagePartFwd |
|
151 \preliminary |
|
152 \brief The QMailMessagePartFwd class declares enumerations used by QMailMessagePart |
|
153 |
|
154 QMailMessagePartFwd allows QMailMessagePartFwd::ReferenceType |
|
155 to be used without including all of \c qmailmessage.h. |
|
156 */ |
|
157 |
|
158 /*! |
|
159 \enum QMailMessagePartFwd::ReferenceType |
|
160 |
|
161 This enumerated type is used to describe the type of reference that a part constitutes. |
|
162 |
|
163 \value None The part is not a reference. |
|
164 \value MessageReference The part is a reference to a message. |
|
165 \value PartReference The part is a reference to another part. |
|
166 */ |
|
167 |
|
168 /*! |
|
169 \class QMailMessageMetaDataFwd |
|
170 \preliminary |
|
171 \brief The QMailMessageMetaDataFwd class declares enumerations used by QMailMessageMetaData |
|
172 |
|
173 QMailMessageMetaDataFwd allows QMailMessageMetaData::MessageType, QMailMessageMetaData::ContentType and QMailMessageMetaData::ResponseType |
|
174 to be used without including all of \c qmailmessage.h. |
|
175 */ |
|
176 |
|
177 /*! |
|
178 \enum QMailMessageMetaDataFwd::MessageType |
|
179 |
|
180 This enum type is used to describe the type of a message. |
|
181 |
|
182 \value Mms The message is an MMS. |
|
183 \value Sms The message is an SMS. |
|
184 \value Email The message is an Email. |
|
185 \value Instant The message is an instant message. |
|
186 \value System The message is a system report. |
|
187 \value None Indicates no message type. |
|
188 \value AnyType Indicates any type of message. |
|
189 */ |
|
190 |
|
191 /*! |
|
192 \enum QMailMessageMetaDataFwd::ContentType |
|
193 |
|
194 This enum type is used to describe the type of data contained within a message. |
|
195 |
|
196 \value UnknownContent The content of the message has not been specified. |
|
197 \value NoContent The message does not contain content and is completely described by its meta data. |
|
198 \value PlainTextContent Plain text content. |
|
199 \value RichTextContent Text content described via QTextBrowser rich text markup. |
|
200 \value HtmlContent Content marked up via HyperText Markup Language. |
|
201 \value ImageContent Image content. |
|
202 \value AudioContent Audio content. |
|
203 \value VideoContent Video content. |
|
204 \value MultipartContent Content consisting of multiple individual parts related according to RFC 2046. |
|
205 \value SmilContent Dynamic content described via Synchronized Multimedia Integration Language. |
|
206 \value VoicemailContent Content that should be presented as a recorded audio message from a contact. |
|
207 \value VideomailContent Content that should be presented as a recorded video message from a contact. |
|
208 \value VCardContent A contact description, as defined by RFC 2425. |
|
209 \value VCalendarContent A scheduling element description as defined by the vCalendar 1.0 specification. |
|
210 \value ICalendarContent A scheduling element description as defined by RFC 2445. |
|
211 \value DeliveryReportContent A message delivery report. |
|
212 \value UserContent The first value that can be used for application-specific purposes. |
|
213 */ |
|
214 |
|
215 /*! |
|
216 \enum QMailMessageMetaDataFwd::ResponseType |
|
217 |
|
218 This enum type is used to describe the type of response that a message is created as. |
|
219 |
|
220 \value NoResponse The message was not created as a response to another message. |
|
221 \value Reply The message was created as a reply to the sender of another message. |
|
222 \value ReplyToAll The message was created in reply to all recipients another message. |
|
223 \value Forward The message was created to forward the content of another message. |
|
224 \value ForwardPart The message was created to forward part of the content of another message. |
|
225 \value Redirect The message was created to redirect another message to a different address. |
|
226 */ |
|
227 |
|
228 /*! |
|
229 \class QMailMessageFwd |
|
230 \preliminary |
|
231 \brief The QMailMessageFwd class declares enumerations used by QMailMessage |
|
232 |
|
233 QMailMessageFwd allows QMailMessage::AttachmentsAction and QMailMessage::EncodingFormat |
|
234 to be used without including all of \c qmailmessage.h. |
|
235 */ |
|
236 |
|
237 /*! |
|
238 \enum QMailMessageFwd::AttachmentsAction |
|
239 |
|
240 This enum type is used to describe the action that should be performed on |
|
241 each message attachment. |
|
242 |
|
243 \value LinkToAttachments Add a part to the message containing a link to the |
|
244 supplied attachment. If the document is removed, the |
|
245 message will no longer have access to the data. |
|
246 \value CopyAttachments Add a part to the message containing a copy of the |
|
247 data in the supplied attachment. If the document is |
|
248 removed, the message will still contain the data. |
|
249 \value CopyAndDeleteAttachments Add a part to the message containing a copy of the |
|
250 data in the supplied attachment, then delete the |
|
251 document from which the data was copied. |
|
252 */ |
|
253 |
|
254 /*! |
|
255 \enum QMailMessageFwd::EncodingFormat |
|
256 |
|
257 This enum type is used to describe the format in which a message should be serialized. |
|
258 |
|
259 \value HeaderOnlyFormat Only the header portion of the message is serialized, to RFC 2822 form. |
|
260 \value StorageFormat The message is serialized to RFC 2822 form, without attachments. |
|
261 \value TransmissionFormat The entire message is serialized to RFC 2822 form, with additional header fields added if necessary, and 'bcc' header field omitted. |
|
262 \value IdentityFormat The entire message is serialized to RFC 2822 form, with only Content-Type and Content-Transfer-Encoding headers added where required. |
|
263 */ |
|
264 |
|
265 /*! |
|
266 \enum QMailMessageFwd::ChunkType |
|
267 |
|
268 This enum type is used to denote the content of a single chunk in a partitioned output sequence. |
|
269 |
|
270 \value Text The chunk contains verbatim output text. |
|
271 \value Reference The chunk contains a reference to an external datum. |
|
272 */ |
|
273 |
|
274 /*! |
|
275 \typedef QMailMessageFwd::MessageChunk |
|
276 |
|
277 This type defines a single chunk in a sequence of partitioned ouput data. |
|
278 */ |
|
279 |