foxyproxy.xml File Format

Firefox editions only, although Chrome editions can import/export this format. Items in orange are specific to FoxyProxy Plus.

Node Name JavaScript Class Location Purpose

foxyproxy foxyproxy components/foxyproxy.js The document root. Acts as a container for child nodes, but also contains some global data as attributes.

Attribute Name	Legal Values	Default Value	Purpose
mode	patterns\| _proxy_id_\| random\| roundrobin\| disabled\| previous	patterns	This value determines the core behavior of FoxyProxy. Patterns is Use proxies based on their pre-defined patterns and priorities. _proxy_id_ means that all URLs are loaded through the proxy with the specified internal id (all proxies have a unique id--see the id attribute on the proxy node). Random and roundrobin are not fully implemented yet. Disabled means FoxyProxy is completed disabled. Previous is an internal-only mode; read more about it in the previousMode attribute.
previousMode			The mode in use just before the current mode. This value is used in order to support Toggle between current mode and disabled in Global Settings
selectedTabIndex	0 (proxies tab)\|1 (global settings tab)\|2 (quickadd tab)\|3 (autoadd tab)\|4 (logging tab)	1	Stores the 0-based index of the last selected tab in options.xul. This permits the last selected tab to be restored when the user re-opens the FoxyProxy options window.
toolbarIcon	true\|false	true	Show/hide the FoxyProxy menu on the toolbar
toolsMenu	true\|false	true	Show/hide the FoxyProxy menu in the Tools menu
contextMenu	true\|false	true	Show/hide the FoxyProxy menu in the context (right-click) menu
advancedMenus	true\|false	false	Enable/disable advanced menus in the Tools menu, context-menu, and toolbar menu
resetIconColors	true\|false	true	Hidden setting (no GUI). When FoxyProxy is set to Use proxies based on their pre-defined patterns and priorities, this value determines if the FoxyProxy icon is changed to its default orange after loading a URL. If true, the icon is changed to orange. If false, the icon remains the color of the proxy that was last used. This enables you to easily see which proxy was last used (instead of having to use the FoxyProxy Logging tab).
useStatusBarPrefix	true\|false	true	If true, FoxyProxy: is prepended to any statusbar text.
excludePatternsFromCycling	true\|false	false	Hidden setting (no GUI). This affects the order of mode cycling when Cycle through modes is selected in Global Settings. When false, Use proxies based on their pre-defined patterns and priorities is included in the cycle rotation.
excludeDisabledFromCycling	true\|false	false	Hidden setting (no GUI). This affects the order of mode cycling when Cycle through modes is selected in Global Settings. When false, Completely Disable FoxyProxy is not including in the cycle rotation.
ignoreProxyScheme	true\|false	false	Hidden setting (no GUI). If true, clicks on `proxy://` links are ignored. More info on proxy:// links.
apiDisabled	true\|false	false	Hidden setting (no GUI). If true, FoxyProxy API calls by webpages are ignored except for calls to the `foxyproxy.apiDisabled` property. (That allows webpages to know if they can use the API or not) More info.

Node Name JavaScript Class Location Purpose

statusbar foxyproxy.statusbar components/foxyproxy.js Controls the display and behavior of FoxyProxy in the statusbar

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
icon	true\|false	true	foxyproxy.statusbar._iconEnabled	If true, the FoxyProxy icon is displayed in the statusbar.
text	true\|false	false	foxyproxy.statusbar._textEnabled	If true, the name of the proxy (or mode) is displayed in the statusbar. It is optionally prefixed with FoxyProxy: depending on the value of `useStatusBarPrefix`
left	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	options	foxyproxy.statusbar._leftClick	Action to perform when the FoxyProxy statusbar icon/text is left-clicked.
middle	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	cycle	foxyproxy.statusbar._middleClick	Action to perform when the FoxyProxy statusbar icon/text is middle-clicked.
right	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	contextmenu	foxyproxy.statusbar._rightClick	Action to perform when the FoxyProxy statusbar icon/text is right-clicked.
width	integer	0	foxyproxy.statusbar._width	Width of statusbar text. If 0, text width adjusts dynamically to accomodate all text. If proxy names are different lengths, this causes an annoying effect to some users whereby the statusbar text grows and shrinks many times per second. Using a non-zero value prevents this but also clips text as necessary.

Node Name

JavaScript Class

Location

Purpose

toolbar

foxyproxy.toolbar

components/foxyproxy.js

