• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

mailcommon

  • sources
  • kde-4.14
  • kdepim
  • mailcommon
  • filter
  • filteractions
filteractionsetstatus.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  */
19 
20 #include "filteractionsetstatus.h"
21 
22 #include <KDE/Akonadi/KMime/MessageStatus>
23 #include <KDE/KLocale>
24 using namespace MailCommon;
25 
26 FilterAction* FilterActionSetStatus::newAction()
27 {
28  return new FilterActionSetStatus;
29 }
30 
31 FilterActionSetStatus::FilterActionSetStatus( QObject *parent )
32  : FilterActionStatus( QLatin1String("set status"), i18n( "Mark As" ), parent )
33 {
34 }
35 
36 bool FilterActionSetStatus::isEmpty() const
37 {
38  const int index = mParameterList.indexOf( mParameter );
39  return ( index < 1 );
40 }
41 
42 QString FilterActionSetStatus::informationAboutNotValidAction() const
43 {
44  //KF5 add i18n
45  return QLatin1String("Status not specified.");
46 }
47 
48 FilterAction::ReturnCode FilterActionSetStatus::process(ItemContext &context , bool) const
49 {
50  const int index = mParameterList.indexOf( mParameter );
51  if ( index < 1 )
52  return ErrorButGoOn;
53 
54  Akonadi::MessageStatus status;
55  status.setStatusFromFlags( context.item().flags() );
56 
57  Akonadi::MessageStatus oldStatus = status;
58  const Akonadi::MessageStatus newStatus = FilterActionStatus::stati[ index - 1 ];
59  if ( newStatus == Akonadi::MessageStatus::statusUnread() ) {
60  status.setRead( false );
61  }
62  else
63  status.set( newStatus );
64  if ( oldStatus != status ) {
65  context.item().setFlags( status.statusFlags() );
66  context.setNeedsFlagStore();
67  }
68 
69  return GoOn;
70 }
71 
72 SearchRule::RequiredPart FilterActionSetStatus::requiredPart() const
73 {
74  return SearchRule::Envelope;
75 }
76 
77 QString FilterActionSetStatus::sieveCode() const
78 {
79  QString flagCode;
80  const QString parameter = argsAsString();
81  if (parameter == QLatin1String("R")) {
82  flagCode = QLatin1String("\\\\Seen");
83  } else if (parameter == QLatin1String("D")) {
84  flagCode = QLatin1String("\\\\Deleted");
85  } else if (parameter == QLatin1String("A")) {
86  flagCode = QLatin1String("\\\\Answered");
87  } else {
88  qDebug()<<" FilterActionSetStatus::sieveCode() unknown flags"<<parameter;
89  flagCode = parameter;
90  }
91 
92  const QString result = QString::fromLatin1("setflag \"%1\";").arg(flagCode);
93  return result;
94 }
95 
96 QStringList FilterActionSetStatus::sieveRequires() const
97 {
98  return QStringList() << QLatin1String("imap4flags");
99 }
100 
101 
MailCommon::FilterActionStatus::argsAsString
QString argsAsString() const
Return extra arguments as string.
Definition: filteractionstatus.cpp:98
MailCommon::FilterAction::GoOn
Go on with applying filter actions.
Definition: filteraction.h:62
MailCommon::FilterActionStatus
Definition: filteractionstatus.h:26
MailCommon::FilterActionSetStatus::FilterActionSetStatus
FilterActionSetStatus(QObject *parent=0)
Definition: filteractionsetstatus.cpp:31
MailCommon::FilterActionSetStatus::requiredPart
SearchRule::RequiredPart requiredPart() const
Returns the required part from the item that is needed for the action to operate. ...
Definition: filteractionsetstatus.cpp:72
MailCommon::FilterActionSetStatus::isEmpty
bool isEmpty() const
Determines whether this action is valid.
Definition: filteractionsetstatus.cpp:36
MailCommon::FilterActionSetStatus::sieveCode
QString sieveCode() const
Definition: filteractionsetstatus.cpp:77
MailCommon::FilterAction
Abstract base class for mail filter actions.
Definition: filteraction.h:52
MailCommon::FilterActionSetStatus::sieveRequires
QStringList sieveRequires() const
Definition: filteractionsetstatus.cpp:96
MailCommon::FilterActionWithStringList::mParameterList
QStringList mParameterList
Definition: filteractionwithstringlist.h:85
MailCommon::FilterAction::ErrorButGoOn
A non-critical error occurred.
Definition: filteraction.h:63
QObject
MailCommon::FilterActionSetStatus::informationAboutNotValidAction
QString informationAboutNotValidAction() const
Definition: filteractionsetstatus.cpp:42
MailCommon::FilterActionStatus::stati
static Akonadi::MessageStatus stati[]
Definition: filteractionstatus.h:39
MailCommon::SearchRule::RequiredPart
RequiredPart
Definition: searchrule.h:79
QString
QStringList
MailCommon::SearchRule::Envelope
Definition: searchrule.h:80
MailCommon::FilterActionWithString::mParameter
QString mParameter
Definition: filteractionwithstring.h:91
filteractionsetstatus.h
MailCommon::FilterAction::ReturnCode
ReturnCode
Describes the possible return codes of filter processing:
Definition: filteraction.h:60
QLatin1String
MailCommon::ItemContext::item
Akonadi::Item & item()
Returns the item of the context.
Definition: itemcontext.cpp:29
context
const char * context
Definition: searchpatternedit.cpp:54
QString::fromLatin1
QString fromLatin1(const char *str, int size)
QStringList::indexOf
int indexOf(const QRegExp &rx, int from) const
MailCommon::ItemContext::setNeedsFlagStore
void setNeedsFlagStore()
Marks that the item's flags has been changed and needs to be written back.
Definition: itemcontext.cpp:54
MailCommon::ItemContext
A helper class for the filtering process.
Definition: itemcontext.h:39
MailCommon::FilterActionSetStatus::process
ReturnCode process(ItemContext &context, bool applyOnOutbound) const
Execute action on given message (inside the item context).
Definition: filteractionsetstatus.cpp:48
QString::arg
QString arg(qlonglong a, int fieldWidth, int base, const QChar &fillChar) const
MailCommon::FilterActionSetStatus::newAction
static FilterAction * newAction()
Definition: filteractionsetstatus.cpp:26
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:31:40 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailcommon

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

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer
  • pimprint

Search



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