Camel.LocalSettings

Subclasses:None

Methods

Inherited:Camel.StoreSettings (4), Camel.Settings (2), GObject.Object (37) Structs:GObject.ObjectClass (5)

	dup_path ()
	get_filter_all ()
	get_filter_junk ()
	get_path ()
	set_filter_all (filter_all)
	set_filter_junk (filter_junk)
	set_path (path)

Virtual Methods

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

Properties

Inherited:Camel.StoreSettings (2)

Name	Type	Flags	Short Description
filter-all	bool	r/w/c/en	Whether to apply filters in all folders
filter-junk	bool	r/w/c/en	Whether to check new messages for junk
path	str	r/w/c/en	File path to the local store

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)

Name	Type	Access	Description
parent	Camel.StoreSettings	r

Class Details

class Camel.LocalSettings(**kwargs)

Bases:Camel.StoreSettings Abstract:No Structure:Camel.LocalSettingsClass

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

New in version 3.4.

dup_path()

Returns:a newly-allocated copy of Camel.LocalSettings :path Return type:str

Thread-safe variation of Camel.LocalSettings.get_path(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.4.

get_filter_all()

Returns:whether to apply filters in all folders Return type:bool

Returns whether apply filters in all folders.

New in version 3.24.

get_filter_junk()

Returns:whether to check new messages for junk Return type:bool

Returns whether to check new messages for junk.

New in version 3.24.

get_path()

Returns:the file path to the local store Return type:str

Returns the file path to the root of the local mail store.

New in version 3.4.

set_filter_all(filter_all)

Parameters:filter_all (bool) – whether to apply filters in all folders

Sets whether to apply filters in all folders.

New in version 3.24.

set_filter_junk(filter_junk)

Parameters:filter_junk (bool) – whether to check new messages for junk

Sets whether to check new messages for junk.

New in version 3.24.

set_path(path)

Parameters:path (str) – the file path to the local store

Sets the file path to the root of the local mail store. Any trailing directory separator characters will be stripped off of the Camel.LocalSettings :path property.

New in version 3.4.

Property Details

Camel.LocalSettings.props.filter_all

Name:filter-all Type:bool Default Value:False Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to apply filters in all folders

Camel.LocalSettings.props.filter_junk

Name:filter-junk Type:bool Default Value:True Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether to check new messages for junk

Camel.LocalSettings.props.path

Name:path Type:str Default Value:None Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

File path to the local store