Camel.VeeFolder

Subclasses:

Camel.VTrashFolder

Methods

Inherited:

Camel.Folder (85), Camel.Object (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (parent_store, full, flags)
	add_folder (subfolder, cancellable)
	add_vuid (mi_data, changes)
	construct (flags)
	get_auto_update ()
	get_expression ()
	get_flags ()
	get_location (vinfo)
	get_vee_uid_folder (vee_message_uid)
	ignore_next_changed_event (subfolder)
	propagate_skipped_changes ()
	rebuild_folder (subfolder, cancellable)
	ref_folders ()
	remove_folder (subfolder, cancellable)
	remove_from_ignore_changed_event (subfolder)
	remove_vuid (mi_data, changes)
	set_auto_update (auto_update)
	set_expression (expression)
	set_folders (folders, cancellable)

Virtual Methods

Inherited:

Camel.Folder (42), Camel.Object (2), GObject.Object (7)

	do_add_folder (subfolder, cancellable)
	do_folder_changed (subfolder, changes)
	do_rebuild_folder (subfolder, cancellable)
	do_remove_folder (subfolder, cancellable)
	do_set_expression (expression)

Properties

Inherited:

Camel.Folder (6), Camel.Object (1)

Name	Type	Flags	Short Description
auto-update	bool	r/w/en	Automatically _update on change in source folders

Signals

Inherited:

Camel.Folder (3), GObject.Object (1)

Fields

Inherited:

Camel.Folder (3), GObject.Object (1)

Name	Type	Access	Description
parent	Camel.Folder	r

Class Details

class Camel.VeeFolder(**kwargs)

Bases:

Camel.Folder

Abstract:

No

Structure:

Camel.VeeFolderClass

classmethod new(parent_store, full, flags)

Parameters:

• parent_store (Camel.Store) – the parent Camel.VeeStore

• full (str) – the full path to the vfolder.

• flags (int) – flags of some kind

Returns:

A new CamelVeeFolder object. Unref it with GObject.Object.unref() when no longer needed.

Return type:

Camel.Folder

add_folder(subfolder, cancellable)

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to add to self

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Adds subfolder as a source folder to self.

add_vuid(mi_data, changes)

Parameters:

• mi_data (object or None) – a Camel.VeeMessageInfoData to add

• changes (Camel.FolderChangeInfo or None) – an optional Camel.FolderChangeInfo to update with the made change, or None

Adds the mi_data to the self. The changes can be updated with the made change and later used to notify others with Camel.Folder.changed() on the self. This can be used only for the Unmatched folder.

New in version 3.6.

construct(flags)

Parameters:

flags (int) – flags for the self

Initializes internal structures of the self. This is meant to be called by the descendants of Camel.VeeFolder.

get_auto_update()

Returns:

whether the self can automatically update when any of its subfolders changes.

Return type:

bool

New in version 3.6.

get_expression()

Returns:

a SExp expression used for this self

Return type:

str

New in version 3.6.

get_flags()

Returns:

flags of self, as set by Camel.VeeFolder.construct()

Return type:

int

New in version 3.24.

get_location(vinfo)

Parameters:

vinfo (Camel.VeeMessageInfo) – a Camel.VeeMessageInfo to search for

Returns:

a real (not virtual) Camel.Folder, which the vinfo is for.

realuid:

if not None, set to the UID of the real message info

Return type:

(Camel.Folder, realuid: str or None)

Find the real folder (and message info UID) for the given vinfo. When the realuid is not None and it’s set, then use GLib.free() to free it, when no longer needed.

get_vee_uid_folder(vee_message_uid)

Parameters:

vee_message_uid (str) – a virtual message info UID

Returns:

a Camel.Folder to which the vee_message_uid belongs, or None, when it could not be found.

Return type:

Camel.Folder or None

New in version 3.6.

ignore_next_changed_event(subfolder)

Parameters:

subfolder (Camel.Folder) – a Camel.Folder folder

The next subfolder-‘s ‘changed’ event will be silently ignored. This is usually used in virtual folders when the change was done in them, but it is neither vTrash nor vJunk folder. Doing this avoids unnecessary removals of messages which don’t satisfy search criteria anymore, which could be done on asynchronous delivery of folder’s ‘changed’ signal. These ignored changes are accumulated and used on folder refresh.

New in version 3.2.

propagate_skipped_changes()

Propagate any skipped changes into the self. The skipped changes are used to not hide the messages from the search folder unexpectedly. The function does nothing when there are no changes to be propagated.

New in version 3.38.

rebuild_folder(subfolder, cancellable)

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to add to self

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Rebuild the folder subfolder, if it should be.

ref_folders()

Returns:

a GLib.List of all folders of this self.

Return type:

[Camel.Folder]

Returns a GLib.List of all folders of this self, which are used to populate it. These are in no particular order.

Free the returned GLib.List with g_list_free_full (folders, GObject.Object.unref); when no longer needed.

New in version 3.28.

remove_folder(subfolder, cancellable)

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to remove from self

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Removed the source folder, subfolder, from the virtual folder, self.

remove_from_ignore_changed_event(subfolder)

Parameters:

subfolder (Camel.Folder) – a Camel.Folder folder

Make sure the next subfolder-‘s ‘changed’ event will not be silently ignored. This is a counter-Camel.part function of Camel.VeeFolder.ignore_next_changed_event(), when there was expected a change, which did not happen, to take back the previous ignore event request.

New in version 3.12.

remove_vuid(mi_data, changes)

Parameters:

• mi_data (object or None) – a Camel.VeeMessageInfoData to remove

• changes (Camel.FolderChangeInfo or None) – an optional Camel.FolderChangeInfo to update with the made change, or None

Removes given mi_data from the self. The changes can be updated with the made change and later used to notify others with Camel.Folder.changed() on the self. This can be used only for the Unmatched folder.

New in version 3.6.

set_auto_update(auto_update)

Parameters:

auto_update (bool) – a value to set

Sets whether the self can automatically update when of its subfolders changes.

New in version 3.6.

set_expression(expression)

Parameters:

expression (str) – an SExp expression to set

Sets an SExp expression to be used for this self

New in version 3.6.

set_folders(folders, cancellable)

Parameters:

• folders ([Camel.Folder]) – a GLib.List of Camel.Folder to add

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Set the whole list of folder sources on a vee folder.

do_add_folder(subfolder, cancellable) virtual

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to add to vfolder

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Adds subfolder as a source folder to vfolder.

do_folder_changed(subfolder, changes) virtual

Parameters:

• subfolder (Camel.Folder) –

• changes (Camel.FolderChangeInfo) –

do_rebuild_folder(subfolder, cancellable) virtual

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to add to vfolder

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Rebuild the folder subfolder, if it should be.

do_remove_folder(subfolder, cancellable) virtual

Parameters:

• subfolder (Camel.Folder) – source Camel.Folder to remove from vfolder

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Removed the source folder, subfolder, from the virtual folder, vfolder.

do_set_expression(expression) virtual

Parameters:

expression (str) – an SExp expression to set

Sets an SExp expression to be used for this vfolder

New in version 3.6.

Property Details

Camel.VeeFolder.props.auto_update

Name:

auto-update

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Automatically _update on change in source folders