Controls the display and behavior of FoxyProxy in the toolbar

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
left	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	options	foxyproxy.toolbar._leftClick	Action to perform when the FoxyProxy toolbar icon is left-clicked.
middle	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	cycle	foxyproxy.toolbar._middleClick	Action to perform when the FoxyProxy toolbar icon is middle-clicked.
right	options\| cycle\| contextmenu\| reloadcurtab\| reloadtabsinbrowser\| reloadtabsinallbrowsers\| removeallcookies\| toggle\| refreshlocalips\| quickadd	contextmenu	foxyproxy.toolbar._rightClick	Action to perform when the FoxyProxy toolbar icon is right-clicked.
Note: showing/hiding of toolbar is controlled by the Customize Toolbar window, so there are no attributes here for that.

Node Name

JavaScript Class

Location

Purpose

logg

foxyproxy.logg

components/foxyproxy.js

Controls the display and behavior of logging.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
enabled	true\|false	false	foxyproxy.logg.enabled	If true, logging is enabled and available in the FoxyProxy logging tab.
maxSize	integer	500	foxyproxy.logg._maxSize	The number of log entries after which the log "rolls". It's important to understand that log entries are kept in-memory. If the log is permitted to grow without bounds, all memory would eventually be consumed. So, when this number of log entries is reached, the log begins overwriting (in memory) the oldest entries.
noURLs	true\|false	false	foxyproxy.logg._noURLs	If true, URLs are not stored in log entries. Some users prefer this for privacy reasons.
header	HTML		foxyproxy.logg._templateHeader	When saving the log to disk, this value is output before the log entries (rows) are output. There are substitution variables, delimited by ${}, that are used to control where log entry columns are output.
row	HTML		foxyproxy.logg._templateRow	When saving the log to disk, this value is output for each log entry. There are substitution variables, delimited by ${}, that are used to control where log entry columns are output.
footer	HTML		foxyproxy.logg._templateFooter	When saving the log to disk, this value is output after all log entries (rows) are output. There are substitution variables, delimited by ${}, that are used to control where log entry columns are output.

Node Name

JavaScript Class

Location

Purpose

warnings

foxyproxy.warnings

components/foxyproxy.js

