Camel.VeeFolder – camel-1.2 – Vala Binding Reference

Description:

[ CCode ( type_id = "camel_vee_folder_get_type ()" ) ]
public class VeeFolder : Folder

A virtual folder representing a saved search.

VeeFolder is a Folder 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 add_folder_sync, remove_folder_sync, and set_folders_sync. The search expression (a CamelFolderSearch s-expression) is set with 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 get_location.

Virtual folders are normally parented to a VeeStore. The special UNMATCHED folder represents all messages in the tracked folders that are not matched by any other virtual folder.

All known sub-classes:

VTrashFolder

Namespace: Camel

Content:

Properties:

public bool auto_update { get; set; }

Automatically update on change in source folders

Creation methods:

public VeeFolder (Store parent_store, string full, uint32 flags)

Methods:

public void @construct (uint32 flags)

Initializes internal structures of the this .

public bool add_folder_sync (Folder subfolder, VeeFolderOpFlags op_flags, Cancellable? cancellable = null) throws Error

Adds subfolder as a source folder to this.

public GenericArray<unowned Folder> dup_folders ()

Returns a GenericArray of all folders of this this, which are used to populate it.

public Folder? dup_vee_uid_folder (string vee_message_uid)

public bool get_auto_update ()

public unowned string get_expression ()

public uint32 get_flags ()

public unowned Folder get_location (VeeMessageInfo vinfo, out string? realuid)

Find the real folder (and message info UID) for the given

vinfo

public bool remove_folder_sync (Folder subfolder, VeeFolderOpFlags op_flags, Cancellable? cancellable = null) throws Error

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

public void set_auto_update (bool auto_update)

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

public bool set_expression_sync (string expression, VeeFolderOpFlags op_flags, Cancellable? cancellable = null) throws Error

Sets an SExp expression to be used for this this and updates its content.

public bool set_folders_sync (GenericArray<Folder> folders, VeeFolderOpFlags op_flags, Cancellable? cancellable = null) throws Error

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

Signals:

public signal void vee_setup_changed ()

Inherited Members:

VeeFolder