KIMAP::StoreJob Class
Store Job. More...
| Header: | #include <KIMAP/StoreJob> |
| CMake: | find_package(KPim6IMAP REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::IMAP) |
| Inherits: | KIMAP::Job |
Public Types
| enum | StoreMode { SetFlags, AppendFlags, RemoveFlags } |
Public Functions
| StoreJob(KIMAP::Session *session) | |
| virtual | ~StoreJob() override |
| KIMAP::MessageFlags | flags() const |
| KIMAP::MessageFlags | gmLabels() const |
| bool | isUidBased() const |
| quint64 | lastModSeq() const |
| KIMAP::StoreJob::StoreMode | mode() const |
| QMap<qint64, KIMAP::MessageFlags> | resultingFlags() const |
| QMap<qint64, qint64> | resultingModSeqs() const |
| KIMAP::ImapSet | sequenceSet() const |
| void | setFlags(const KIMAP::MessageFlags &flags) |
| void | setGMLabels(const KIMAP::MessageFlags &gmLabels) |
| void | setLastModSeq(quint64 lastModSeq) |
| void | setMode(KIMAP::StoreJob::StoreMode mode) |
| void | setSequenceSet(const KIMAP::ImapSet &set) |
| void | setUidBased(bool uidBased) |
| KIMAP::ImapSet | unchangedMessages() const |
Reimplemented Protected Functions
| virtual void | doStart() override |
| virtual void | handleResponse(const KIMAP::Response &response) override |
Related Non-Members
Detailed Description
If flags contains \Recent, it won't be pushed to the server. This is to protect clients from mistake making them violate the RFC which mandates that clients shouldn't fiddle with this flag.
Member Type Documentation
enum StoreJob::StoreMode
| Constant | Value |
|---|---|
KIMAP::StoreJob::SetFlags | 0 |
KIMAP::StoreJob::AppendFlags | 1 |
KIMAP::StoreJob::RemoveFlags | 2 |
Member Function Documentation
[explicit] StoreJob::StoreJob(KIMAP::Session *session)
[override virtual noexcept] StoreJob::~StoreJob()
[override virtual protected] void StoreJob::doStart()
KIMAP::MessageFlags StoreJob::flags() const
See also setFlags().
KIMAP::MessageFlags StoreJob::gmLabels() const
[override virtual protected] void StoreJob::handleResponse(const KIMAP::Response &response)
bool StoreJob::isUidBased() const
quint64 StoreJob::lastModSeq() const
Get CONDSTORE mod-seq parameter for UNCHANGEDSINCE modifier If this equals 0 (default value), the modifier won't be added to the command
This can be set only when server has CONDSTORE capability (RFC4551), otherwise the STORE command will fail.
See also setLastModSeq().
KIMAP::StoreJob::StoreMode StoreJob::mode() const
See also setMode().
QMap<qint64, KIMAP::MessageFlags> StoreJob::resultingFlags() const
QMap<qint64, qint64> StoreJob::resultingModSeqs() const
The list of updated MODSEQ for the modified messages
Only use when CONDSTORE is enabled (when lastModSeq is set)
KIMAP::ImapSet StoreJob::sequenceSet() const
See also setSequenceSet().
void StoreJob::setFlags(const KIMAP::MessageFlags &flags)
See also flags().
void StoreJob::setGMLabels(const KIMAP::MessageFlags &gmLabels)
void StoreJob::setLastModSeq(quint64 lastModSeq)
Set CONDSTORE mod-seq parameter for UNCHANGEDSINCE modifier If set to 0 (default value), the modifier won't be added to the command
This can be set only when server has CONDSTORE capability (RFC4551), otherwise the STORE command will fail.
lastModseq Last modification sequence number known to the client
See also lastModSeq().
void StoreJob::setMode(KIMAP::StoreJob::StoreMode mode)
See also mode().
void StoreJob::setSequenceSet(const KIMAP::ImapSet &set)
See also sequenceSet().
void StoreJob::setUidBased(bool uidBased)
See also isUidBased().
KIMAP::ImapSet StoreJob::unchangedMessages() const
The list of messages that have not been modified by the StoreJob Because their MODSEQ on the server is superior to the lastModSeq value set for this job
Only use when CONDSTORE is enabled (when lastModSeq is set)