quickFilters

https://quickfilters.quickfolders.org/
Admin
quickFilters is a Thunderbird extension that simplifies email filter creation by allowing users to...
Tokens:23,268
Snippets:59
Trust Score:8
Update:11 months ago
Show doc for...
Tokens:
Raw
### Checkout quickFilters Source Code with SVN

Source: https://quickfilters.quickfolders.org/installation

This command uses the Subversion (SVN) client to checkout the quickFilters source code repository from GitHub. Ensure you have SVN installed and configured on your system.

```bash
svn co https://github.com/RealRaven2000/quickfilters/
```

--------------------------------

### Run Program with Message Parameters

Source: https://quickfilters.quickfolders.org/filtaquilla

Executes a program with parameters derived from message headers. Supports dynamic parameter substitution like subject and message ID. Parameters are comma-separated, and special values starting and ending with '@' are replaced.

```plaintext
C:\PROGRAMS\runme.exe,@SUBJECT@,@MESSAGEID@
```

```plaintext
// @SUBJECT@ subject
// @MESSAGEID@ message Id
// @AUTHOR@ author
// @RECIPIENTS@ recipients
// @DATE@ date (local string)
// @CCLIST@ cc list
// @DATEINSECONDS@ date in seconds
// @MESSAGEURI@ URI for the message
// @UTF16@ uses nsIProcess.runw() after encoding parameters to UTF-16 - see [issue 102]
// @PROPERTY@somedbproperty@ uses .getStringProperty("somedbproperty")
```

--------------------------------

### Header Regex Match Example with Custom Header

Source: https://quickfilters.quickfolders.org/filtaquilla

Illustrates how to perform a regular expression match on a custom email header, 'x-spam-status'. It shows the format 'PROPERTY:REGEX' and provides an example of searching for 'SUBJ_ALL_CAPS' within the 'x-spam-status' header.

```regex
x-spam-status:SUBJ_ALL_CAPS
```

--------------------------------

### Mozilla JavaScript Regex Syntax Example

Source: https://quickfilters.quickfolders.org/filtaquilla

Demonstrates the basic syntax for regular expressions in Mozilla JavaScript, including how to apply flags like case insensitivity. It highlights the use of slashes to delimit the regex pattern and flags, and mentions an online tester for validation.

```javascript
// Example of a case-insensitive search for 'findME'
/findME/i
```

--------------------------------

### Creating Custom Filter Templates (Conceptual)

Source: https://quickfilters.quickfolders.org/version

This outlines the process of creating custom filter templates within quickFilters. Custom templates act as blueprints for generating new filters, allowing users to define pre-set conditions and actions. The process involves naming the template, editing it with custom variables, and ensuring a specific prefix for the template name to be recognized by the assistant.

```markdown
1. Go to quickFilters options (right-click the filter assistant button)
2. Go to the Advanced Tab and after enabling [x] Custom Templates, click [Create New...]

3. Enter the name of the custom template

4. Edit the filter by selecting from the Custom Variables drop-down. This will create a new condition with a placeholder variable which will be replaced with the "real thing" when you create a new filter:

5. Make sure you leave the label "quickFilterCustomTemplate: " at the start of the Template Name; this will ensure that it will be offered as choice the next time you create a filter:
```

--------------------------------

### Troubleshooter Tests (JavaScript)

Source: https://quickfilters.quickfolders.org/version

Provides configuration options for the troubleshooter, accessible by right-clicking the troubleshoot button. These tests help diagnose and fix issues related to filter execution, target folders, custom actions, and mixed condition logic.

```javascript
Added configuration options to troubleshooter. Simply right-click the troubleshoot button to get a choice between the following tests:
1. `incomingFlag` - filters sometimes are missing this flag and will never be executed when downloading new mail. However you may want to have some filters that you only want to run manually so you may want to generally disable this check.
2. `invalidTargetFolder` - can occur when filters are imported from other / older mail profiles or folders are moved / deleted on Imap. 
3. `customActions` - finds invalid custom actions which may have been added by 3rd party add-ons (e.g FiltaQuilla); this problem will occur such Add-ons are disabled or uninstalled. 
4. `mixedAnyAndAll` - NEW TROUBLESHOOTING STEP: Fix filters that have both mixed Any and All conditions. This can occur when merging filters that have different Any/All definitions and may lead to some conditions being omitted.
```

