MailCommon Namespace Reference

Namespaces
	Util

Classes
class	AccountConfigOrderDialog
class	AddTagDialog
class	BackupJob
class	CollectionAnnotationsAttribute
class	CollectionExpiryPage
class	CollectionGeneralPage
class	CollectionTypeUtil
class	ContentTypeWidget
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	FilterActionWithUrlHelpButton
class	FilterController
class	FilterConvertToSieve
class	FilterConvertToSieveResultDialog
class	FilterEditDialog
class	FilterImporterAbstract
class	FilterImporterBalsa
class	FilterImporterClawsMails
class	FilterImporterEvolution
class	FilterImporterExporter
class	FilterImporterGmail
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	IncidencesForWidget
class	InvalidFilterDialog
class	InvalidFilterInfo
class	InvalidFilterInfoWidget
class	InvalidFilterListItemDelegate
class	InvalidFilterListModel
class	InvalidFilterListView
class	InvalidFilterWidget
class	ISettings
class	ItemContext
class	JobScheduler
class	Kernel
class	KMFilterAccountList
class	KMFilterDialog
class	KMFilterListBox
class	MailFilter
class	MDNAdviceDialog
class	MDNAdviceHelper
class	MessageRuleWidgetHandler
struct	MessageStatusInfo
class	NewMailNotifierAttribute
class	NumericDoubleRuleWidgetHandler
class	NumericRuleWidgetHandler
class	QListWidgetFilterItem
class	RedirectDialog
class	RedirectWidget
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	SelectThunderbirdFilterFilesDialog
class	SendMdnHandler
class	SnippetDialog
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
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

The filter dialog.

This class represents a search pattern rule operating on a string.

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

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

This is a non-modal dialog used to manage the filters. It should only be called through KMFilterMgr::openDialog. The dialog consists of three main parts:

• The KMFilterListBox in the left half allows the user to select a filter to be displayed using the widgets on the right half. It also has buttons to delete filters, add new ones, to rename them and to change their order (maybe you will be able to move the filters around by dragging later, and to optimize the filters by trying to apply them to all locally available KMMessage in turn and thus profiling which filters (and which rules of the search patterns) matches most often and sorting the filter/rules list according to the results, but I first want the basic functionality in place).

• The SearchPatternEdit in the upper-right quarter allows the user to modify the filter criteria.

• The KMFilterActionEdit in the lower-right quarter allows the user to select the actions that will be executed for any message that matches the search pattern.

• (tbi) There will be another widget that will allow the user to select to which folders the filter may be applied and whether it should be applied on outbound or inbound message transfers or both or none (meaning the filter is only applied when the user explicitly hits CTRL-J). I'm not sure whether there should be a per-folder filter list or a single list where you can select the names of folders this rule will be applied to.

Upon creating the dialog, a (deep) copy of the current filter list is made by KMFilterListBox. The changed filters are local to KMFilterListBox until the user clicks the 'Apply' button.

NOTE: Though this dialog is non-modal, it completely ignores all the stuff that goes on behind the scenes with folders esp. folder creation, move and create. The widgets that depend on the filter list and the filters that use folders as parameters are not updated as you expect. I hope this will change sometime soon.

KMFilterDialog supports the creation of new filters through context menus, dubbed "rapid filters". Call KMFilterMgr::createFilter to use this. That call will be delivered to this dialog, which in turn delivers it to the KMFilterListBox.

If you change the (DocBook) anchor for the filter dialog help, make sure to change const QString KMFilterDialogHelpAnchor in kmfilterdlg.cpp accordingly.

The filter dialog.

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 KMFilterActionEdit SearchPatternEdit KMFilterListBox

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.

This class represents a search to be performed against a string. The string can be either a message header, or a pseudo header, such as <body>

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 54 of file searchrulestatus.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 637 of file mailfilter.cpp.

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

Definition at line 668 of file mailfilter.cpp.

Variable Documentation

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 49 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 )

Definition at line 71 of file searchrulestatus.h.

const int MailCommon::StatusValueCountWithoutHidden = StatusValueCount - 1

static

Definition at line 76 of file searchrulestatus.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"     } 
}

Definition at line 35 of file searchrulestatus.h.