Class
CamelVeeFolder
Description [src]
class Camel.VeeFolder : Camel.Folder
{
CamelVeeFolderPrivate* priv
}A virtual folder representing a saved search.
CamelVeeFolder is a CamelFolder subclass that implements virtual folders.
A virtual folder is like a persistent search over one or more real folders:
it automatically stays up to date as messages arrive or change, and
otherwise behaves like a normal folder to client code.
The set of source folders is managed with camel_vee_folder_add_folder_sync(),
camel_vee_folder_remove_folder_sync(), and camel_vee_folder_set_folders_sync().
The search expression (a CamelFolderSearch s-expression) is set with camel_vee_folder_set_expression_sync().
Virtual folder UIDs are composed of an 8-character hash of the physical folder plus the original UID, making them stable across renames and allowing efficient reverse-lookup via camel_vee_folder_get_location().
Virtual folders are normally parented to a CamelVeeStore. The special
UNMATCHED folder represents all messages in the tracked folders that are
not matched by any other virtual folder.
Instance methods
camel_vee_folder_construct
Initializes internal structures of the vf. This is meant to be
called by the descendants of CamelVeeFolder.
camel_vee_folder_dup_folders
Returns a GPtrArray of all folders of this vfolder, which
are used to populate it. These are in no particular order.
since: 3.58
camel_vee_folder_get_location
Find the real folder (and message info UID) for the given vinfo.
When the realuid is not NULL and it’s set, then use g_free() to
free it, when no longer needed.
camel_vee_folder_remove_folder_sync
Removed the source folder, subfolder, from the virtual folder, vfolder.
since: 3.58
camel_vee_folder_set_auto_update
Sets whether the vfolder can automatically update when of its
subfolders changes.
since: 3.6
camel_vee_folder_set_expression_sync
Sets an SExp expression to be used for this vfolder
and updates its content. The expression is not changed
when the call fails.
since: 3.58
camel_vee_folder_set_folders_sync
Set the whole list of folder sources on a search folder.
since: 3.58
Methods inherited from CamelFolder (77)
Please see CamelFolder for a full list of methods.
Properties
Properties inherited from CamelFolder (6)
Camel.Folder:description
The folder’s description.
Camel.Folder:display-name
The folder’s display name.
Camel.Folder:full-name
The folder’s fully qualified name.
Camel.Folder:mark-seen
A CamelThreeState persistent option of the folder,
which can override global option to mark messages
as seen after certain interval.
since: 3.32
Camel.Folder:mark-seen-timeout
Timeout in milliseconds for marking messages as seen.
since: 3.32
Camel.Folder:parent-store
The CamelStore to which the folder belongs.
Signals
Signals inherited from CamelFolder (3)
CamelFolder::changed
CamelFolder::deleted
CamelFolder::renamed
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.