Folder

---

Object Hierarchy:

Description:

Content:

Properties:

• public string description { get; set construct; }
  The folder's description.
• public string display_name { get; set construct; }
  The folder's display name.
• public uint flags { get; set; }
  Folder flags (bit-or of FolderFlags).
• public string full_name { get; set construct; }
  The folder's fully qualified name.
• public ThreeState mark_seen { get; set construct; }
  A ThreeState persistent option of the folder, which can override global option to mark messages as seen after certain interval.
• public int mark_seen_timeout { get; set construct; }
  Timeout in milliseconds for marking messages as seen.
• public Store parent_store { get; construct; }
  The Store to which the folder belongs.

Creation methods:

• protected Folder ()

Methods:

• 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 void delete_ ()
• public string dup_description ()
  Thread-safe variation of get_description.
• public string dup_display_name ()
  Thread-safe variation of get_display_name.
• public string dup_full_name ()
  Thread-safe variation of get_full_name.
• public virtual bool dup_headers_sync (string uid, out NameValueArray out_headers, Cancellable? cancellable = null) throws Error
  Reads headers of a message with the uid and returns it in the out_headers.
• public virtual GenericArray<unowned string> dup_uids ()
  Duplicates a list of UIDs available in the this.
• public virtual GenericArray<unowned string> dup_uncached_uids (GenericArray<string> uids) throws Error
  Returns the known-uncached uids from a list of uids.
• 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 virtual void freeze ()
  Freezes the folder so that a series of operation can be performed without "folder_changed" signals being emitted.
• 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 ()
  Get the FolderSummary if the backend actually supports it.
• 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)
  Retrieve the MessageInfo for the specified 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 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 unowned string? get_state_filename ()
  Get the current state filename.
• 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 void load_state ()
  Loads properties with CAMEL_FOLDER_PARAM_PERMANENT from a state file previously set by take_state_filename.
• public class void map_legacy_property (string prop_name, int32 tag)
  Add the legacy property binding to allow opening legacy binary file states.
• 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 void save_state ()
  Saves properties with CAMEL_FOLDER_PARAM_PERMANENT into a state file previously set by take_state_filename.
• public virtual bool search_body_sync (GenericArray<string> words, out GenericArray<unowned string> out_uids, Cancellable? cancellable = null) throws Error
  Search the folder for messages with body containing words .
• public virtual bool search_header_sync (string header_name, GenericArray<string>? words, out GenericArray<unowned string> out_uids, Cancellable? cancellable = null) throws Error
  Search the folder for messages with header header_name, which either contains the words or, when the words is empty or null, the header exists in the message.
• public virtual bool search_sync (string expression, out GenericArray<unowned string>? out_uids, Cancellable? cancellable = null) throws Error
  Searches the folder for messages matching the given search expression.
• 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 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)
  Sets a FolderSummary of the folder.
• public void take_state_filename (owned string filename)
  Set the current state filename.
• 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<unowned 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<unowned string>? transferred_uids, Cancellable? cancellable = null) throws Error
  Copies or moves messages from one folder to another.

Signals:

• public virtual signal void changed (FolderChangeInfo changes)
• public virtual signal void deleted ()
• public virtual signal void renamed (string old_name)

Inherited Members: