- public void @delete ()
Marks this as deleted and performs
any required cleanup.
- public void @lock ()
Locks this.
- public void @unlock ()
Unlocks this, previously locked with
@lock.
- public async bool append_message (MimeMessage message, MessageInfo? info, int io_priority, Cancellable? cancellable = null, out string? appended_uid) throws Error
Appends message to this
asynchronously.
- public virtual bool append_message_sync (MimeMessage message, MessageInfo? info, out string? appended_uid, Cancellable? cancellable = null) throws Error
Appends message to this
.
- public virtual int cmp_uids (string uid1, string uid2)
Compares two uids.
- public virtual uint32 count_by_expression (string expression, Cancellable? cancellable = null) throws Error
Searches the folder for count of messages matching the given search
expression.
- public virtual void delete_ ()
- public string dup_description ()
- public string dup_display_name ()
- public string dup_full_name ()
- public async bool expunge (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously deletes messages which have been marked as "DELETED".
- public virtual bool expunge_sync (Cancellable? cancellable = null) throws Error
Deletes messages which have been marked as "DELETED".
- public void free_deep (GenericArray<string> array)
Frees the provided array and its contents.
- public void free_shallow (GenericArray<string> array)
Frees the provided array but not its contents.
- public virtual void free_summary (GenericArray<MessageInfo> array)
- public virtual void free_uids (GenericArray<string> array)
Frees the array of UIDs returned by
get_uids.
- public virtual void freeze ()
Freezes the folder so that a series of operation can be performed
without "folder_changed" signals being emitted.
- public int get_deleted_message_count ()
- public unowned string get_description ()
Returns a description of the folder suitable for displaying to the
user.
- public unowned string get_display_name ()
Returns the display name for the folder.
- public virtual string get_filename (string uid) throws Error
- public uint32 get_flags ()
- public unowned FolderSummary get_folder_summary ()
- public int get_frozen_count ()
- public virtual unowned string get_full_display_name ()
Similar to the
get_full_name, only returning full path to the
this suitable for the display to a user.
- public unowned string get_full_name ()
Returns the fully qualified name of the folder.
- public ThreeState get_mark_seen ()
- public int get_mark_seen_timeout ()
- public async unowned MimeMessage get_message (string message_uid, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets the message corresponding to message_uid
from this.
- public virtual MimeMessage? get_message_cached (string message_uid, Cancellable? cancellable = null)
Gets the message corresponding to message_uid from the
this cache, if available locally.
- public virtual int get_message_count ()
- public virtual uint32 get_message_flags (string uid)
- public virtual MessageInfo? get_message_info (string uid)
- public virtual unowned MimeMessage get_message_sync (string message_uid, Cancellable? cancellable = null) throws Error
Gets the message corresponding to message_uid from
this.
- public virtual bool get_message_user_flag (string uid, string name)
- public virtual unowned string get_message_user_tag (string uid, string name)
- public unowned Store get_parent_store ()
- public virtual uint32 get_permanent_flags ()
- public async FolderQuotaInfo get_quota_info (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously gets a list of known quotas for
this.
- public virtual FolderQuotaInfo get_quota_info_sync (Cancellable? cancellable = null) throws Error
Gets a list of known quotas for this
.
- public virtual unowned GenericArray<string> get_summary ()
This returns the summary information for the folder.
- public virtual unowned GenericArray<string> get_uids ()
Get the list of UIDs available in a folder.
- public virtual unowned GenericArray<string> get_uncached_uids (GenericArray<string> uids) throws Error
Returns the known-uncached uids from a list of uids.
- public int get_unread_message_count ()
- public virtual bool has_search_capability ()
- public bool has_summary_capability ()
Get whether or not the folder has a summary.
- public virtual bool is_frozen ()
- public virtual void prepare_content_refresh ()
Lets the this know that it should
refresh its content the next time from fresh.
- public async bool purge_message_cache (string start_uid, string end_uid, int io_priority, Cancellable? cancellable = null) throws Error
Delete the local cache of all messages between these uids.
- public virtual bool purge_message_cache_sync (string start_uid, string end_uid, Cancellable? cancellable = null) throws Error
Delete the local cache of all messages between these uids.
- public async bool refresh_info (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously synchronizes a folder's summary with its backing store.
- public virtual bool refresh_info_sync (Cancellable? cancellable = null) throws Error
Synchronizes a folder's summary with its backing store.
- public virtual void rename (string new_name)
Marks this as renamed.
- public virtual GenericArray<string> search_by_expression (string expression, Cancellable? cancellable = null) throws Error
Searches the folder for messages matching the given search expression.
- public virtual GenericArray<string> search_by_uids (string expression, GenericArray<string> uids, Cancellable? cancellable = null) throws Error
Search a subset of uid's for an expression match.
- public virtual void search_free (GenericArray<string> result)
- public void set_description (string description)
Sets a description of the folder suitable for displaying to the user.
- public void set_display_name (string display_name)
Sets the display name for the folder.
- public void set_flags (uint32 folder_flags)
Sets folder flags (bit-or of
FolderFlags) for the this.
- public void set_full_name (string full_name)
Sets the fully qualified name of the folder.
- public void set_lock_async (bool skip_folder_lock)
Sets whether folder locking (
@lock and @unlock) should
be used.
- public void set_mark_seen (ThreeState mark_seen)
Sets whether the messages in this this
should be marked as seen automatically.
- public void set_mark_seen_timeout (int timeout)
Sets the timeout in milliseconds for marking messages as
seen in this this.
- public virtual bool set_message_flags (string uid, uint32 mask, uint32 @set)
Sets those flags specified by mask to the values
specified by set on the indicated message.
- public virtual void set_message_user_flag (string uid, string name, bool value)
- public virtual void set_message_user_tag (string uid, string name, string value)
- public virtual void sort_uids (GenericArray<string> uids)
Sorts the array of UIDs.
- public async bool synchronize (bool expunge, int io_priority, Cancellable? cancellable = null) throws Error
Synchronizes any changes that have been made to
this to its backing store asynchronously, optionally expunging deleted messages as well.
- public async bool synchronize_message (string message_uid, int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously ensure that a message identified by message_uid
has been synchronized in this so that calling
get_message on it later will work in offline mode.
- public virtual bool synchronize_message_sync (string message_uid, Cancellable? cancellable = null) throws Error
Ensure that a message identified by message_uid has been
synchronized in this so that calling
get_message on it later will work in offline mode.
- public virtual bool synchronize_sync (bool expunge, Cancellable? cancellable = null) throws Error
Synchronizes any changes that have been made to
this to its backing store, optionally expunging deleted messages as well.
- public void take_folder_summary (owned FolderSummary summary)
- public virtual void thaw ()
Thaws the folder and emits any pending folder_changed signals.
- public async bool transfer_messages_to (GenericArray<string> message_uids, Folder destination, bool delete_originals, int io_priority, Cancellable? cancellable = null, out GenericArray<string>? transferred_uids) throws Error
Asynchronously copies or moves messages from one folder to another.
- public virtual bool transfer_messages_to_sync (GenericArray<string> message_uids, Folder destination, bool delete_originals, out GenericArray<string>? transferred_uids, Cancellable? cancellable = null) throws Error
Copies or moves messages from one folder to another.