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

mailcommon

Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
MailCommon Namespace Reference

Namespaces

 Util
 

Classes

class  AccountList
 
class  AddTagDialog
 
class  AttachmentSelectionDialog
 
class  BackupJob
 
class  CheckedCollectionWidget
 
class  CollectionAnnotationsAttribute
 
class  CollectionExpiryPage
 
class  CollectionGeneralPage
 
class  DateRuleWidgetHandler
 
class  EntityCollectionOrderProxyModel
 
class  ExpireCollectionAttribute
 
class  ExpireJob
 
class  FavoriteCollectionWidget
 
class  FilterAction
 
class  FilterActionAddHeader
 
class  FilterActionAddTag
 
class  FilterActionAddToAddressBook
 
class  FilterActionBeep
 
class  FilterActionCopy
 
class  FilterActionDelete
 
struct  FilterActionDesc
 
class  FilterActionDict
 
class  FilterActionExec
 
class  FilterActionForward
 
class  FilterActionMove
 
class  FilterActionPipeThrough
 
class  FilterActionPlaySound
 
class  FilterActionRedirect
 
class  FilterActionRemoveHeader
 
class  FilterActionReplyTo
 
class  FilterActionRewriteHeader
 
class  FilterActionSendFakeDisposition
 
class  FilterActionSendReceipt
 
class  FilterActionSetIdentity
 
class  FilterActionSetStatus
 
class  FilterActionSetTransport
 
class  FilterActionStatus
 
class  FilterActionUnsetStatus
 
class  FilterActionWidget
 
class  FilterActionWidgetLister
 
class  FilterActionWithAddress
 
class  FilterActionWithCommand
 
class  FilterActionWithFolder
 
class  FilterActionWithNone
 
class  FilterActionWithString
 
class  FilterActionWithStringList
 
class  FilterActionWithTest
 
class  FilterActionWithUOID
 
class  FilterActionWithUrl
 
class  FilterController
 
class  FilterConvertToSieve
 
class  FilterConvertToSieveResultDialog
 
class  FilterEditDialog
 
class  FilterImporterAbstract
 
class  FilterImporterBalsa
 
class  FilterImporterClawsMails
 
class  FilterImporterEvolution
 
class  FilterImporterExporter
 
class  FilterImporterProcmail
 
class  FilterImporterSylpheed
 
class  FilterImporterThunderbird
 
class  FilterLog
 
class  FilterManager
 
class  FilterModel
 
class  FilterSelectionDialog
 
class  FolderCollection
 
class  FolderCollectionMonitor
 
class  FolderJob
 
class  FolderRequester
 
class  FolderSelectionDialog
 
class  FolderTreeView
 
class  FolderTreeWidget
 
class  FolderTreeWidgetProxyModel
 
class  HeadersRuleWidgetHandler
 
class  IFilter
 
class  IKernel
 
class  ISettings
 
class  ItemContext
 
class  JobScheduler
 
class  Kernel
 
class  KMFilterDialog
 
class  KMFilterListBox
 
class  MailCommonSettings
 
class  MailFilter
 
class  MDNAdviceDialog
 
class  MDNAdviceHelper
 
class  MessageRuleWidgetHandler
 
struct  MessageStatusInfo
 
class  NewMailNotifierAttribute
 
class  NumericDoubleRuleWidgetHandler
 
class  NumericRuleWidgetHandler
 
class  QListWidgetFilterItem
 
class  RedirectDialog
 
class  RegExpLineEdit
 
class  RuleWidgetHandler
 
class  RuleWidgetHandlerManager
 
class  ScheduledExpireTask
 
class  ScheduledJob
 
class  ScheduledTask
 
class  SearchPattern
 
class  SearchPatternEdit
 
class  SearchRule
 
class  SearchRuleDate
 
class  SearchRuleNumerical
 
class  SearchRuleStatus
 
class  SearchRuleString
 
class  SearchRuleWidget
 
class  SearchRuleWidgetLister
 
class  SelectMultiCollectionDialog
 
class  SelectMultiCollectionWidget
 
class  SelectThunderbirdFilterFilesDialog
 
class  SendMdnHandler
 
class  SnippetsManager
 
class  SnippetsModel
 
class  SnippetVariableDialog
 
class  SoundTestWidget
 
class  StatusRuleWidgetHandler
 
class  Tag
 
class  TagRuleWidgetHandler
 
class  TagWidget
 
class  TextRuleWidgetHandler
 

Typedefs

typedef FilterAction *(* FilterActionNewFunc )(void)
 

Enumerations

enum  StatusValueTypes {
  StatusImportant = 0, StatusToAct = 1, StatusUnread = 2, StatusRead = 3,
  StatusDeleted = 4, StatusReplied = 5, StatusForwarded = 6, StatusQueued = 7,
  StatusSent = 8, StatusWatched = 9, StatusIgnored = 10, StatusSpam = 11,
  StatusHam = 12, StatusHasAttachment = 13
}
 