Saves user preferences about which prompts to display/never display.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
white-patterns	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed in FoxyProxy Standard and Plus asking if one really wants to save the proxy settings without having defined whitelist patterns for it. (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
md5Warning	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking whether a pattern subscription should still be imported although its MD5 sum is not matching the expected value. (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
noneEncodingWarning	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking whether a pattern subscription should still be imported although its encoding is not matching the user's preference. (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
wildcards	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed indicating that wildcard characters are missing in wildcard patterns. (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
parentheses	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed indicating that parantheses in regular expression patterns are unprotected (if that happens to be the case). (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
confirmDeleteProxy	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking whether the proxy in question should really get deleted.
patSubDelete	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking in FoxyProxy Standard and Plus whether the pattern subscription in question should really get deleted. (That warning is not available in FoxyProxy Basic due to a missing pattern mode.)
openXNewTabs	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking whether more than 3 selected URLs in the logging tab should get opened in new tabs.
socks	true\|false	false	foxyproxy.logg._warnings array	If false, no prompt is displayed asking whether one really wants to set a non-SOCKS proxy within Thunderbird.

Node Name JavaScript Class Location Purpose

proxies foxyproxy.proxies components/foxyproxy.js Container for proxy nodes.

proxy Proxy components/proxy.js Contains information about a proxy server as well as configuration info.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
id	positive integer	Randomly generated	Proxy.id	Unique identifier for this proxy configuration. This value is used internally and not exposed to users.
name	any string	If none specified by user, the ip address:port of the proxy server	Proxy.name	Name given to the proxy
notes	any string	none	Proxy.notes	Notes about the proxy configuration
enabled	true\|false	true	Proxy._enabled	If true, the proxy is enabled. If false, the proxy is disabled.
mode	direct\|manual\|auto	manual	Proxy._mode	The current mode of this proxy configuration.`direct` means use no proxy. `manual` means use the proxy server specified in the <manualconf/> child node. `auto` means use the PAC file specified in the <autoconf/> child node
selectedTabIndex	0 (General Tab)\|1 (Proxy Details Tab)\|2 (URL Patterns Tab)\|3 (IP Patterns Tab)	1	Proxy.selectedTabIndex	The 0-based index of the last selected tab in addeditproxy.xul. This permits the last selected tab to be restored when the user re-opens the Proxy Settings window.
lastresort	true\|false	false	Proxy.lastresort	If true, this is the special proxy named "Default". This proxy cannot be deleted, disabled, have patterns added to it, and has other restrictions. It is the "catchall" described here.
animatedIcons	true\|false	true	Proxy.animatedIcons	If true, the FoxyProxy icon rotates when this proxy is used to load a URL.
includeInCycle	true\|false	true	Proxy.includeInCycle	If true, this proxy is included in proxy rotation ("cycling"). Cycling is initiated when the user clicks one of the mouse buttons on a FoxyProxy icon as defined by Global Settings->Toolbar/Statusbar Activation->Cycle through modes
color	hex color code (string)	#0055E5	Proxy._color	The FoxyProxy icon color when this proxy is used to load a URL.
proxyDNS	true\|false	true	Proxy._proxyDNS	If true and the proxy server is a SOCKS 4a/5 server, then DNS lookups are performed on the server (remotely) instead of locally.
noInternalIPs	true\|false	false	Proxy.noInternalIPs	If true and pattern mode is selected the proxy is not used on internal IP addresses according to RFC 1918.
clearCacheBeforeUse	true\|false	false	Proxy.clearCacheBeforeUse	If true, browser cache is cleared before this proxy is used.
disableCache	true\|false	false	Proxy.disableCache	If true, browser cache is not used when this proxy is in use. If false, existing browser settings are used.
clearCookiesBeforeUse	true\|false	false	Proxy.clearCookiesBeforeUse	If true, all cookies are deleted before this proxy is used.
rejectCookies	true\|false	false	Proxy.disableCache	If true, cookies are not accepted while this proxy is in use. If false, existing browser settings are used.

Node Name JavaScript Class Location Purpose

matches Proxy.matches array components/proxy.js Container for <match/> nodes relating to URL patterns. A better name for this would have been patterns.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
enabled	true\|false	true	Match.enabled	If true, this pattern is enabled; it has effect.
name	any string	none	Match.name	Name given to the pattern
pattern	any string	none	Match._pattern	Wildcard/regular expression pattern
isRegEx	true\|false	false	Match._isRegEx	If true, Match._pattern is a regular expression. If false, it's a wildcard pattern.
isBlackList	true\|false	false	Match.isBlackList	If true, Match._pattern is a blacklist pattern. If false, it's a whitelist pattern.
isMultiLine	true\|false	false	Match._isMultiLine	If true, Match._pattern is a multi-line pattern. That is, pattern matching ignores line breaks. This is an internal value used for AutoAdd. There is no GUI for it.
caseSensitive	true\|false	false	Match._caseSensitive	If true, Match._pattern is case-sensitive.
temp	true\|false	false	Match.temp	Although this attribute is never persisted to foxyproxy.xml, it is worth mentioning. If this value is `true`, then this `Match` object isn't persisted to foxyproxy.xml. In this way, users can specify patterns that don't survive browser restarts ("one-time" patterns).
fromSubscription	true\|false	false	Match._fromSubscription	If true, Match._pattern is part of a proxy subscription.

Node Name JavaScript Class Location Purpose

ippatterns Container for <match/> nodes relating to IP addresses.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
enabled	true\|false	true	Match.enabled	If true, this pattern is enabled; it has effect.
name	any string	none	Match.name	Name given to the pattern
pattern	any string	none	Match._pattern	Wildcard/regular expression pattern
isRegEx	true\|false	false	Match._isRegEx	If true, Match._pattern is a regular expression. If false, it's a wildcard pattern.
isBlackList	true\|false	false	Match.isBlackList	If true, Match._pattern is a blacklist pattern. If false, it's a whitelist pattern.
temp	true\|false	false	Match.temp	Although this attribute is never persisted to foxyproxy.xml, it is worth mentioning. If this value is `true`, then this `Match` object isn't persisted to foxyproxy.xml. In this way, users can specify patterns that don't survive browser restarts ("one-time" patterns).

Node Name JavaScript Class Location Purpose

quickadd Metadata about QuickAdd and container for a <match/> node describing the pattern to be added when QuickAdd is initiated.

Attribute Name	Legal Values	Default Value	JavaScript Variable	Purpose
enabled	true\|false	false	Superadd._enabled	If true, this pattern is enabled; it has effect.
reload	true\|false	true	Superadd._reload	If true, a page gets reloaded if necessary after a pattern got added to a proxy.
notify	true\|false	true	Superadd._notify	If true, the user gets notified if QuickAdd gets used.
notifyWhenCanceled	true\|false	true	Superadd._notifyWhenCanceled	If true, the user gets notified if QuickAdd gets aborted.
prompt	true\|false	true	Superadd._prompt	If true, the user gets prompted in order to edit and configure a pattern before it is added to a proxy.
temp	true\|false	false	Superadd._temp	Although this attribute is never persisted to foxyproxy.xml, it is worth mentioning. If this value is `true`, then this `Match` object isn't persisted to foxyproxy.xml. In this way, users can specify patterns that don't survive browser restarts ("one-time" patterns).

Node Name	JavaScript Class	Location	Purpose
random	foxyproxy.random	components/foxyproxy.js	Experimental. Reserved for future use. Not currently used.