• 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
  • folder
foldercollectionmonitor.cpp
Go to the documentation of this file.
1 /*
2  Copyright (c) 2009, 2010, 2011 Montel Laurent <montel@kde.org>
3 
4  This program is free software; you can redistribute it and/or modify it
5  under the terms of the GNU General Public License, version 2, as
6  published by the Free Software Foundation.
7 
8  This program is distributed in the hope that it will be useful, but
9  WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  General Public License for more details.
12 
13  You should have received a copy of the GNU General Public License along
14  with this program; if not, write to the Free Software Foundation, Inc.,
15  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16 */
17 
18 #include "foldercollectionmonitor.h"
19 #include "util/mailutil.h"
20 #include "foldercollection.h"
21 #include "collectionpage/attributes/expirecollectionattribute.h"
22 
23 #include <Akonadi/ChangeRecorder>
24 #include <Akonadi/Collection>
25 #include <Akonadi/CollectionFetchScope>
26 #include <Akonadi/CollectionModel>
27 #include <Akonadi/EntityTreeModel>
28 #include <Akonadi/Item>
29 #include <Akonadi/ItemDeleteJob>
30 #include <Akonadi/ItemFetchJob>
31 #include <Akonadi/ItemFetchScope>
32 #include <Akonadi/KMime/MessageParts>
33 #include <akonadi/entityannotationsattribute.h>
34 
35 #include <KMime/KMimeMessage>
36 
37 namespace MailCommon {
38 
39 FolderCollectionMonitor::FolderCollectionMonitor( Akonadi::Session *session, QObject *parent )
40  : QObject( parent )
41 {
42  // monitor collection changes
43  mMonitor = new Akonadi::ChangeRecorder( this );
44  mMonitor->setSession(session);
45  mMonitor->setCollectionMonitored( Akonadi::Collection::root() );
46  mMonitor->fetchCollectionStatistics( true );
47  mMonitor->collectionFetchScope().setIncludeStatistics( true );
48  mMonitor->fetchCollection( true );
49  mMonitor->setAllMonitored( true );
50  mMonitor->setMimeTypeMonitored( KMime::Message::mimeType() );
51 #ifdef MERGE_KNODE_IN_KMAIL
52  mMonitor->setMimeTypeMonitored( QString::fromLatin1("message/news") );
53 #endif
54  mMonitor->setResourceMonitored( "akonadi_search_resource", true );
55  mMonitor->itemFetchScope().fetchPayloadPart( Akonadi::MessagePart::Envelope );
56  mMonitor->itemFetchScope().setFetchModificationTime( false );
57  mMonitor->itemFetchScope().setFetchRemoteIdentification( false );
58  mMonitor->itemFetchScope().setFetchTags( true );
59  mMonitor->itemFetchScope().fetchAttribute<Akonadi::EntityAnnotationsAttribute>( true );
60 }
61 
62 FolderCollectionMonitor::~FolderCollectionMonitor()
63 {
64 }
65 
66 Akonadi::ChangeRecorder *FolderCollectionMonitor::monitor() const
67 {
68  return mMonitor;
69 }
70 
71 void FolderCollectionMonitor::expireAllFolders( bool immediate,
72  QAbstractItemModel *collectionModel )
73 {
74  if ( collectionModel ) {
75  expireAllCollection( collectionModel, immediate );
76  }
77 }
78 
79 void FolderCollectionMonitor::expireAllCollection( const QAbstractItemModel *model,
80  bool immediate,
81  const QModelIndex &parentIndex )
82 {
83  const int rowCount = model->rowCount( parentIndex );
84  for ( int row = 0; row < rowCount; ++row ) {
85  const QModelIndex index = model->index( row, 0, parentIndex );
86  const Akonadi::Collection collection =
87  model->data(
88  index, Akonadi::CollectionModel::CollectionRole ).value<Akonadi::Collection>();
89 
90  if ( !collection.isValid() || Util::isVirtualCollection( collection ) ) {
91  continue;
92  }
93 
94  bool mustDeleteExpirationAttribute = false;
95  MailCommon::ExpireCollectionAttribute *attr =
96  MailCommon::Util::expirationCollectionAttribute(
97  collection, mustDeleteExpirationAttribute );
98 
99  if ( attr->isAutoExpire() ) {
100  MailCommon::Util::expireOldMessages( collection, immediate );
101  }
102 
103  if ( model->rowCount( index ) > 0 ) {
104  expireAllCollection( model, immediate, index );
105  }
106 
107  if ( mustDeleteExpirationAttribute ) {
108  delete attr;
109  }
110  }
111 }
112 
113 void FolderCollectionMonitor::expunge( const Akonadi::Collection & col, bool sync )
114 {
115  if ( col.isValid() ) {
116  Akonadi::ItemDeleteJob *job = new Akonadi::ItemDeleteJob( col, this );
117  connect( job, SIGNAL(result(KJob*)), this, SLOT(slotDeleteJob(KJob*)) );
118  if ( sync ) {
119  job->exec();
120  }
121  } else {
122  kDebug() << " Try to expunge an invalid collection :" << col;
123  }
124 }
125 
126 void FolderCollectionMonitor::slotDeleteJob( KJob *job )
127 {
128  Util::showJobErrorMessage( job );
129 }
130 
131 }
132 
expirecollectionattribute.h
QModelIndex
QAbstractItemModel::rowCount
virtual int rowCount(const QModelIndex &parent) const =0
foldercollection.h
MailCommon::FolderCollectionMonitor::expireAllFolders
void expireAllFolders(bool immediate, QAbstractItemModel *collectionModel)
Definition: foldercollectionmonitor.cpp:71
QAbstractItemModel::index
virtual QModelIndex index(int row, int column, const QModelIndex &parent) const =0
MailCommon::Util::expirationCollectionAttribute
MAILCOMMON_EXPORT MailCommon::ExpireCollectionAttribute * expirationCollectionAttribute(const Akonadi::Collection &collection, bool &mustDeleteExpirationAttribute)
Definition: mailutil.cpp:458
QVariant::value
T value() const
MailCommon::ExpireCollectionAttribute
Definition: expirecollectionattribute.h:29
MailCommon::Util::isVirtualCollection
MAILCOMMON_EXPORT bool isVirtualCollection(const Akonadi::Collection &col)
Definition: mailutil.cpp:97
QObject
MailCommon::ExpireCollectionAttribute::isAutoExpire
bool isAutoExpire() const
Returns true if this folder automatically expires old messages.
Definition: expirecollectionattribute.cpp:62
foldercollectionmonitor.h
QAbstractItemModel::data
virtual QVariant data(const QModelIndex &index, int role) const =0
MailCommon::FolderCollectionMonitor::expireAllCollection
void expireAllCollection(const QAbstractItemModel *model, bool immediate, const QModelIndex &parentIndex=QModelIndex())
Definition: foldercollectionmonitor.cpp:79
MailCommon::FolderCollectionMonitor::expunge
void expunge(const Akonadi::Collection &, bool sync=false)
Definition: foldercollectionmonitor.cpp:113
MailCommon::FolderCollectionMonitor::FolderCollectionMonitor
FolderCollectionMonitor(Akonadi::Session *session, QObject *parent=0)
Definition: foldercollectionmonitor.cpp:39
MailCommon::FolderCollectionMonitor::monitor
Akonadi::ChangeRecorder * monitor() const
Definition: foldercollectionmonitor.cpp:66
MailCommon::Util::showJobErrorMessage
MAILCOMMON_EXPORT bool showJobErrorMessage(KJob *job)
Definition: mailutil.cpp:134
MailCommon::FolderCollectionMonitor::~FolderCollectionMonitor
~FolderCollectionMonitor()
Definition: foldercollectionmonitor.cpp:62
QAbstractItemModel
QString::fromLatin1
QString fromLatin1(const char *str, int size)
MailCommon::Util::expireOldMessages
MAILCOMMON_EXPORT void expireOldMessages(const Akonadi::Collection &collection, bool immediate)
Definition: mailutil.cpp:397
QObject::connect
bool connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
mailutil.h
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