Functions

static QModelIndex lastChildOf (QAbstractItemModel *model, const QModelIndex &current)
 
MAILCOMMON_EXPORT QDataStream & operator<< (QDataStream &stream, const MailFilter &filter)
 
MAILCOMMON_EXPORT QDataStream & operator>> (QDataStream &stream, MailFilter &filter)
 

Variables

const char * _wt_filterdlg_showLater
 
const char * _wt_filterlist
 
const char * _wt_filterlist_bottom
 
const char * _wt_filterlist_copy
 
const char * _wt_filterlist_delete
 
const char * _wt_filterlist_down
 
const char * _wt_filterlist_new
 
const char * _wt_filterlist_rename
 
const char * _wt_filterlist_top
 
const char * _wt_filterlist_up
 
static QMap< Collection::Id,
QSharedPointer
< FolderCollection > > 
fcMap
 
const int FILTER_MAX_ACTIONS = 8
 
const int FILTER_MAX_RULES = 8
 
static QMutex mapMutex
 
static const char * myConfigGroupName = "FolderSelectionDialog"
 
static const int StatusValueCount
 
static const int StatusValueCountWithoutHidden = StatusValueCount - 1
 
static const MessageStatusInfo StatusValues []
 

Detailed Description

This is a complex widget that is used to manipulate a mail program's filter list.

Copyright (c) 2004 David Faure faure.nosp@m.@kde.nosp@m..org

It consists of an internal list of filters, which is a deep copy of the list KMFilterMgr manages, a QListBox displaying that list, and a few buttons used to create new filters, delete them, rename them and change the order of filters.

It does not provide means to change the actual filter (besides the name), but relies on auxiliary widgets (SearchPatternEdit and KMFilterActionEdit) to do that.

Communication with this widget is quite easy: simply create an instance, connect the signals filterSelected, resetWidgets and applyWidgets with a slot that does the right thing and there you go...

This widget will operate on it's own copy of the filter list as long as you don't call slotApplyFilterChanges. It will then transfer the altered filter list back to KMFilterMgr.

A complex widget that allows managing a list of MailCommon::MailFilter's.

Author
Marc Mutz mutz@.nosp@m.kde..nosp@m.org, based upon work by Stefan Taferner tafer.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg.
See also
MailCommon::MailFilter KMFilterDialog KMFilterActionEdit SearchPatternEdit

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

In addition, as a special exception, the copyright holders give permission to link the code of this program with any edition of the Qt library by Trolltech AS, Norway (or with modified versions of Qt that use the same license as Qt), and distribute linked combinations including the two. You must obey the GNU General Public License in all respects for all of the code used other than Qt. If you modify this file, you may extend this exception to your version of the file, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Typedef Documentation

typedef FilterAction*(* MailCommon::FilterActionNewFunc)(void)

Definition at line 31 of file filteractiondict.h.

Enumeration Type Documentation

enum MailCommon::StatusValueTypes
Enumerator
StatusImportant 
StatusToAct 
StatusUnread 
StatusRead 
StatusDeleted 
StatusReplied 
StatusForwarded 
StatusQueued 
StatusSent 
StatusWatched 
StatusIgnored 
StatusSpam 
StatusHam 
StatusHasAttachment 

Definition at line 512 of file searchpattern.h.

Function Documentation

static QModelIndex MailCommon::lastChildOf ( QAbstractItemModel *  model,
const QModelIndex &  current 
)
static

Definition at line 440 of file foldertreeview.cpp.

QDataStream & MailCommon::operator<< ( QDataStream &  stream,
const MailFilter &  filter 
)

Definition at line 631 of file mailfilter.cpp.

QDataStream & MailCommon::operator>> ( QDataStream &  stream,
MailCommon::MailFilter &  filter 
)

Definition at line 662 of file mailfilter.cpp.

Variable Documentation

