KIMAP::AppendJob

#include <appendjob.h>

Inherits KIMAP::Job.

Public Member Functions

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

Protected Member Functions

void doStart () override
 
void handleResponse (const Response &response) override
 

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 44 of file appendjob.h.

Member Function Documentation

QByteArray AppendJob::content ( ) const

The content that the message will have.

Definition at line 99 of file appendjob.cpp.

QList< QByteArray > AppendJob::flags ( ) const

The flags that will be set on the appended message.

Definition at line 75 of file appendjob.cpp.

QDateTime AppendJob::internalDate ( ) const

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

Since
4.13

Definition at line 87 of file appendjob.cpp.

QString AppendJob::mailBox ( ) const

The mailbox that the message will be appended to.

Definition at line 63 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 93 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 69 of file appendjob.cpp.

void AppendJob::setInternalDate ( const QDateTime 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 https://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 81 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 57 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 105 of file appendjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Jun 5 2020 23:04:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.