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

KIMAP Library

  • KIMAP
  • AppendJob
Public Member Functions | Protected Member Functions
KIMAP::AppendJob Class Reference

#include <appendjob.h>

Inherits KIMAP::Job.

List of all members.

Public Member Functions

 AppendJob (Session *session)
QByteArray content () const
QList< QByteArray > flags () const
QString mailBox () const
void setContent (const QByteArray &content)
void setFlags (const QList< QByteArray > &flags)
void setMailBox (const QString &mailBox)
qint64 uid () const

Protected Member Functions

virtual void doStart ()
virtual void handleResponse (const Message &response)

Detailed Description

Appends a message to a mailbox.

This job can only be run when the session is in the authenticated (or selected) state.

If the server supports ACLs, the user will need the Acl::Insert right on the mailbox.

Definition at line 42 of file appendjob.h.


Member Function Documentation

QByteArray AppendJob::content ( ) const

The content that the message will have.

Definition at line 85 of file appendjob.cpp.

QList< QByteArray > AppendJob::flags ( ) const

The flags that will be set on the appended message.

Definition at line 73 of file appendjob.cpp.

QString AppendJob::mailBox ( ) const

The mailbox that the message will be appended to.

Definition at line 61 of file appendjob.cpp.

void AppendJob::setContent ( const QByteArray &  content)

The content of the message.

This should be in RFC-2822 format, although some required header lines may be omitted in certain cases, for example when appending to a Drafts folder.

Parameters:
contentusually an RFC-2822 message

Definition at line 79 of file appendjob.cpp.

void AppendJob::setFlags ( const QList< QByteArray > &  flags)

Set the flags that should be applied to the appended message.

Parameters:
flagsa list of flags

Definition at line 67 of file appendjob.cpp.

void AppendJob::setMailBox ( const QString &  mailBox)

Set the mailbox to append the message to.

If the mailbox does not exist, it will not automatically be created and the command will fail.

Parameters:
mailBoxthe (unquoted) name of the mailbox

Definition at line 55 of file appendjob.cpp.

qint64 AppendJob::uid ( ) const

The UID of the new message.

This will be zero if it is unknown.

The UID will not be known until the job has been successfully executed, and it will only be known at all if the server supports the UIDPLUS extension (RFC 4315).

Definition at line 91 of file appendjob.cpp.


The documentation for this class was generated from the following files:
  • appendjob.h
  • appendjob.cpp

KIMAP Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • 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.6.1
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