MailCommon::ExpireCollectionAttribute Class Reference

#include <expirecollectionattribute.h>

Inherits Attribute.

Public Types
enum	ExpireAction { ExpireDelete, ExpireMove }
enum	ExpireUnits {   ExpireNever, ExpireDays, ExpireWeeks, ExpireMonths,   ExpireMaxUnits }

Public Member Functions
	ExpireCollectionAttribute ()
ExpireCollectionAttribute *	clone () const
void	daysToExpire (int &unreadDays, int &readDays)
void	deserialize (const QByteArray &data)
ExpireAction	expireAction () const
Akonadi::Collection::Id	expireToFolderId () const
bool	isAutoExpire () const
bool	operator== (const ExpireCollectionAttribute &other) const
int	readExpireAge () const
ExpireUnits	readExpireUnits () const
QByteArray	serialized () const
void	setAutoExpire (bool enabled)
void	setExpireAction (ExpireAction a)
void	setExpireToFolderId (Akonadi::Collection::Id id)
void	setReadExpireAge (int age)
void	setReadExpireUnits (ExpireUnits units)
void	setUnreadExpireAge (int age)
void	setUnreadExpireUnits (ExpireUnits units)
QByteArray	type () const
int	unreadExpireAge () const
ExpireUnits	unreadExpireUnits () const

Detailed Description

Definition at line 29 of file expirecollectionattribute.h.

Member Enumeration Documentation

enum MailCommon::ExpireCollectionAttribute::ExpireAction

Enumerator
ExpireDelete
ExpireMove

Definition at line 47 of file expirecollectionattribute.h.

enum MailCommon::ExpireCollectionAttribute::ExpireUnits

Enumerator
ExpireNever
ExpireDays
ExpireWeeks
ExpireMonths
ExpireMaxUnits

Definition at line 39 of file expirecollectionattribute.h.

Constructor & Destructor Documentation

ExpireCollectionAttribute::ExpireCollectionAttribute

(

)

Definition at line 27 of file expirecollectionattribute.cpp.

Member Function Documentation

ExpireCollectionAttribute * ExpireCollectionAttribute::clone

(

)

const

Definition at line 44 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::daysToExpire	(	int &	unreadDays,
		int &	readDays
	)

Definition at line 163 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::deserialize

(

const QByteArray &

data

)

Definition at line 185 of file expirecollectionattribute.cpp.

ExpireCollectionAttribute::ExpireAction ExpireCollectionAttribute::expireAction

(

)

const

What should expiry do? Delete or move to another folder?

Definition at line 110 of file expirecollectionattribute.cpp.

Akonadi::Collection::Id ExpireCollectionAttribute::expireToFolderId

(

)

const

If expiry should move to folder, return the ID of that folder.

Definition at line 120 of file expirecollectionattribute.cpp.

bool ExpireCollectionAttribute::isAutoExpire

(

)

const

Returns true if this folder automatically expires old messages.

Definition at line 62 of file expirecollectionattribute.cpp.

bool ExpireCollectionAttribute::operator==

(

const ExpireCollectionAttribute &

other

)

const

Definition at line 135 of file expirecollectionattribute.cpp.

int ExpireCollectionAttribute::readExpireAge

(

)

const

Returns the age at which read messages are expired.

Units are determined by readExpireUnits().

Definition at line 93 of file expirecollectionattribute.cpp.

ExpireCollectionAttribute::ExpireUnits ExpireCollectionAttribute::readExpireUnits

(

)

const

Units getReadExpireAge() is returned in.

1 = days, 2 = weeks, 3 = months.

Definition at line 130 of file expirecollectionattribute.cpp.

QByteArray ExpireCollectionAttribute::serialized

(

)

const

Definition at line 169 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setAutoExpire

(

bool

enabled

)

Sets whether this folder automatically expires messages.

Definition at line 57 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setExpireAction

(

ExpireAction

a

)

Definition at line 105 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setExpireToFolderId

(

Akonadi::Collection::Id

id

)

Definition at line 115 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setReadExpireAge

(

int

age

)

Sets the maximum age for read messages in this folder.

Age should not be negative. Units are set using setReadExpireUnits().

Definition at line 86 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setReadExpireUnits

(

ExpireUnits

units

)

Sets the units to use for expiry of read messages.

Values are 1 = days, 2 = weeks, 3 = months.

Definition at line 98 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setUnreadExpireAge

(

int

age

)

Sets the maximum age for unread messages in this folder.

Age should not be negative. Units are set using setUnreadExpireUnits().

Definition at line 67 of file expirecollectionattribute.cpp.

void ExpireCollectionAttribute::setUnreadExpireUnits

(

ExpireUnits

units

)

Sets the units to use for expiry of unread messages.

Values are 1 = days, 2 = weeks, 3 = months.

Definition at line 79 of file expirecollectionattribute.cpp.

QByteArray ExpireCollectionAttribute::type

(

)

const

Definition at line 38 of file expirecollectionattribute.cpp.

int ExpireCollectionAttribute::unreadExpireAge

(

)

const

Returns the age at which unread messages are expired.

Units are determined by unreadExpireUnits().

Definition at line 74 of file expirecollectionattribute.cpp.

ExpireCollectionAttribute::ExpireUnits ExpireCollectionAttribute::unreadExpireUnits

(

)

const

Units getUnreadExpireAge() is returned in.

1 = days, 2 = weeks, 3 = months.

Definition at line 125 of file expirecollectionattribute.cpp.

---

The documentation for this class was generated from the following files:

• expirecollectionattribute.h
• expirecollectionattribute.cpp