• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • FetchJob
  • FetchScope
Public Types | Public Attributes
KIMAP::FetchJob::FetchScope Struct Reference

Used to indicate what message data should be fetched. More...

#include <fetchjob.h>

List of all members.

Public Types

enum  Mode {
  Headers, Flags, Structure, Content,
  Full
}

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.

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 132 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 128 of file fetchjob.h.


The documentation for this struct was generated from the following file:
  • fetchjob.h

KIMAP Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal