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

KIMAP Library

  • KIMAP
  • AppendJob
Public Member Functions | Protected Member Functions | List of all members
KIMAP::AppendJob Class Reference

#include <appendjob.h>

Inherits KIMAP::Job.

Public Member Functions

 AppendJob (Session *session)
 
QByteArray content () const
 
QList< QByteArray > flags () const
 
KDateTime internalDate () const
 
QString mailBox () const
 
void setContent (const QByteArray &content)
 
void setFlags (const QList< QByteArray > &flags)
 
void setInternalDate (const KDateTime &internalDate)
 
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 43 of file appendjob.h.

Constructor & Destructor Documentation

◆ AppendJob()

AppendJob::AppendJob ( Session *  session)

Definition at line 47 of file appendjob.cpp.

◆ ~AppendJob()

AppendJob::~AppendJob ( )
virtual

Definition at line 52 of file appendjob.cpp.

Member Function Documentation

◆ content()

QByteArray AppendJob::content ( ) const

The content that the message will have.

Definition at line 98 of file appendjob.cpp.

◆ doStart()

void AppendJob::doStart ( )
protectedvirtual

Definition at line 110 of file appendjob.cpp.

◆ flags()

QList< QByteArray > AppendJob::flags ( ) const

The flags that will be set on the appended message.

Definition at line 74 of file appendjob.cpp.

◆ handleResponse()

void AppendJob::handleResponse ( const Message &  response)
protectedvirtual

Definition at line 134 of file appendjob.cpp.

◆ internalDate()

KDateTime AppendJob::internalDate ( ) const

The internal date that will be set on the appended message.

Since
4.13

Definition at line 86 of file appendjob.cpp.

◆ mailBox()

QString AppendJob::mailBox ( ) const

The mailbox that the message will be appended to.

Definition at line 62 of file appendjob.cpp.

◆ setContent()

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 92 of file appendjob.cpp.

◆ setFlags()

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 68 of file appendjob.cpp.

◆ setInternalDate()

void AppendJob::setInternalDate ( const KDateTime &  internalDate)

Set the internal date that should be applied to the appended message.

This is the date/time the IMAP server should set internally for the appended message. See http://tools.ietf.org/html/rfc3501#section-6.3.11

If this is not set, the server will use the current date/time.

Parameters
internalDatethe internal date
Since
4.13

Definition at line 80 of file appendjob.cpp.

◆ setMailBox()

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 56 of file appendjob.cpp.

◆ uid()

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 104 of file appendjob.cpp.


The documentation for this class was generated from the following files:
  • appendjob.h
  • appendjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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