MailCommon::ExpireCollectionAttribute Class

class MailCommon::ExpireCollectionAttribute

The ExpireCollectionAttribute class. More...

Header: #include <MailCommon/ExpireCollectionAttribute>
CMake: find_package(KPim6MailCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MailCommon)

Public Functions

MailCommon::ExpireCollectionAttribute::ExpireAction expireAction() const
bool expireMessagesWithValidDate() const
Akonadi::Collection::Id expireToFolderId() const
bool isAutoExpire() const
int readExpireAge() const
MailCommon::ExpireCollectionAttribute::ExpireUnits readExpireUnits() const
void setAutoExpire(bool enabled)
void setExpireMessagesWithValidDate(bool expireMessagesWithValidDate)
void setExpireToFolderId(Akonadi::Collection::Id id)
void setReadExpireAge(int age)
void setReadExpireUnits(MailCommon::ExpireCollectionAttribute::ExpireUnits units)
void setUnreadExpireAge(int age)
void setUnreadExpireUnits(MailCommon::ExpireCollectionAttribute::ExpireUnits units)
int unreadExpireAge() const
MailCommon::ExpireCollectionAttribute::ExpireUnits unreadExpireUnits() const

Detailed Description

Member Function Documentation

MailCommon::ExpireCollectionAttribute::ExpireAction ExpireCollectionAttribute::expireAction() const

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

bool ExpireCollectionAttribute::expireMessagesWithValidDate() const

expireMessagesWithValidDate Returns

See also setExpireMessagesWithValidDate().

Akonadi::Collection::Id ExpireCollectionAttribute::expireToFolderId() const

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

See also setExpireToFolderId().

bool ExpireCollectionAttribute::isAutoExpire() const

Returns true if this folder automatically expires old messages.

int ExpireCollectionAttribute::readExpireAge() const

Returns the age at which read messages are expired. Units are determined by readExpireUnits().

See also setReadExpireAge().

MailCommon::ExpireCollectionAttribute::ExpireUnits ExpireCollectionAttribute::readExpireUnits() const

Units getReadExpireAge() is returned in. 1 = days, 2 = weeks, 3 = months.

See also setReadExpireUnits().

void ExpireCollectionAttribute::setAutoExpire(bool enabled)

Sets whether this folder automatically expires messages, according to enabled.

See also isAutoExpire().

void ExpireCollectionAttribute::setExpireMessagesWithValidDate(bool expireMessagesWithValidDate)

setExpireMessagesWithValidDate expireMessagesWithValidDate

See also expireMessagesWithValidDate().

void ExpireCollectionAttribute::setExpireToFolderId(Akonadi::Collection::Id id)

setExpireToFolderId id

See also expireToFolderId().

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().

See also readExpireAge().

void ExpireCollectionAttribute::setReadExpireUnits(MailCommon::ExpireCollectionAttribute::ExpireUnits units)

Sets the units to use for expiry of read messages. Values are 1 = days, 2 = weeks, 3 = months.

See also readExpireUnits().

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().

See also unreadExpireAge().

void ExpireCollectionAttribute::setUnreadExpireUnits(MailCommon::ExpireCollectionAttribute::ExpireUnits units)

Sets the units to use for expiry of unread messages. Values are 1 = days, 2 = weeks, 3 = months.

See also unreadExpireUnits().

int ExpireCollectionAttribute::unreadExpireAge() const

Returns the age at which unread messages are expired. Units are determined by unreadExpireUnits().

See also setUnreadExpireAge().

MailCommon::ExpireCollectionAttribute::ExpireUnits ExpireCollectionAttribute::unreadExpireUnits() const

Units getUnreadExpireAge() is returned in. 1 = days, 2 = weeks, 3 = months.

See also setUnreadExpireUnits().