Camel.StoreSettings

g Camel.Settings Camel.Settings Camel.StoreSettings Camel.StoreSettings Camel.Settings->Camel.StoreSettings GObject.Object GObject.Object GObject.Object->Camel.Settings

Subclasses:Camel.LocalSettings, Camel.OfflineSettings

Virtual Methods

Inherited:Camel.Settings (2), GObject.Object (7)

Properties

Name Type Flags Short Description
filter-inbox bool r/w/c/en Whether to filter new messages in Inbox
store-changes-interval int r/w/c/en Interval, in seconds, to store folder changes

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent Camel.Settings r  

Class Details

class Camel.StoreSettings(**kwargs)
Bases:Camel.Settings
Abstract:No
Structure:Camel.StoreSettingsClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.2.

get_filter_inbox()
Returns:whether to filter new messages in Inbox
Return type:bool

Returns whether to automatically apply filters to newly arrived messages in the store’s Inbox folder (assuming it has an Inbox folder).

New in version 3.2.

get_store_changes_interval()
Returns:the interval for automatic store of folder changes
Return type:int

Returns the interval, in seconds, for the changes in the folder being saved automatically. 0 means immediately, while -1 means turning off automatic folder change saving.

New in version 3.38.2.

set_filter_inbox(filter_inbox)
Parameters:filter_inbox (bool) – whether to filter new messages in Inbox

Sets whether to automatically apply filters to newly arrived messages in the store’s Inbox folder (assuming it has an Inbox folder).

New in version 3.2.

set_store_changes_interval(interval)
Parameters:interval (int) – the interval, in seconds

Sets the interval, in seconds, for the changes in the folder being saved automatically. 0 means immediately, while -1 means turning off automatic folder change saving.

New in version 3.38.2.

Property Details

Camel.StoreSettings.props.filter_inbox
Name:filter-inbox
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to filter new messages in Inbox

Camel.StoreSettings.props.store_changes_interval
Name:store-changes-interval
Type:int
Default Value:3
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Interval, in seconds, to store folder changes