Camel.VeeStore¶

Subclasses:	None

Methods¶

Inherited:	Camel.Store (47), Camel.Service (33), Camel.Object (4), GObject.Object (37), Gio.Initable (2)
Structs:	GObject.ObjectClass (5)

class	`new` ()
	`get_unmatched_enabled` ()
	`get_unmatched_folder` ()
	`get_vee_data_cache` ()
	`note_subfolder_unused` (subfolder, unused_by)
	`note_subfolder_used` (subfolder, used_by)
	`note_vuid_unused` (mi_data, unused_by)
	`note_vuid_used` (mi_data, used_by)
	`rebuild_unmatched_folder` (cancellable)
	`set_unmatched_enabled` (is_enabled)

Virtual Methods¶

Inherited:	Camel.Store (17), Camel.Service (5), Camel.Object (2), GObject.Object (7), Gio.Initable (1)

Properties¶

Inherited:	Camel.Service (8), Camel.Object (1)

Name	Type	Flags	Short Description
`unmatched-enabled`	`bool`	r/w/en	Enable _Unmatched folder

Signals¶

Inherited:	Camel.Store (5), GObject.Object (1)

Fields¶

Inherited:	Camel.Store (5), GObject.Object (1)

Name	Type	Access	Description
parent	`Camel.Store`	r

Class Details¶

class Camel.VeeStore(**kwargs)¶

Bases:	`Camel.Store`
Abstract:	No
Structure:	`Camel.VeeStoreClass`

classmethod new()¶

Returns:	new `Camel.VeeStore` object
Return type:	`Camel.VeeStore`

Create a new Camel.VeeStore object.

get_unmatched_enabled()¶

Returns:	whether Unmatched folder processing is enabled
Return type:	`bool`

New in version 3.6.

get_unmatched_folder()¶

Returns:	the Unmatched folder instance, or `None`, when it’s disabled.
Return type:	`object` or `None`

New in version 3.6.

get_vee_data_cache()¶

Returns:	the associated `Camel.VeeDataCache`
Return type:	`Camel.VeeFolder`

New in version 3.6.

note_subfolder_unused(subfolder, unused_by)¶

Parameters:	subfolder (`Camel.Folder`) – a `Camel.Folder` unused_by (`Camel.VeeFolder`) – a `Camel.VeeFolder`

This is a counter Camel.part of Camel.VeeStore.note_subfolder_used(). Once the subfolder is claimed to be not used by all folders its message infos are removed from the Unmatched folder.

New in version 3.6.

note_subfolder_used(subfolder, used_by)¶

Parameters:	subfolder (`Camel.Folder`) – a `Camel.Folder` used_by (`Camel.VeeFolder`) – a `Camel.VeeFolder`

Notes that the subfolder is used by used_by folder, which is used to determine what folders will be included in the Unmatched folders.

New in version 3.6.

note_vuid_unused(mi_data, unused_by)¶

Parameters:	mi_data (`Camel.VeeMessageInfoData`) – a `Camel.VeeMessageInfoData` unused_by (`Camel.VeeFolder`) – a `Camel.VeeFolder`

A counter Camel.part of Camel.VeeStore.note_vuid_used(). Once the unused_by claims the mi_data is not used by it anymore, and neither any other virtual folder is using it, then the Unmatched folder will have it added.

New in version 3.6.

note_vuid_used(mi_data, used_by)¶

Parameters:	mi_data (`Camel.VeeMessageInfoData`) – a `Camel.VeeMessageInfoData` used_by (`Camel.VeeFolder`) – a `Camel.VeeFolder`

Notes the mi_data is used by the used_by virtual folder, which removes it from the Unmatched folder, if not used anywhere else.

New in version 3.6.

rebuild_unmatched_folder(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`

Let’s the self know to rebuild the Unmatched folder. This is done as a separate job, when the cancellable is None, otherwise it’s run synchronously.

New in version 3.6.

set_unmatched_enabled(is_enabled)¶

Parameters:	is_enabled (`bool`) – value to set

Sets whether the Unmatched folder processing is enabled.

New in version 3.6.

Property Details¶

Camel.VeeStore.props.unmatched_enabled¶

Name:	`unmatched-enabled`
Type:	`bool`
Default Value:	`True`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

Enable _Unmatched folder