FilterDriver

---

Object Hierarchy:

Description:

Content:

Creation methods:

• public FilterDriver (Session session)

Methods:

• public void add_rule (string name, string match, string action)
  Adds a new rule to set of rules to process by the filter driver.
• public int filter_folder (Folder folder, UIDCache cache, GenericArray<string>? uids, bool remove, Cancellable? cancellable = null) throws Error
  Filters a folder based on rules defined in the FilterDriver object.
• public int filter_mbox (string mbox, string? original_source_url, Cancellable? cancellable = null) throws Error
  Filters an mbox file based on rules defined in the FilterDriver object.
• public int filter_message (MimeMessage? message, MessageInfo? info, string? uid, Folder? source, string? store_uid, string? original_store_uid, Cancellable? cancellable = null) throws Error
  Filters a message based on rules defined in the FilterDriver object.
• public void flush () throws Error
  Flush all of the only-once filter actions.
• public bool remove_rule_by_name (string name)
  Removes a rule by name, added by add_rule.
• public void set_default_folder (Folder? def)
  Sets a default folder for the driver.
• public void set_folder_func (FilterGetFolderFunc get_folder)
  Sets a callback (of type FilterGetFolderFunc) to get a folder.
• public void set_logfile (FileStream logfile)
  Sets a log file to use for logging.
• public void set_play_sound_func (FilterPlaySoundFunc func)
  Sets a callback to call when a play of a sound is requested.
• public void set_shell_func (FilterShellFunc func)
  Sets a shell command callback, which is called when a shell command execution is requested.
• public void set_status_func (FilterStatusFunc func)
  Sets a status callback, which is used to report progress/status.
• public void set_system_beep_func (FilterSystemBeepFunc func)
  Sets a callback to use for system beep.

Inherited Members: