• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • FetchJob
  • FetchScope
Public Types | Public Attributes | List of all members
KIMAP::FetchJob::FetchScope Struct Reference

#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

enum KIMAP::FetchJob::FetchScope::Mode

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::Content

Use case:

  1. Start a FetchJob with the FetchScope::Structure mode to retrieve the structure of the message.
  2. Parse the structure to identify the parts that are interesting (ie: probably everything but attachments).
  3. Start another FetchJob with FetchScope::HeaderAndContent to fetch those parts.
  4. 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

Mode KIMAP::FetchJob::FetchScope::mode

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:
  • fetchjob.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:25:18 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal