StoreSummary

Object Hierarchy:

Description:

[ CCode ( type_id = "camel_store_summary_get_type ()" ) ]
public class StoreSummary : Object

Cached folder listing for a mail store.

StoreSummary is a helper class used by Store implementations to cache the list of known folders and their metadata (name, flags, unread count, etc.). Like FolderSummary for messages, it avoids the need to query the remote server for the folder list on every session start.

The summary is stored on disk in a versioned binary format that supports subclassing, so backend-specific implementations can add their own per-folder fields.

Backends subclass StoreSummary to store additional information relevant to their storage format, and typically call load at startup and save when the folder list changes.

Namespace: Camel

Package: camel-1.2

Content:

Creation methods:

public StoreSummary ()
Create a new StoreSummary object.

Methods:

public void add (owned StoreInfo info)
The info record should have been generated by calling one of the info_new_*() functions, as it will be free'd based on the summary class.
public unowned StoreInfo? add_from_path (string path)
Build a new info record based on the name, and add it to the summary.
public GenericArray<StoreInfo> array ()
Obtain a copy of the summary array.
public bool connect_folder_summary (string path, FolderSummary folder_summary)
Connects listeners for count changes on folder_summary to keep CamelStoreInfo.
public int count ()
Get the number of summary items stored in this summary.
public bool disconnect_folder_summary (FolderSummary folder_summary)
Diconnects count change listeners previously connected by connect_folder_summary.
public StoreInfo info_new ()
Allocate a new StoreInfo , suitable for adding to this summary.
public int load ()
Load the summary off disk.
public StoreInfo? path (string path)
Retrieve a summary item by path name.
public void remove (StoreInfo info)
Remove a specific info record from the summary.
public void remove_path (string path)
Remove a specific info record from the summary, by path.
public int save ()
Writes the summary to disk.
public void set_filename (string filename)
Set the filename where the summary will be loaded to/saved from.
public void sort (CompareDataFunc compare_func)
Sorts the array of the folders using the compare_func.
public virtual void store_info_free (owned StoreInfo info)
public virtual StoreInfo store_info_load (FileStream file)
public virtual StoreInfo store_info_new (string path)
public virtual int store_info_save (FileStream file, StoreInfo info)
public virtual void store_info_set_value (StoreInfo info, int type, string value)
public virtual int summary_header_load (FileStream file)
public virtual int summary_header_save (FileStream file)
public void touch ()
Mark the summary as changed, so that a save will force it to be written back to disk.

Inherited Members:

All known members inherited from class GLib.Object