KIMAP Library
#include <fetchjob.h>
Public Types | |
enum | Mode { Headers, Flags, Structure, Content, Full, HeaderAndContent } |
Public Attributes | |
Mode | mode |
QList< QByteArray > | parts |
Detailed Description
Used to indicate what message data should be fetched.
This doesn't provide the same fine-grained control over what is fetched that the IMAP FETCH command normally does, but the common cases are catered for.
Definition at line 71 of file fetchjob.h.
Member Enumeration Documentation
Used to indicate what part of the message should be fetched.
- Enumerator:
Headers Fetch RFC-2822 or MIME message headers.
To fetch MIME headers for a MIME part, populate the
parts
field.If the RFC-2822 headers are requested (so
parts
is empty), the returned information is:- To, From, Message-id, References In-Reply-To, Subject and Date headers
- The message size (in octets)
- The internal date of the message
- The message flags
- The message UID
Flags Fetch the message flags (the UID is also fetched)
Structure Fetch the MIME message body structure (the UID is also fetched)
Content Fetch the message content (the UID is also fetched)
To fetch only certain MIME parts (see Structure), populate the
parts
field.Full Fetch the complete message.
HeaderAndContent Fetch the message MIME headers and the content of parts specified in the
parts
field.If
parts
is empty, this mode will return the full message, just like FetchScope::ContentUse case:
- Start a FetchJob with the FetchScope::Structure mode to retrieve the structure of the message.
- Parse the structure to identify the parts that are interesting (ie: probably everything but attachments).
- Start another FetchJob with FetchScope::HeaderAndContent to fetch those parts.
- At the request of the user, you can repeat the step above to fetch the attachments.
- Since:
- 4.7
Definition at line 76 of file fetchjob.h.
Member Data Documentation
Specify what message data should be fetched.
Definition at line 150 of file fetchjob.h.
QList<QByteArray> KIMAP::FetchJob::FetchScope::parts |
Specify which message parts to operate on.
This refers to multipart-MIME message parts or MIME-IMB encapsulated message parts.
Note that this is ignored unless mode
is Headers or Content.
If mode
is Headers, this sets the parts to get the MIME headers for. If this list is empty, the headers for the whole message (the RFC-2822 headers) are fetched.
If mode
is Content, this sets the parts to fetch. Parts are fetched wholesale. If this list is empty, the whole message body is fetched (all MIME parts together).
Definition at line 146 of file fetchjob.h.
The documentation for this struct was generated from the following file:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:17:14 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.