--------------------------------

### Keyboard Shortcuts for Run Filters (Pro Feature)

Source: https://quickfilters.quickfolders.org/version

Introduces keyboard shortcuts for the 'Run Filters' buttons as a Pro feature. These shortcuts can be enabled and configured in the quickFilters Pro tab, allowing users to manually trigger filters for tasks like archiving or anti-Junk.

```text
Default shortcuts are:  
Shift + F: Run Filters on folder  
Shift + R: Run Filters on selected mails
```

--------------------------------

### Configure specific debug logging options in quickFilters

Source: https://quickfilters.quickfolders.org/bugs

This section outlines how to enable specific debug logging options in quickFilters to capture detailed information for particular issues. These settings, when set to 'true', provide more granular data for troubleshooting filter creation and source folder operations.

```ini
extensions.quickfilters.debug.buildFilter| true
extensions.quickfilters.debug.createFilter| true
extensions.quickfilters.debug.getSourceFolder| true
extensions.quickfilters.debug.notifications| true
```

--------------------------------

### Enable Experimental Reply To Field Filtering

Source: https://quickfilters.quickfolders.org/version

This is an experimental configuration option that enables filtering based on the 'Reply To' field of an email. It allows for more specific filter rules by considering the address specified in the 'Reply To' header.

```text
extensions.quickfilters.experimental.replyTo
```

--------------------------------

### JavaScript: Boolean Expressions for Virtual Folders

Source: https://quickfilters.quickfolders.org/filtaquilla

This JavaScript snippet demonstrates how to create a boolean expression for a virtual folder that goes beyond the standard search editor's capabilities. It checks for specific tags within a message, allowing for complex OR and AND logic.

```javascript
let tags = message.getStringProperty('keywords');
    (/critical/.test(tags) || /duesoon/.test(tags)) && !(/done/.test(tags));
```

--------------------------------

### Enable Debug Mode in quickFilters (Advanced Settings)

Source: https://quickfilters.quickfolders.org/bugs

This snippet describes how to enable debug mode within the quickFilters advanced settings. It involves navigating to the 'Advanced' tab and activating 'Debug Mode' to reveal additional logging options. This is a prerequisite for detailed log generation.

```text
On the _Advanced_ tab 1 , activate 2 Debug Mode then right-click it 3 to get additional log options...
```

--------------------------------

### Address Header Regex Match with Multiline Flag

Source: https://quickfilters.quickfolders.org/filtaquilla

Explains how to use anchor tokens ('^' and '$') with address headers like 'ccList', 'bccList', and 'recipients' for more precise matching. It requires the multiline flag '/m' to enable matching across delimited addresses, which change from comma-separated to line breaks.

```regex
/^recipient@example.com$/m
```

--------------------------------

### Thunderbird Filter Flags for Manual Execution

Source: https://quickfilters.quickfolders.org/version

This snippet illustrates the flags used in Thunderbird's mail filter system to manage manual execution. It specifies the necessary flags to be added to filters that were previously set to manual but now need to adhere to new settings like 'Run Manually'. This is crucial for ensuring filters operate correctly after updates.

```JavaScript
const nsMsgFilterType = {
  InboxRule: 1,
  NewsRule: 2
};

// Example of adding flags to an existing filter:
// filter.flags |= nsMsgFilterType.InboxRule;
// filter.flags |= nsMsgFilterType.NewsRule;

```

--------------------------------

### Configure Filter Assistant Exclusion Settings

Source: https://quickfilters.quickfolders.org/version

This snippet shows how to configure the quickFilters assistant to ignore specific folder types when deleting or archiving mail. It involves modifying settings related to trash, junk, and archive folders.

```text
extensions.quickfilters.assistant.exclude.trash = true
extensions.quickfilters.assistant.exclude.archive = false
```
Tokens:
Raw