const char* MailCommon::_wt_filterdlg_showLater
Initial value:
=
I18N_NOOP( "<qt><p>Check this button to force the confirmation dialog to be "
"displayed.</p><p>This is useful if you have defined a ruleset that tags "
"messages to be downloaded later. Without the possibility to force "
"the dialog popup, these messages could never be downloaded if no "
"other large messages were waiting on the server, or if you wanted to "
"change the ruleset to tag the messages differently.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 283 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist
Initial value:
=
I18N_NOOP( "<qt><p>This is the list of defined filters. "
"They are processed top-to-bottom.</p>"
"<p>Click on any filter to edit it "
"using the controls in the right-hand half "
"of the dialog.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 215 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_bottom
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to move the currently-"
"selected filter to bottom of list.</p>"
"<p>This is useful since the order of the filters in the list "
"determines the order in which they are tried on messages: "
"The topmost filter gets tried first.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 268 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_copy
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to copy a filter.</p>"
"<p>If you have clicked this button accidentally, you can undo this "
"by clicking on the <em>Delete</em> button.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 230 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_delete
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to <em>delete</em> the currently-"
"selected filter from the list above.</p>"
"<p>There is no way to get the filter back once "
"it is deleted, but you can always leave the "
"dialog by clicking <em>Cancel</em> to discard the "
"changes made.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 235 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_down
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to move the currently-"
"selected filter <em>down</em> one in the list above.</p>"
"<p>This is useful since the order of the filters in the list "
"determines the order in which they are tried on messages: "
"The topmost filter gets tried first.</p>"
"<p>If you have clicked this button accidentally, you can undo this "
"by clicking on the <em>Up</em> button.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 252 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_new
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to create a new filter.</p>"
"<p>The filter will be inserted just before the currently-"
"selected one, but you can always change that "
"later on.</p>"
"<p>If you have clicked this button accidentally, you can undo this "
"by clicking on the <em>Delete</em> button.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 222 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_rename
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to rename the currently-selected filter.</p>"
"<p>Filters are named automatically, as long as they start with "
"\"&lt;\".</p>"
"<p>If you have renamed a filter accidentally and want automatic "
"naming back, click this button and select <em>Clear</em> followed "
"by <em>OK</em> in the appearing dialog.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 275 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_top
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to move the currently-"
"selected filter to top of list.</p>"
"<p>This is useful since the order of the filters in the list "
"determines the order in which they are tried on messages: "
"The topmost filter gets tried first.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 261 of file kmfilterdialog.cpp.

const char* MailCommon::_wt_filterlist_up
Initial value:
=
I18N_NOOP( "<qt><p>Click this button to move the currently-"
"selected filter <em>up</em> one in the list above.</p>"
"<p>This is useful since the order of the filters in the list "
"determines the order in which they are tried on messages: "
"The topmost filter gets tried first.</p>"
"<p>If you have clicked this button accidentally, you can undo this "
"by clicking on the <em>Down</em> button.</p></qt>" )
I18N_NOOP
#define I18N_NOOP(t)
Definition: searchpatternedit.cpp:46

Definition at line 243 of file kmfilterdialog.cpp.

QMap<Collection::Id,QSharedPointer<FolderCollection> > MailCommon::fcMap
static

Definition at line 44 of file foldercollection.cpp.

const int MailCommon::FILTER_MAX_ACTIONS = 8

Definition at line 40 of file mailfilter.h.

const int MailCommon::FILTER_MAX_RULES = 8

Definition at line 54 of file searchpattern.h.

QMutex MailCommon::mapMutex
static

Definition at line 43 of file foldercollection.cpp.

const char* MailCommon::myConfigGroupName = "FolderSelectionDialog"
static

Definition at line 267 of file folderselectiondialog.cpp.

const int MailCommon::StatusValueCount
static
Initial value:
=
sizeof( StatusValues ) / sizeof( MessageStatusInfo )
MailCommon::StatusValues
static const MessageStatusInfo StatusValues[]
Definition: searchpattern.h:493

Definition at line 529 of file searchpattern.h.

const int MailCommon::StatusValueCountWithoutHidden = StatusValueCount - 1
static

Definition at line 534 of file searchpattern.h.

const MessageStatusInfo MailCommon::StatusValues[]
static
Initial value:
=
{
{ I18N_NOOP2( "message status", "Important" ), "emblem-important" },
{ I18N_NOOP2( "message status", "Action Item" ), "mail-task" },
{ I18N_NOOP2( "message status", "Unread" ), "mail-unread" },
{ I18N_NOOP2( "message status", "Read" ), "mail-read" },
{ I18N_NOOP2( "message status", "Deleted" ), "mail-deleted" },
{ I18N_NOOP2( "message status", "Replied" ), "mail-replied" },
{ I18N_NOOP2( "message status", "Forwarded" ), "mail-forwarded" },
{ I18N_NOOP2( "message status", "Queued" ), "mail-queued" },
{ I18N_NOOP2( "message status", "Sent" ), "mail-sent" },
{ I18N_NOOP2( "message status", "Watched" ), "mail-thread-watch" },
{ I18N_NOOP2( "message status", "Ignored" ), "mail-thread-ignored" },
{ I18N_NOOP2( "message status", "Spam" ), "mail-mark-junk" },
{ I18N_NOOP2( "message status", "Ham" ), "mail-mark-notjunk" },
{ I18N_NOOP2( "message status", "Has Attachment"), "mail-attachment" }
}
I18N_NOOP2
#define I18N_NOOP2(c, t)
Definition: searchpatternedit.cpp:48

Definition at line 493 of file searchpattern.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:15 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

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