ProxyConfig Object

Holds the state of one proxy configuration. There are at least one of these contained by the ProxyConfigs object.

Properties

id

Name	Type	Description	Since	Requires
id	Long	Gets the unqiue id of this ProxyConfig. Read-only.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

name

Name	Type	Description	Since	Requires
name	String	Gets/sets the name of this ProxyConfig.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

notes

Name	Type	Description	Since	Requires
notes	String	Gets/sets the notes associated with this ProxyConfig.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

color

Name	Type	Description	Since	Requires
color	String	Gets/sets the HTML hex color code the FoxyProxy icon uses when this ProxyConfig is used to load a URL.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

mode

Name	Type	Description	Since	Requires
mode	String	Gets/sets the current mode of this ProxyConfig. Acceptable values are `direct`, `manual`, `system`, and `auto`. Direct means use no proxy. Manual means use the proxy server specified in the manualConfig settings (host, port, username, password, NTLM domain, socks/no socks, etc). Auto means use the PAC file or WPAD specified in autoConfig. System means use the operating system-defined proxy settings.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

enabled

Name	Type	Description	Since	Requires
enabled	Boolean	Enables/disables use of this ProxyConfig. Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

selectedTabIndex

Name	Type	Description	Since	Requires
selectedTabIndex	Integer	Gets/sets the currently selected tab in the Add/Edit Proxy Configuration window for this ProxyConfig. The value is zero-indexed. Valid values are 0 (General Tab), 1 (Proxy Details Tab), 2 (URL Patterns Tab) for Basic and Standard and 0, 1, 2, 3 (IP Patterns Tab) for FoxyProxy Plus. Note that the Default proxy configuration only has two tabs: 0 and 1.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

animatedIcons

Name	Type	Description	Since	Requires
animatedIcons	Boolean	Gets/sets whether the FoxyProxy icon is animated when this ProxyConfig is in use. This corresponds to the checkbox on the General Tab named "Animate icons when this proxy is in use". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

includeInCycle

Name	Type	Description	Since	Requires
includeInCycle	Boolean	Gets/sets whether the FoxyProxy icon is animated when this ProxyConfig is in use. This corresponds to the checkbox on the General Tab named "Include this proxy when cycling proxies by clicking on the statusbar or toolbar (Global Settings->Statusbar/Toolbar- Activation->Cycle through modes must be selected)". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

clearCacheBeforeUse

Name	Type	Description	Since	Requires
clearCacheBeforeUse	Boolean	Gets/sets whether the application (typically a browser) cache is cleared everytime before this ProxyConfig is used. This corresponds to the checkbox on the General Tab named "Clear application cache before using this proxy". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

disableCache

Name	Type	Description	Since	Requires
disableCache	Boolean	Gets/sets whether the application (typically a browser) cache is disabled everytime before this ProxyConfig is used. This corresponds to the checkbox on the General Tab named "Do not cache while using this proxy". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

clearCookiesBeforeUse

Name	Type	Description	Since	Requires
clearCookiesBeforeUse	Boolean	Gets/sets whether all cookies are deleted everytime before this ProxyConfig is used. This corresponds to the checkbox on the General Tab named "Remove all cookies before using this proxy". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

rejectCookies

Name	Type	Description	Since	Requires
rejectCookies	Boolean	Gets/sets whether all cookies are blocked everytime before this ProxyConfig is used. This corresponds to the checkbox on the General Tab named "Block all cookies when using this proxy". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

proxyDNS

Name	Type	Description	Since	Requires
proxyDNS	Boolean	Gets/sets whether DNS lookups are resolved using this proxy when this ProxyConfig is in use. Note that only SOCKS 4a and SOCKS 5 proxy servers support DNS lookups. This setting corresponds to the checkbox on the General Tab named "Perform remote DNS lookups on hostnames loading through this proxy". Acceptable values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

manualConfig

Name	Type	Description	Since	Requires
manualConfig	Object	Gets the object representing a Manual Proxy Configuration. Corresponds to the collection of properties on the Proxy Details tab under "Manual Proxy Configuration" (host/ip address, port, username, password, NTLM domain, SOCKS proxy, etc).	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

host

Name	Type	Description	Since	Requires
host	String	Gets/sets the host name or IP address.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

port

Name	Type	Description	Since	Requires
port	String or Integer	Gets/sets the port	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

socks

Name	Type	Description	Since	Requires
socks	Boolean	Gets/sets whether the proxy server at the specified host:port is a SOCKS server. If `false`, the proxy server is assumed to be an HTTP(S) proxy server.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

socksversion

Name	Type	Description	Since	Requires
socksversion	String	Gets/sets the version of the SOCKS server at the specified host:port. Valid values are "5" and "4". If "4" is specified, the server is assumed to be version "4a". If something other than "5" or "4" is specified, the server is assumed to be version 4a.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

autoConfig

Name	Type	Description	Since	Requires
autoConfig	Object	Gets the object representing an Automatic Proxy Configuration -- a PAC or WPAD. Corresponds to the collection of properties on the Proxy Details tab under "Automatic Proxy Configuration" (by WPAD, by PAC, Automatic proxy configuration url, Detect proxy settings automatically every X minutes, etc).	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

mode

Name	Type	Description	Since	Requires
mode	String	Gets/sets whether this autoConfig uses WPAD or PAC settings. If WPAD, the URL is hard-coded to http://wpad/wpad.dat for security reasons. Valid values are "wpad" or "pac".	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

url

Name	Type	Description	Since	Requires
url	String	Gets/sets the URL of the PAC file. Local files can be specified using the file:// protocol; e.g., file:///tmp/proxy.pac or file://c:/temp/proxy.pac. If the autoConfig mode is wpad, this URL is hard-coded to http://wpad/wpad.dat for security reasons.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

autoReload

Name	Type	Description	Since	Requires
autoReload	Boolean	Gets/sets whether the PAC or WPAD URL should be automatically reloaded on a periodic basis. The frequency of reloading is set with the `reloadFrequencyMins` property. Valid values are `true` or `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

reloadFrequencyMins

Name	Type	Description	Since	Requires
reloadFrequencyMins	Integer	Gets/sets the number of minutes after which the PAC or WPAD URL is automatically reloaded. Ignored if autoReload is `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

disableOnBadPAC

Name	Type	Description	Since	Requires
disableOnBadPAC	Boolean	Gets/sets whether this ProxyConfig is disabled if the PAC/WPAD URL failed to successfully load and parse. Valid values are `true` and `false`. Note there is no GUI for this option.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

loadNotification

Name	Type	Description	Since	Requires
loadNotification	Boolean	Gets/sets whether the user is notified of successful PAC/WPAD URL loads. Valid values are `true` and `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

errorNotification

Name	Type	Description	Since	Requires
errorNotification	Boolean	Gets/sets whether the user is notified of failed PAC/WPAD URL loads. Valid values are `true` and `false`.	Basic: 2.6 Standard: 3.6 Plus: 4.6	Gecko 2+ (Firefox 4+, Thunderbird 3.3+, SeaMonkey 2.1+)

Functions

None