Store
Object Hierarchy:
Description:
[
CCode ( type_id =
"camel_store_get_type ()" ) ]
public abstract class Store :
Service,
Initable
Base class for mail storage backends.
Store is the base class for backends that support storage and retrieval of mail messages. It is a
Service subclass that manages a connection and a collection of
Folder objects.
Store provides: - **Folder retrieval** —
get_folder opens a named folder; get_inbox_folder and
get_trash_folder are convenience wrappers for common system folders. -
**Folder management** — creating, renaming, and deleting folders. - **Folder listing** —
get_folder_info returns a tree of
FolderInfo describing the available folders. - **Subscriptions** — optional folder
subscription management for backends like IMAP that support it (via camel_store_subscriptions flag and
the Subscribable interface).
By default, stores set the camel_store_vtrash and camel_store_vjunk
flags, which cause the base class to implement the trash and junk folders as virtual (
VeeFolder) folders.
The store emits signals when folders are opened, created, deleted, renamed, subscribed, or unsubscribed.
Content:
Creation methods:
Methods:
- public virtual bool can_refresh_folder (FolderInfo info) throws Error
Returns if this folder (param info) should be checked for new mail or
not.
- public async FolderInfo? create_folder (string? parent_name, string folder_name, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously creates a new folder as a child of an existing folder.
- public virtual FolderInfo? create_folder_sync (string? parent_name, string folder_name, Cancellable? cancellable = null) throws Error
Creates a new folder as a child of an existing folder.
- public void delete_cached_folder (string folder_name)
Deletes local data for the given folder_name.
- public async bool delete_folder (string folder_name, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously deletes the folder described by folder_name
.
- public virtual bool delete_folder_sync (string folder_name, Cancellable? cancellable = null) throws Error
Deletes the folder described by folder_name.
- public GenericArray<Folder> dup_opened_folders ()
Returns a
GenericArray of all the opened folders for the this.
- public virtual bool get_can_auto_save_changes ()
Returns whether there can be done automatic save of folder changes.
- public unowned StoreDB get_db ()
- public uint32 get_flags ()
- public async Folder? get_folder (string folder_name, StoreGetFolderFlags flags, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets a specific folder object from
this by name.
- public async FolderInfo? get_folder_info (string? top, StoreGetFolderInfoFlags flags, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously fetches information about the folder structure of
this, starting with top.
- public virtual FolderInfo? get_folder_info_sync (string? top, StoreGetFolderInfoFlags flags, Cancellable? cancellable = null) throws Error
This fetches information about the folder structure of
this, starting with top, and returns a tree of
FolderInfo structures.
- public virtual Folder? get_folder_sync (string folder_name, StoreGetFolderFlags flags, Cancellable? cancellable = null) throws Error
Gets a specific folder object from this
by name.
- public unowned ObjectBag get_folders_bag ()
- public async Folder? get_inbox_folder (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets the folder in this
into which new mail is delivered.
- public virtual Folder? get_inbox_folder_sync (Cancellable? cancellable = null) throws Error
Gets the folder in this into which
new mail is delivered.
- public async Folder? get_junk_folder (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets the folder in this
into which junk is delivered.
- public virtual Folder? get_junk_folder_sync (Cancellable? cancellable = null) throws Error
Gets the folder in this into which
junk is delivered.
- public uint32 get_permissions ()
- public async Folder? get_trash_folder (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets the folder in this
into which trash is delivered.
- public virtual Folder? get_trash_folder_sync (Cancellable? cancellable = null) throws Error
Gets the folder in this into which
trash is delivered.
- public async bool initial_setup (int io_priority, Cancellable? cancellable = null, out HashTable<unowned string,unowned string> out_save_setup) throws Error
Runs initial setup for the this
asynchronously.
- public virtual bool initial_setup_sync (out HashTable<unowned string,unowned string> out_save_setup, Cancellable? cancellable = null) throws Error
Runs initial setup for the this.
- public bool maybe_run_db_maintenance () throws Error
Checks the state of the current
StoreDB used for the this and eventually runs
maintenance routines on it.
- public async bool rename_folder (string old_name, string new_name, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously renames the folder described by old_name
to new_name.
- public virtual bool rename_folder_sync (string old_name, string new_name, Cancellable? cancellable = null) throws Error
Renames the folder described by old_name to
new_name.
- public virtual bool search_multimailbox_sync (GenericArray<Folder> folders, string search_key, GenericArray<string> words, out HashTable<unowned string,unowned GenericArray<void*>> out_results, Cancellable? cancellable = null) throws Error
Runs search across multiple mailboxes in a single operation.
- public void set_flags (uint32 flags)
- public void set_permissions (uint32 permissions)
- public async bool synchronize (bool expunge, int io_priority, Cancellable? cancellable = null) throws Error
Synchronizes any changes that have been made to
this and its folders with the real store asynchronously.
- public virtual bool synchronize_sync (bool expunge, Cancellable? cancellable = null) throws Error
Synchronizes any changes that have been made to
this and its folders with the real store.
Signals:
- public virtual signal void folder_created (FolderInfo folder_info)
Emits the folder_created signal from an
idle source on the main loop.
- public virtual signal void folder_deleted (FolderInfo folder_info)
Emits the folder_deleted signal from an
idle source on the main loop.
- public virtual signal void folder_info_stale ()
This signal indicates significant changes have occurred to the folder
hierarchy of store, and that previously fetched FolderInfo data should
be considered stale.
- public virtual signal void folder_opened (Folder folder)
Emits the folder_opened signal from an
idle source on the main loop.
- public virtual signal void folder_renamed (string old_name, FolderInfo folder_info)
Emits the folder_renamed signal from an
idle source on the main loop.
Inherited Members:
All known members inherited from class Camel.Service
All known members inherited from class GLib.Object
All known members inherited from interface GLib.Initable