Camel.VeeDataCache¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`add_subfolder` (subfolder)
	`contains_message_info_data` (folder, orig_message_uid)
	`foreach_message_info_data` (fromfolder, func, *user_data)
	`get_message_info_data` (folder, orig_message_uid)
	`get_message_info_data_by_vuid` (vee_message_uid)
	`get_subfolder_data` (folder)
	`remove_message_info_data` (mi_data)
	`remove_subfolder` (subfolder)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Camel.VeeDataCache(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Camel.VeeDataCacheClass

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

New in version 3.6.

classmethod new()¶

Returns:: a new Camel.VeeDataCache; unref it with GObject.Object.unref(), when no longer needed.
Return type:: Camel.VeeDataCache

New in version 3.6.

add_subfolder(subfolder)¶

Parameters:: subfolder (Camel.Folder) – a Camel.Folder

Adds the subfolder to the self to be tracked by it. The subfolder is referenced for later use. The function does nothing when the subfolder is already in the self. The subfolders can be removed with Camel.VeeDataCache.remove_subfolder().

New in version 3.6.

contains_message_info_data(folder, orig_message_uid)¶

Parameters:

folder (Camel.Folder) – a Camel.Folder to which the orig_message_uid belongs
orig_message_uid (str) – a message UID from the folder to check

Return type:

bool

Returns whether data_cache contains given orig_message_uid for the given folder. Unlike Camel.VeeDataCache.get_message_info_data(), this only returns False if not, while Camel.VeeDataCache.get_message_info_data() auto-adds it to data_cache.

New in version 3.6.

foreach_message_info_data(fromfolder, func, *user_data)¶

Parameters:

fromfolder (Camel.Folder) – a Camel.Folder
func (Camel.ForeachInfoData) – a Camel.ForeachInfoData function to call
user_data (object or None) – user data to pass to the func

Calls the func for each message info data from the given fromfolder

New in version 3.6.

get_message_info_data(folder, orig_message_uid)¶

Parameters:

folder (Camel.Folder) – a Camel.Folder to which the orig_message_uid belongs
orig_message_uid (str) – a message UID from the folder to return

Returns:

a referenced Camel.VeeMessageInfoData; unref it with GObject.Object.unref(), when no longer needed.

Return type:

Camel.VeeMessageInfoData

Returns a referenced Camel.VeeMessageInfoData referencing the given folder and orig_message_uid. If it’s not Camel.part of the self, then it is created and auto-added. Use Camel.VeeDataCache.contains_message_info_data() when you only want to check the existence, without adding it to the self.

New in version 3.6.

get_message_info_data_by_vuid(vee_message_uid)¶

Parameters:: vee_message_uid (str) – a message UID in the virtual folder
Returns:: a referenced Camel.VeeMessageInfoData, which corresponds to the given vee_message_uid, or None, when no such message info with that virtual UID exists. Unref it with GObject.Object.unref(), when no longer needed.
Return type:: Camel.VeeMessageInfoData or None

New in version 3.6.

get_subfolder_data(folder)¶

Parameters:: folder (Camel.Folder) – a Camel.Folder for which to return subfolder data
Returns:: a referenced Camel.VeeSubfolderData; unref it with GObject.Object.unref(), when no longer needed.
Return type:: Camel.VeeSubfolderData

Returns a Camel.VeeSubfolderData for the given folder.

New in version 3.6.

remove_message_info_data(mi_data)¶

Parameters:: mi_data (Camel.VeeMessageInfoData) – a Camel.VeeMessageInfoData to remove

Removes given mi_data from the self.

New in version 3.6.

remove_subfolder(subfolder)¶

Parameters:: subfolder (Camel.Folder) – a Camel.Folder to remove

Removes given subfolder from the self, which had been previously added with Camel.VeeDataCache.add_subfolder(). The function does nothing, when the subfolder is not Camel.part of the self.

New in version 3.6.