#include <filteractionrewriteheader.h>

Inheritance diagram for MailCommon::FilterActionRewriteHeader:

Public Member Functions
	FilterActionRewriteHeader (QObject *parent=0)

void	applyParamWidgetValue (QWidget *paramWidget)

QString	argsAsString () const

void	argsFromString (const QString &argsStr)

void	clearParamWidget (QWidget *paramWidget) const

QWidget *	createParamWidget (QWidget *parent) const

QString	displayString () const

ReturnCode	process (ItemContext &context, bool applyOnOutbound) const

SearchRule::RequiredPart	requiredPart () const

void	setParamWidgetValue (QWidget *paramWidget) const

Public Member Functions inherited from MailCommon::FilterActionWithStringList
	FilterActionWithStringList (const QString &name, const QString &label, QObject *parent=0)

Public Member Functions inherited from MailCommon::FilterActionWithString
	FilterActionWithString (const QString &name, const QString &label, QObject *parent=0)

virtual bool	isEmpty () const

Public Member Functions inherited from MailCommon::FilterAction
	FilterAction (const QString &name, const QString &label, QObject *parent=0)

virtual	~FilterAction ()

virtual QString	argsAsStringReal () const

virtual bool	argsFromStringInteractive (const QString &argsStr, const QString &filterName)

virtual bool	folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)

QString	label () const

QString	name () const

virtual QString	sieveCode () const

virtual QStringList	sieveRequires () const

Static Public Member Functions
static FilterAction *	newAction ()

Static Public Member Functions inherited from MailCommon::FilterAction
static FilterAction *	newAction ()

static void	sendMDN (const Akonadi::Item &item, KMime::MDN::DispositionType d, const QList< KMime::MDN::DispositionModifier > &m=QList< KMime::MDN::DispositionModifier >())

Additional Inherited Members
Public Types inherited from MailCommon::FilterAction
enum	ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 }

Signals inherited from MailCommon::FilterAction
void	filterActionModified ()

Protected Attributes inherited from MailCommon::FilterActionWithStringList
QStringList	mParameterList

Protected Attributes inherited from MailCommon::FilterActionWithString
QString	mParameter

Detailed Description

Definition at line 33 of file filteractionrewriteheader.h.

Constructor & Destructor Documentation

FilterActionRewriteHeader::FilterActionRewriteHeader ( QObject * parent = 0 )

explicit

Definition at line 39 of file filteractionrewriteheader.cpp.

Member Function Documentation

void FilterActionRewriteHeader::applyParamWidgetValue ( QWidget * paramWidget )

virtual

The filter action shall set it's parameter from the widget's contents.

It is allowed that the value is read by the action before this function is called.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 166 of file filteractionrewriteheader.cpp.

QString FilterActionRewriteHeader::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 196 of file filteractionrewriteheader.cpp.

void FilterActionRewriteHeader::argsFromString ( const QString & argsStr )

virtual

Read extra arguments from given string.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 212 of file filteractionrewriteheader.cpp.

void FilterActionRewriteHeader::clearParamWidget ( QWidget * paramWidget ) const

virtual

The filter action shall clear it's parameter widget's contents.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 181 of file filteractionrewriteheader.cpp.

QWidget * FilterActionRewriteHeader::createParamWidget ( QWidget * parent ) const

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 92 of file filteractionrewriteheader.cpp.

QString FilterActionRewriteHeader::displayString ( ) const

virtual

Returns a translated string describing this filter for visualization purposes, e.g.

in the filter log.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 207 of file filteractionrewriteheader.cpp.

FilterAction * FilterActionRewriteHeader::newAction ( )

static

Definition at line 34 of file filteractionrewriteheader.cpp.

FilterAction::ReturnCode FilterActionRewriteHeader::process	(	ItemContext &	context,
		bool	applyOnOutbound
	)		const

virtual

Execute action on given message (inside the item context).

Returns CriticalError if a critical error has occurred (eg. disk full), ErrorButGoOn if there was a non-critical error (e.g. invalid address in 'forward' action), ErrorNeedComplete if a complete message is required, GoOn if the message shall be processed by further filters and Ok otherwise.

Implements MailCommon::FilterAction.

Definition at line 53 of file filteractionrewriteheader.cpp.

SearchRule::RequiredPart FilterActionRewriteHeader::requiredPart ( ) const

virtual

Returns the required part from the item that is needed for the action to operate.

See SearchRule::RequiredPart

Implements MailCommon::FilterAction.

Definition at line 86 of file filteractionrewriteheader.cpp.

void FilterActionRewriteHeader::setParamWidgetValue ( QWidget * paramWidget ) const

virtual

The filter action shall set it's widget's contents from it's parameter.

Reimplemented from MailCommon::FilterActionWithStringList.