FedExAddress Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to validate or complete recipient addresses.

Syntax

class dshippingsdk.FedExAddress

Remarks

Via this class you can perform the following:

• Confirm the validity and completeness of US, Puerto Rico and Canadian recipient addresses.
• Complete incomplete recipient addresses.
• Correct invalid recipient addresses.
• Determine whether an address is business or residential to increase the accuracy of courtesy rate quotes. This applies to US addresses only.
• Find information on the nearest FedEx location(s).

Having correct addresses on the shipping labels will eliminate delivery delays and additional service fees (occurring when a shipment is re-routed).

For address verification, use the validate_address method. This provides street level matches, but it does not currently verify suite or apartment numbers. It checks if the street exists in the city and state/province or postal code entered, and if the street number is within a valid range for the street entered. Upon successful reply, it either provides an exact match or possible alternatives (multiple address results) when an exact match cannot be found based on the input values, or informs you if no possible alternatives can be found.

The following information is the minimum required to check an address:

• Street Address
• City and State/Province or Postal Code

To search for the nearest FedEx location(s), use the find_locations method. You can search by address or telephone number.

To narrow down the search, you can specify what type of locations are you looking for (such as FedEx Staffed, Self-Service and/or Authorized Ship Center) and any special service those locations offer (such as Saturday service, packaging supplies, packing services, latest Express drop-off, etc.).

If the request completes successfully, FedEx server will return a set of matches that satisfies the search criteria. You will be able to retrieve FedEx location Ids, addresses, available services they offer, operations hours on weekdays and/or weekends.

The set of locations retrieved is limited to a maximum of ten locations returned within a 50-mile radius.

To use this class, you must have a FedEx fed_ex_account_number. You should also have already obtained a fed_ex_developer_key, fed_ex_password and a fed_ex_meter_number uniquely assigned to your account by FedEx after registration for Web Services.

FedEx allows this service to be used in production environment only (i.e., after passing the certification). Customers need to be certified first in order to have the Advanced (such as Address Validation) services activated. After the certification is granted, you will receive the production credentials (fed_ex_developer_key, fed_ex_password and fed_ex_meter_number) uniquely assigned to your fed_ex_account_number by FedEx after being certified for FedEx Web Services. Once they move to production, Address Validation is a feature that has to be activated upon the customer's request.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

address1	Street name.
address2	A specific detail on the address (such as building, suite, apartment, floor number etc.
address_flags	Various flags that denote information about the address.
city	Name of city, town, etc.
country_code	Country code.
state	State or province code.
zip_code	Postal code.
company	Name of the company that resides at the address to be validated.
constraint_express_dropoff_time	This should contain the time you would like to dropoff an express package.
constraint_filters	The following flags are defined (specified in hexadecimal notation).
constraint_location_attributes	This indicates the services you would like to search for at a particular location.
constraint_location_content_options	This sets what content you would like to have returned with the location data.
constraint_location_type_flags	This indicates the type(s) of FedEx location you would like to search for.
constraint_results_requested	The number of results requested.
constraint_results_to_skip	The number of results to skip.
constraint_search_radius	This contains the search radius to be used when FindLocations is called.
constraint_supported_redirect_to_hold_service	Indicates which redirect to hold services you are searching for.
fed_ex_account_number	Account number for logging in to the FedEx Server .
fed_ex_csp_product_id	Identifies the CSP product.
fed_ex_csp_product_version	Identifies the CSP product version.
fed_ex_csp_user_key	CSP end user key.
fed_ex_csp_user_password	CSP end user password.
fed_ex_developer_key	Identifying part of the authentication key used for the sender's identity.
fed_ex_language_code	Two-letter code for the language (e.
fed_ex_locale_code	Two-letter code for the region (e.
fed_ex_meter_number	Meter number to use for submitting requests to the FedEx Server .
fed_ex_password	Secret part of authentication key used for the sender's identity.
fed_ex_server	URL for the FedEx Server where the requests are sent.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
geographic_coordinates	Specifies the geographic coordinates by which nearby FedEx locations are to be found.
location_count	The number of records in the Location arrays.
location_accepted_currency	The currency that is accepted at this FedEx location.
location_attributes	This specifies what type of services this FedEx location provides.
location_carrier_count	This contains the number of Carriers returned for the current location.
location_carrier_effective_latest_dropoff_count	This contains the total number of effective latest dropoff times that were returned for the carrier specified by CarrierIndex .
location_carrier_effective_latest_dropoff_day_of_week	This contains the day of the week for the current effective latest dropoff.
location_carrier_effective_latest_dropoff_index	This specifies the index for the effective latest dropoff time for the carrier specified by CarrierIndex .
location_carrier_effective_latest_dropoff_time	This contains the current carrier's effective dropoff time for the specified day.
location_carrier_exceptional_latest_dropoff_count	This contains the total number of exceptional latest dropoff times that were returned for the carrier specified by CarrierIndex .
location_carrier_exceptional_latest_dropoff_day_of_week	This contains the day of the week for the current exceptional latest dropoff.
location_carrier_exceptional_latest_dropoff_index	This specifies the index for the exceptional latest dropoff time for the carrier specified by CarrierIndex .
location_carrier_exceptional_latest_dropoff_time	This contains the current carrier's exceptional dropoff time for the specified day.
location_carrier_index	This contains the current index for the array of carriers that were returned for the current location.
location_carrier_normal_latest_dropoff_count	This contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex .
location_carrier_normal_latest_dropoff_day_of_week	This contains the day of the week for the current normal latest dropoff.
location_carrier_normal_latest_dropoff_index	This specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex .
location_carrier_normal_latest_dropoff_time	This contains the current carrier's normal dropoff time for the specified day.
location_carrier_type	This contains the type of carrier the current carrier is.
location_carrier_type_description	The textual description of the rfCarrierType;.
location_city	Name of the city that the current location is in.
location_company_name	The name of the business at this FedEx location.
location_country_code	This contains the country code for the current location.
location_effective_hours_count	This contains the number of effective hours that were returned for the current location.
location_effective_hours_day_of_week	This contains the day of the week for which the effective hours are being specified.
location_effective_hours_description	This contains the description for the effective hours, specified by EffectiveHoursIndex , for the current location.
location_effective_hours_index	This specifies the current index for the array containing the current location's effective hours.
location_effective_hours_operational_hours	This contains the time range for the effective hours, specified by EffectiveHoursIndex , that the current location is open.
location_email	The email address provided for the current location.
location_entity_id	The entity ID for the current location.
location_exceptional_hours_count	This contains the number of exceptional hours that were returned for the current location.
location_exceptional_hours_day_of_week	This contains the day of the week for which the exceptional hours are being specified.
location_exceptional_hours_description	This contains the description for the exceptional hours, specified by ExceptionalHoursIndex , for the current location.
location_exceptional_hours_index	This specifies the current index for the array containing the current location's exceptional hours.
location_exceptional_hours_operational_hours	This contains the time range for the exceptional hours, specified by ExceptionalHoursIndex , that the current location is open.
location_fax	This contains the fax number for the current location.
location_geographic_coordinates	This contains the geographic coordinates of the current location.
location_holiday_count	This contains the number of holidays that the current FedEx location observes.
location_holiday_date	This is the date of the holiday specified by HolidayIndex .
location_holiday_index	This contains the index of the current holiday the FedEx location observes.
location_holiday_name	This contains the name of the holiday specified by HolidayIndex .
location_id	Business identifier that can be used by IRV attendant to look directions to this FedEx location.
location_map_url	This contains the URL to the google map showing the location.
location_normal_hours_count	This contains the number of normal hours that were returned for the current location.
location_normal_hours_day_of_week	This contains the day of the week for which the normal hours are being specified.
location_normal_hours_description	This contains the description for the normal hours, specified by NormalHoursIndex , that the current location is open.
location_normal_hours_index	This specifies the current index for the array containing the current location's normal hours.
location_normal_hours_operational_hours	This contains the time range for the normal hours, specified by NormalHoursIndex , that the current location is open.
location_person_name	The name of the person listed as the contact for the current location.
location_phone	The phone number for the current location.
location_special_instructions	This contains any special instructions provided for the current location.
location_state	State or province code of the current location.
location_store_number	The store number for the current location.
location_street_address	Street address or intersection of this FedEx location.
location_type	The type of this FedEx location.
location_zip_code	The postal code for the current location.
match_count	The number of records in the Match arrays.
match_address1	Address line 1 of an address candidate in the list of matches (if any).
match_address2	Address line 2 of an address candidate in the list of matches (if any).
match_change_type	Changes made to the Address (during validation process) compared to this address candidate.
match_city	City name of an address candidate in the list of matches (if any).
match_company	Name of the company that resides at an address candidate in the list of matches (if any).
match_country_code	Country code of an address candidate in the list of matches (if any).
match_quality	Quality factor an address candidate in the list of matches (if any).
match_residential_status	Residential status of an address candidate in the list of matches (if any).
match_state	State or province code of an address candidate in the list of matches (if any).
match_zip_code	Postal Code of an address candidate in the list of matches (if any).
phone	Phone number for which nearby FedEx locations are to be found.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
search_criteria	The criteria to be used to find FedEx Locations.
sort_criteria	The criteria to be used to sort the results.
ssl_accept_server_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_store	This is the name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	This is the type of certificate store for this certificate.
ssl_cert_subject	This is the subject of the certificate used for client authentication.
ssl_provider	This specifies the SSL/TLS implementation to use.
ssl_server_cert_encoded	This is the certificate (PEM/base64 encoded).
timeout	A timeout for the class.
total_locations_found	Specifies the total number of locations found.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

config	Sets or retrieves a configuration setting.
find_locations	Finds FedEx location(s) based on the input data.
reset	Resets the internal state of the class and all properties to their default values.
validate_address	Returns corrected and standardized address information.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

on_error	Information about errors during data delivery.
on_notification	Notification returned by the server upon successful request (if applicable).
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CSPProductId	Identifies the CSP product.
CSPProductVersion	Identifies the CSP product version.
CSPUserKey	CSP end user key.
CSPUserPassword	CSP end user password.
CustomContent	Defines any custom content to print on the label.
CustomerTransactionId	Customer transaction id.
EstimateDelivery	Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
HasXPath	Determines whether a specific element exists in the document.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
UseSOAP	Determines if the FedEx SOAP web services are used instead of the FedEx XML web services.
Warning	Warning message returned by the server.
XAttrCount	The number of records in the XAttr arrays.
XAttrName[i]	The name of the indexed attribute.
XAttrValue[i]	The value of the indexed attribute.
XChildCount	The number of records in the XChild arrays.
XChildElement[i]	The name of the indexed child element.
XChildText[i]	The text of the indexed child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Used to set the XPath within the response from the server.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

address1 Property

Street name.

Syntax

def get_address1() -> str: ...
def set_address1(value: str) -> None: ...

address1 = property(get_address1, set_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS address1 should not exceed 35 characters.

address2 Property

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

def get_address2() -> str: ...
def set_address2(value: str) -> None: ...

address2 = property(get_address2, set_address2)

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS address2 should not exceed 35 characters.

address_flags Property

Various flags that denote information about the address.

Syntax

def get_address_flags() -> int: ...
def set_address_flags(value: int) -> None: ...

address_flags = property(get_address_flags, set_address_flags)

Default Value

0

Remarks

Various flags that denote information about the address.

Value	Meaning
0x00000001	POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses.
0x00000002	Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

city Property

Name of city, town, etc.

Syntax

def get_city() -> str: ...
def set_city(value: str) -> None: ...

city = property(get_city, set_city)

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

country_code Property

Country code.

Syntax

def get_country_code() -> str: ...
def set_country_code(value: str) -> None: ...

country_code = property(get_country_code, set_country_code)

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

Country Name	Country Code
Afghanistan	AF
Albania	AL
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antigua	AG*
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Barbuda	AG*
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bonaire	AN**
Bosnia-Herzegovina	BA
Botswana	BW
Brazil	BR
British Virgin Islands	VG*
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Canary Islands	ES**
Cape Verde	CV
Cayman Islands	KY**
Chad	TD
Channel Islands	GB**
Chile	CL
China	CN
Colombia	CO
Congo	CG
Congo Dem. Rep. Of	CD
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Curacao	AN**
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
East Timor	TL
Ecuador	EC
Egypt	EG
El Salvador	SV
England	GB**
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	ET
Faeroe Islands	FO*
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
French Polynesia	PF**
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Grand Cayman	KY**
Great Britain	GB**
Great Thatch Island	VG*
Great Tobago Islands	VG*
Greece	GR
Greenland	GL
Grenada	GD
Guadeloupe	GP**
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Holland	NL**
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT**
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jordan	JO
Jost Van Dyke Islands	VG*
Kazakhstan	KZ
Kenya	KE
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Martinique	MQ
Mauritania	MR
Mauritius	MU
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nepal	NP
Netherlands	NL**
Netherlands Antilles	AN**
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Norman Island	VG*
Northern Ireland	GB**
Northern Mariana Islands	MP**
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Palestine	PS*
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Reunion	RE
Romania	RO
Rota	MP**
Russia	RU
Rwanda	RW
Saba	AN**
Saipan	MP**
Samoa	WS
San Marino	IT**
Saudi Arabia	SA
Scotland	GB**
Senegal	SN
Serbia & Montenegro	CS
Seychelles	SC
Singapore	SG
Slovak Republic	SK
Slovenia	SI
South Africa	ZA
South Korea	KR
Spain	ES**
Sri Lanka	LK
St. Barthelemy	GP**
St. Christopher	KN**
St. Croix Island	VI**
St. Eustatius	AN**
St. John	VI**
St. Kitts and Nevis	KN**
St. Lucia	LC
St. Maarten	AN**
St. Thomas	VI**
St. Vincent	VC**
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Tahiti	PF**
Taiwan	TW
Tanzania	TZ
Thailand	TH
Tinian	MP**
Togo	TG
Tonga	TO
Tortola Island	VG*
Trinidad & Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks & Caicos Islands	TC
U.S. Virgin Islands	VI**
Uganda	UG
Ukraine	UA
Union Island	VC**
United Arab Emirates	AE
United Kingdom	GB**
United States	US
Uruguay	UY
Uzbekistan	UZ
Vanuatu	VU
Vatican City	IT**
Venezuela	VE
Vietnam	VN
Wales	GB**
Wallis & Futuna Islands	WF
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Country Name	Country Code
Cayman Islands	KY
French Polynesia	PF
Guadeloupe	GP
Italy	IT
Netherlands	NL
Netherlands Antilles	AN
Northern Mariana Islands	MP
Spain	ES
St. Kitts and Nevis	KN
St. Vincent	VC
United Kingdom	GB
U.S. Virgin Islands	VI

state Property

State or province code.

Syntax

def get_state() -> str: ...
def set_state(value: str) -> None: ...

state = property(get_state, set_state)

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

zip_code Property

Postal code.

Syntax

def get_zip_code() -> str: ...
def set_zip_code(value: str) -> None: ...

zip_code = property(get_zip_code, set_zip_code)

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both city and state are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

company Property

Name of the company that resides at the address to be validated.

Syntax

def get_company() -> str: ...
def set_company(value: str) -> None: ...

company = property(get_company, set_company)

Default Value

""

Remarks

To narrow down the search for address candidates, you can include the company in the address validation request (when the validate_address is called). Providing a company name may improve your results since some addresses have specific company names assigned to them.

constraint_express_dropoff_time Property

This should contain the time you would like to dropoff an express package.

Syntax

def get_constraint_express_dropoff_time() -> str: ...
def set_constraint_express_dropoff_time(value: str) -> None: ...

constraint_express_dropoff_time = property(get_constraint_express_dropoff_time, set_constraint_express_dropoff_time)

Default Value

""

Remarks

This should contain the time you would like to dropoff an express package.

constraint_filters Property

The following flags are defined (specified in hexadecimal notation).

Syntax

def get_constraint_filters() -> int: ...
def set_constraint_filters(value: int) -> None: ...

constraint_filters = property(get_constraint_filters, set_constraint_filters)

Default Value

0

Remarks

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple filters:

Value	Meaning
0x00000001 (ExcludeLocationsOutsideStateOrProvince)	Indicates whether to exclude locations outside the state or province

constraint_location_attributes Property

This indicates the services you would like to search for at a particular location.

Syntax

def get_constraint_location_attributes() -> int: ...
def set_constraint_location_attributes(value: int) -> None: ...

constraint_location_attributes = property(get_constraint_location_attributes, set_constraint_location_attributes)

Default Value

0

Remarks

This indicates the services you would like to search for at a particular location.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Value	Meaning
0x00000001 (AcceptsCash)	Whether this location accepts cash
0x00000002 (AlreadyOpen)	Whether this location is already open
0x00000004 (CopyAndPrintServices)	Whether this location offers Copy and Print services
0x00000008 (DangerousGoodsServices)	Whether this location offers dangerous goods services
0x00000010 (DirectMailServices)	Whether this location offers Direct Mail services
0x00000020 (ExpressFreightDropoffs)	Whether this location offers Express freight dropoff services
0x00000040 (ExpressParcelDropoffs)	Whether this location offers Express parcel dropoff services
0x00000080 (FedExFreightDropoffs)	Whether this location offers FedEx Freight dropoff services
0x00000100 (GroundDropoffs)	Whether this location offers Ground dropoff services
0x00000200 (GroundHomeDeliveryDropoffs)	Whether this location offers Ground Home Delivery dropoff services
0x00000400 (LocationIsInAirport)	Whether this location is located in an airport
0x00000800 (NotaryServices)	Whether this location offers Notary services
0x00001000 (ObservesDayLightSavingTimes)	Whether this location observes day light savings time
0x00002000 (OpenTwentyFourHours)	Whether this location is open 24 hours
0x00004000 (PackagingSupplies)	Whether this location offers packaging supplies
0x00008000 (PackAndShip)	Whether this location offers Pack and Ship services
0x00010000 (PassportPhotoServices)	Whether this location offers passport photo services
0x00020000 (ReturnServices)	Whether this location offers return services
0x00040000 (SaturdayDropoffs)	Whether this location offers Saturday dropoff services
0x00080000 (SaturdayExpressHoldAtLocation)	Whether this location offers Saturday Express Hold at Location services
0x00100000 (SignsAndBannersService)	Whether this location offers Signs and Banners services
0x00200000 (SonyPictureStation)	Whether this location has a Sony picture station
0x00400000 (VideoConferencing)	Whether this location offers video conferencing services
0x00800000 (WeekdayExpressHoldAtLocation)	Whether this location offers Weekday Express Hold at Location services
0x01000000 (WeekdayGroundHoldAtLocation)	Whether this location offers Weekday Ground Hold at Location services

constraint_location_content_options Property

This sets what content you would like to have returned with the location data.

Syntax

def get_constraint_location_content_options() -> int: ...
def set_constraint_location_content_options(value: int) -> None: ...

constraint_location_content_options = property(get_constraint_location_content_options, set_constraint_location_content_options)

Default Value

0

Remarks

This sets what content you would like to have returned with the location data.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Value	Meaning
0x00000001 (Holidays)	Indicates that you would like holiday data to be returned.
0x00000002 (LocationDropoffTimes)	Indicates that you would like the location's dropoff times to be returned.
0x00000004 (MapURL)	Indicates that you would like a map URL to be returned.

constraint_location_type_flags Property

This indicates the type(s) of FedEx location you would like to search for.

Syntax

def get_constraint_location_type_flags() -> int: ...
def set_constraint_location_type_flags(value: int) -> None: ...

constraint_location_type_flags = property(get_constraint_location_type_flags, set_constraint_location_type_flags)

Default Value

0

Remarks

This indicates the type(s) of FedEx location you would like to search for.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple location types:

Value	Meaning
0x00000001 (AuthorizedShipCenter)	Indicates to include authorized ship centers
0x00000002 (ExpressStation)	Indicates to include express stations
0x00000004 (FreightServiceCenter)	Indicates to include freight service centers
0x00000008 (GroundTerminal)	Indicates to include ground terminals
0x00000010 (HomeDeliveryStation)	Indicates to include home delivery stations
0x00000020 (FedExOffice)	Indicates to include FedEx Office locations
0x00000040 (SelfServiceStation)	Indicates to include self service stations
0x00000080 (SmartPostHub)	Indicates to include SmartPost hubs

constraint_results_requested Property

The number of results requested.

Syntax

def get_constraint_results_requested() -> int: ...
def set_constraint_results_requested(value: int) -> None: ...

constraint_results_requested = property(get_constraint_results_requested, set_constraint_results_requested)

Default Value

1

Remarks

The number of results requested.

constraint_results_to_skip Property

The number of results to skip.

Syntax

def get_constraint_results_to_skip() -> int: ...
def set_constraint_results_to_skip(value: int) -> None: ...

constraint_results_to_skip = property(get_constraint_results_to_skip, set_constraint_results_to_skip)

Default Value

0

Remarks

The number of results to skip.

constraint_search_radius Property

This contains the search radius to be used when FindLocations is called.

Syntax

def get_constraint_search_radius() -> str: ...
def set_constraint_search_radius(value: str) -> None: ...

constraint_search_radius = property(get_constraint_search_radius, set_constraint_search_radius)

Default Value

""

Remarks

This contains the search radius to be used when find_locations is called.

constraint_supported_redirect_to_hold_service Property

Indicates which redirect to hold services you are searching for.

Syntax

def get_constraint_supported_redirect_to_hold_service() -> int: ...
def set_constraint_supported_redirect_to_hold_service(value: int) -> None: ...

constraint_supported_redirect_to_hold_service = property(get_constraint_supported_redirect_to_hold_service, set_constraint_supported_redirect_to_hold_service)

Default Value

0

Remarks

Indicates which redirect to hold services you are searching for.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple services:

Value	Meaning
0x00000001 (FedExExpress)	Indicates whether the location supports RedirectToHold for FedExExpress
0x00000002 (FedExGround)	Indicates whether the location supports RedirectToHold for FedExGround
0x00000004 (FedExGroundHomeDelivery)	Indicates whether the location supports RedirectToHold for FedExGroundHomeDelivery

fed_ex_account_number Property

Account number for logging in to the FedEx Server .

Syntax

def get_fed_ex_account_number() -> str: ...
def set_fed_ex_account_number(value: str) -> None: ...

fed_ex_account_number = property(get_fed_ex_account_number, set_fed_ex_account_number)

Default Value

""

Remarks

Account number for logging in to the FedEx server. An fed_ex_account_number and fed_ex_meter_number will be required with each input request a user makes to a FedEx server.

The fed_ex_account_number is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

For all transaction whether they are Ground or Express service, you will need to pass your valid 9 digit FedEx account number.

fed_ex_csp_product_id Property

Identifies the CSP product.

Syntax

def get_fed_ex_csp_product_id() -> str: ...
def set_fed_ex_csp_product_id(value: str) -> None: ...

fed_ex_csp_product_id = property(get_fed_ex_csp_product_id, set_fed_ex_csp_product_id)

Default Value

""

Remarks

Identifies the CSP product.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: fed_ex_account_number, fed_ex_meter_number, fed_ex_developer_key, fed_ex_password, fed_ex_csp_user_key, fed_ex_csp_user_password and fed_ex_csp_product_version.

fed_ex_csp_product_version Property

Identifies the CSP product version.

Syntax

def get_fed_ex_csp_product_version() -> str: ...
def set_fed_ex_csp_product_version(value: str) -> None: ...

fed_ex_csp_product_version = property(get_fed_ex_csp_product_version, set_fed_ex_csp_product_version)

Default Value

""

Remarks

Identifies the CSP product version.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: fed_ex_account_number, fed_ex_meter_number, fed_ex_developer_key, fed_ex_password, fed_ex_csp_user_key, fed_ex_csp_user_password and fed_ex_csp_product_id.

fed_ex_csp_user_key Property

CSP end user key.

Syntax

def get_fed_ex_csp_user_key() -> str: ...
def set_fed_ex_csp_user_key(value: str) -> None: ...

fed_ex_csp_user_key = property(get_fed_ex_csp_user_key, set_fed_ex_csp_user_key)

Default Value

""

Remarks

CSP end user key.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique fed_ex_csp_user_key and fed_ex_csp_user_password that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (fed_ex_developer_key and fed_ex_password respectively).

fed_ex_csp_user_password Property

CSP end user password.

Syntax

def get_fed_ex_csp_user_password() -> str: ...
def set_fed_ex_csp_user_password(value: str) -> None: ...

fed_ex_csp_user_password = property(get_fed_ex_csp_user_password, set_fed_ex_csp_user_password)

Default Value

""

Remarks

CSP end user password.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique fed_ex_csp_user_key and fed_ex_csp_user_password that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (fed_ex_developer_key and fed_ex_password respectively).

fed_ex_developer_key Property

Identifying part of the authentication key used for the sender's identity.

Syntax

def get_fed_ex_developer_key() -> str: ...
def set_fed_ex_developer_key(value: str) -> None: ...

fed_ex_developer_key = property(get_fed_ex_developer_key, set_fed_ex_developer_key)

Default Value

""

Remarks

Identifying part of the authentication key used for the sender's identity.

The fed_ex_developer_key is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Developer Key is provided to you by FedEx after registration and it is the publicly known part of authentication credential. The Developer Key may also be referred to as an Authentication Key.

The fed_ex_developer_key, fed_ex_account_number, fed_ex_meter_number, and fed_ex_password will be required with each input request a user makes to a FedEx server. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

fed_ex_language_code Property

Two-letter code for the language (e.

Syntax

def get_fed_ex_language_code() -> str: ...
def set_fed_ex_language_code(value: str) -> None: ...

fed_ex_language_code = property(get_fed_ex_language_code, set_fed_ex_language_code)

Default Value

"EN"

Remarks

Two-letter code for the language (e.g. EN, FR, etc.).

This field allows you to assign the language code. Default value is EN.

fed_ex_locale_code Property

Two-letter code for the region (e.

Syntax

def get_fed_ex_locale_code() -> str: ...
def set_fed_ex_locale_code(value: str) -> None: ...

fed_ex_locale_code = property(get_fed_ex_locale_code, set_fed_ex_locale_code)

Default Value

"us"

Remarks

Two-letter code for the region (e.g. us, ca, etc.).

Some languages require a locale code to further identify the language. Default value is us.

fed_ex_meter_number Property

Meter number to use for submitting requests to the FedEx Server .

Syntax

def get_fed_ex_meter_number() -> str: ...
def set_fed_ex_meter_number(value: str) -> None: ...

fed_ex_meter_number = property(get_fed_ex_meter_number, set_fed_ex_meter_number)

Default Value

""

Remarks

Meter number to use for submitting requests to the FedEx fed_ex_server.

An fed_ex_account_number and fed_ex_meter_number will be required with each input request a user makes to a FedEx server. The Meter Number is provided to you by FedEx when you register for service. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

fed_ex_password Property

Secret part of authentication key used for the sender's identity.

Syntax

def get_fed_ex_password() -> str: ...
def set_fed_ex_password(value: str) -> None: ...

fed_ex_password = property(get_fed_ex_password, set_fed_ex_password)

Default Value

""

Remarks

Secret part of authentication key used for the sender's identity.

The fed_ex_password is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Password is provided to you by FedEx after registration and it is the private part of authentication credential, known only to the user and FedEx.

The fed_ex_developer_key, fed_ex_account_number, fed_ex_meter_number, and fed_ex_password will be required with each input request a user makes to a FedEx server. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

fed_ex_server Property

URL for the FedEx Server where the requests are sent.

Syntax

def get_fed_ex_server() -> str: ...
def set_fed_ex_server(value: str) -> None: ...

fed_ex_server = property(get_fed_ex_server, set_fed_ex_server)

Default Value

""

Remarks

URL for the FedEx Server where the requests are sent. This is required to be provided on each transaction request sent to FedEx along with fed_ex_account_number and fed_ex_meter_number.

The full URL (including the URL scheme normally https://) should be supplied. All test requests are sent over SSL.

The server URL for the production will be provided to you by FedEx after your application has been approved/certified by FedEx Web Integration Solutions team.

Note that FedEx provides both SOAP and XML services and the URLs for each service are slightly different, however the functionality provided is exactly the same. If the URL ends with "/web-services", then the server will use the SOAP services. If the URL ends with "/xml", then the server will use the XML service. When using the SOAP services, the UseSOAP config should be set to true (default). The test URLs for FedEx are as follows: XML https://gatewaybeta.fedex.com:443/xml https://wsbeta.fedex.com:443/xml SOAP https://gatewaybeta.fedex.com:443/web-services https://wsbeta.fedex.com:443/web-services

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. firewall_port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

geographic_coordinates Property

Specifies the geographic coordinates by which nearby FedEx locations are to be found.

Syntax

def get_geographic_coordinates() -> str: ...
def set_geographic_coordinates(value: str) -> None: ...

geographic_coordinates = property(get_geographic_coordinates, set_geographic_coordinates)

Default Value

""

Remarks

This property is optional, unless search_criteria is set to sctGeographicCoordinates.

The latitude and longitude should be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

location_count Property

The number of records in the Location arrays.

Syntax

def get_location_count() -> int: ...
def set_location_count(value: int) -> None: ...

location_count = property(get_location_count, set_location_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• location_accepted_currency
• location_attributes
• location_carrier_count
• location_carrier_effective_latest_dropoff_count
• location_carrier_effective_latest_dropoff_day_of_week
• location_carrier_effective_latest_dropoff_index
• location_carrier_effective_latest_dropoff_time
• location_carrier_exceptional_latest_dropoff_count
• location_carrier_exceptional_latest_dropoff_day_of_week
• location_carrier_exceptional_latest_dropoff_index
• location_carrier_exceptional_latest_dropoff_time
• location_carrier_index
• location_carrier_normal_latest_dropoff_count
• location_carrier_normal_latest_dropoff_day_of_week
• location_carrier_normal_latest_dropoff_index
• location_carrier_normal_latest_dropoff_time
• location_carrier_type
• location_carrier_type_description
• location_city
• location_company_name
• location_country_code
• location_effective_hours_count
• location_effective_hours_day_of_week
• location_effective_hours_description
• location_effective_hours_index
• location_effective_hours_operational_hours
• location_email
• location_entity_id
• location_exceptional_hours_count
• location_exceptional_hours_day_of_week
• location_exceptional_hours_description
• location_exceptional_hours_index
• location_exceptional_hours_operational_hours
• location_fax
• location_geographic_coordinates
• location_holiday_count
• location_holiday_date
• location_holiday_index
• location_holiday_name
• location_id
• location_map_url
• location_normal_hours_count
• location_normal_hours_day_of_week
• location_normal_hours_description
• location_normal_hours_index
• location_normal_hours_operational_hours
• location_person_name
• location_phone
• location_special_instructions
• location_state
• location_store_number
• location_street_address
• location_type
• location_zip_code

The array indices start at 0 and end at location_count - 1.

location_accepted_currency Property

The currency that is accepted at this FedEx location.

Syntax

def get_location_accepted_currency(location_index: int) -> str: ...

Default Value

""

Remarks

The currency that is accepted at this FedEx location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_attributes Property

This specifies what type of services this FedEx location provides.

Syntax

def get_location_attributes(location_index: int) -> int: ...

Default Value

0

Remarks

This specifies what type of services this FedEx location provides. This is populated when find_locations is called.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Value	Meaning
0x00000001 (AcceptsCash)	Whether this location accepts cash
0x00000002 (AlreadyOpen)	Whether this location is already open
0x00000004 (CopyAndPrintServices)	Whether this location offers Copy and Print services
0x00000008 (DangerousGoodsServices)	Whether this location offers dangerous goods services
0x00000010 (DirectMailServices)	Whether this location offers Direct Mail services
0x00000020 (ExpressFreightDropoffs)	Whether this location offers Express freight dropoff services
0x00000040 (ExpressParcelDropoffs)	Whether this location offers Express parcel dropoff services
0x00000080 (FedExFreightDropoffs)	Whether this location offers FedEx Freight dropoff services
0x00000100 (GroundDropoffs)	Whether this location offers Ground dropoff services
0x00000200 (GroundHomeDeliveryDropoffs)	Whether this location offers Ground Home Delivery dropoff services
0x00000400 (LocationIsInAirport)	Whether this location is located in an airport
0x00000800 (NotaryServices)	Whether this location offers Notary services
0x00001000 (ObservesDayLightSavingTimes)	Whether this location observes day light savings time
0x00002000 (OpenTwentyFourHours)	Whether this location is open 24 hours
0x00004000 (PackagingSupplies)	Whether this location offers packaging supplies
0x00008000 (PackAndShip)	Whether this location offers Pack and Ship services
0x00010000 (PassportPhotoServices)	Whether this location offers passport photo services
0x00020000 (ReturnServices)	Whether this location offers return services
0x00040000 (SaturdayDropoffs)	Whether this location offers Saturday dropoff services
0x00080000 (SaturdayExpressHoldAtLocation)	Whether this location offers Saturday Express Hold at Location services
0x00100000 (SignsAndBannersService)	Whether this location offers Signs and Banners services
0x00200000 (SonyPictureStation)	Whether this location has a Sony picture station
0x00400000 (VideoConferencing)	Whether this location offers video conferencing services
0x00800000 (WeekdayExpressHoldAtLocation)	Whether this location offers Weekday Express Hold at Location services
0x01000000 (WeekdayGroundHoldAtLocation)	Whether this location offers Weekday Ground Hold at Location services

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_count Property

This contains the number of Carriers returned for the current location.

Syntax

def get_location_carrier_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the number of Carriers returned for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_effective_latest_dropoff_count Property

This contains the total number of effective latest dropoff times that were returned for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_effective_latest_dropoff_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the total number of effective latest dropoff times that were returned for the carrier specified by location_carrier_index.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_effective_latest_dropoff_day_of_week Property

This contains the day of the week for the current effective latest dropoff.

Syntax

def get_location_carrier_effective_latest_dropoff_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for the current effective latest dropoff. This is populated when location_carrier_normal_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_effective_latest_dropoff_index Property

This specifies the index for the effective latest dropoff time for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_effective_latest_dropoff_index(location_index: int) -> int: ...
def set_location_carrier_effective_latest_dropoff_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the index for the effective latest dropoff time for the carrier specified by location_carrier_index. When location_carrier_index is set, this gets set to 0.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_carrier_effective_latest_dropoff_time Property

This contains the current carrier's effective dropoff time for the specified day.

Syntax

def get_location_carrier_effective_latest_dropoff_time(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the current carrier's effective dropoff time for the specified day. This is populated when location_carrier_effective_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_exceptional_latest_dropoff_count Property

This contains the total number of exceptional latest dropoff times that were returned for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_exceptional_latest_dropoff_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the total number of exceptional latest dropoff times that were returned for the carrier specified by location_carrier_index.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_exceptional_latest_dropoff_day_of_week Property

This contains the day of the week for the current exceptional latest dropoff.

Syntax

def get_location_carrier_exceptional_latest_dropoff_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for the current exceptional latest dropoff. This is populated when location_carrier_exceptional_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_exceptional_latest_dropoff_index Property

This specifies the index for the exceptional latest dropoff time for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_exceptional_latest_dropoff_index(location_index: int) -> int: ...
def set_location_carrier_exceptional_latest_dropoff_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the index for the exceptional latest dropoff time for the carrier specified by location_carrier_index. When location_carrier_index is set, this gets set to 0.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_carrier_exceptional_latest_dropoff_time Property

This contains the current carrier's exceptional dropoff time for the specified day.

Syntax

def get_location_carrier_exceptional_latest_dropoff_time(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the current carrier's exceptional dropoff time for the specified day. This is populated when location_carrier_exceptional_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_index Property

This contains the current index for the array of carriers that were returned for the current location.

Syntax

def get_location_carrier_index(location_index: int) -> int: ...
def set_location_carrier_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This contains the current index for the array of carriers that were returned for the current location.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_carrier_normal_latest_dropoff_count Property

This contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_normal_latest_dropoff_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the total number of normal latest dropoff times that were returned for the carrier specified by location_carrier_index.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_normal_latest_dropoff_day_of_week Property

This contains the day of the week for the current normal latest dropoff.

Syntax

def get_location_carrier_normal_latest_dropoff_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for the current normal latest dropoff. This is populated when location_carrier_normal_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_normal_latest_dropoff_index Property

This specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex .

Syntax

def get_location_carrier_normal_latest_dropoff_index(location_index: int) -> int: ...
def set_location_carrier_normal_latest_dropoff_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the index for the normal latest dropoff time for the carrier specified by location_carrier_index. When location_carrier_index is set, this gets set to 0.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_carrier_normal_latest_dropoff_time Property

This contains the current carrier's normal dropoff time for the specified day.

Syntax

def get_location_carrier_normal_latest_dropoff_time(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the current carrier's normal dropoff time for the specified day. This is populated when location_carrier_normal_latest_dropoff_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_type Property

This contains the type of carrier the current carrier is.

Syntax

def get_location_carrier_type(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the type of carrier the current carrier is. This is populated when location_carrier_index is set.

The possible values are as follows:

Value	Description
lctFDXC (0)	FedEx Cargo
lctFDXE (1)	FedEx Express
lctFDXG (2)	FedEx Ground
lctFXCC (3)	FedEx Custom Critical
lctFXFR (4)	FedEx Freight
lctFXSP (5)	FedEx Smart Post

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_carrier_type_description Property

The textual description of the rfCarrierType;.

Syntax

def get_location_carrier_type_description(location_index: int) -> str: ...

Default Value

""

Remarks

The textual description of the rfCarrierType;. This is populated when location_carrier_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_city Property

Name of the city that the current location is in.

Syntax

def get_location_city(location_index: int) -> str: ...

Default Value

""

Remarks

Name of the city that the current location is in.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_company_name Property

The name of the business at this FedEx location.

Syntax

def get_location_company_name(location_index: int) -> str: ...

Default Value

""

Remarks

The name of the business at this FedEx location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_country_code Property

This contains the country code for the current location.

Syntax

def get_location_country_code(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the country code for the current location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_effective_hours_count Property

This contains the number of effective hours that were returned for the current location.

Syntax

def get_location_effective_hours_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the number of effective hours that were returned for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_effective_hours_day_of_week Property

This contains the day of the week for which the effective hours are being specified.

Syntax

def get_location_effective_hours_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for which the effective hours are being specified. This is populated when location_effective_hours_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_effective_hours_description Property

This contains the description for the effective hours, specified by EffectiveHoursIndex , for the current location.

Syntax

def get_location_effective_hours_description(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the description for the effective hours, specified by location_effective_hours_index, for the current location.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_effective_hours_index Property

This specifies the current index for the array containing the current location's effective hours.

Syntax

def get_location_effective_hours_index(location_index: int) -> int: ...
def set_location_effective_hours_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the current index for the array containing the current location's effective hours.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_effective_hours_operational_hours Property

This contains the time range for the effective hours, specified by EffectiveHoursIndex , that the current location is open.

Syntax

def get_location_effective_hours_operational_hours(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the time range for the effective hours, specified by location_effective_hours_index, that the current location is open.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_email Property

The email address provided for the current location.

Syntax

def get_location_email(location_index: int) -> str: ...

Default Value

""

Remarks

The email address provided for the current location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_entity_id Property

The entity ID for the current location.

Syntax

def get_location_entity_id(location_index: int) -> str: ...

Default Value

""

Remarks

The entity ID for the current location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_exceptional_hours_count Property

This contains the number of exceptional hours that were returned for the current location.

Syntax

def get_location_exceptional_hours_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the number of exceptional hours that were returned for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_exceptional_hours_day_of_week Property

This contains the day of the week for which the exceptional hours are being specified.

Syntax

def get_location_exceptional_hours_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for which the exceptional hours are being specified. This is populated when location_exceptional_hours_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_exceptional_hours_description Property

This contains the description for the exceptional hours, specified by ExceptionalHoursIndex , for the current location.

Syntax

def get_location_exceptional_hours_description(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the description for the exceptional hours, specified by location_exceptional_hours_index, for the current location.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_exceptional_hours_index Property

This specifies the current index for the array containing the current location's exceptional hours.

Syntax

def get_location_exceptional_hours_index(location_index: int) -> int: ...
def set_location_exceptional_hours_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the current index for the array containing the current location's exceptional hours.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_exceptional_hours_operational_hours Property

This contains the time range for the exceptional hours, specified by ExceptionalHoursIndex , that the current location is open.

Syntax

def get_location_exceptional_hours_operational_hours(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the time range for the exceptional hours, specified by location_exceptional_hours_index, that the current location is open.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_fax Property

This contains the fax number for the current location.

Syntax

def get_location_fax(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the fax number for the current location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_geographic_coordinates Property

This contains the geographic coordinates of the current location.

Syntax

def get_location_geographic_coordinates(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the geographic coordinates of the current location. This is populated when find_locations is called.

The latitude and longitude will be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_holiday_count Property

This contains the number of holidays that the current FedEx location observes.

Syntax

def get_location_holiday_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the number of holidays that the current FedEx location observes.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_holiday_date Property

This is the date of the holiday specified by HolidayIndex .

Syntax

def get_location_holiday_date(location_index: int) -> str: ...

Default Value

""

Remarks

This is the date of the holiday specified by location_holiday_index.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_holiday_index Property

This contains the index of the current holiday the FedEx location observes.

Syntax

def get_location_holiday_index(location_index: int) -> int: ...
def set_location_holiday_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This contains the index of the current holiday the FedEx location observes.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_holiday_name Property

This contains the name of the holiday specified by HolidayIndex .

Syntax

def get_location_holiday_name(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the name of the holiday specified by location_holiday_index.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_id Property

Business identifier that can be used by IRV attendant to look directions to this FedEx location.

Syntax

def get_location_id(location_index: int) -> str: ...

Default Value

""

Remarks

Business identifier that can be used by IRV attendant to look directions to this FedEx location. This is populated when find_locations is called.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_map_url Property

This contains the URL to the google map showing the location.

Syntax

def get_location_map_url(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the URL to the google map showing the location.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_normal_hours_count Property

This contains the number of normal hours that were returned for the current location.

Syntax

def get_location_normal_hours_count(location_index: int) -> int: ...

Default Value

0

Remarks

This contains the number of normal hours that were returned for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_normal_hours_day_of_week Property

This contains the day of the week for which the normal hours are being specified.

Syntax

def get_location_normal_hours_day_of_week(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the day of the week for which the normal hours are being specified. This is populated when location_normal_hours_index is set.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_normal_hours_description Property

This contains the description for the normal hours, specified by NormalHoursIndex , that the current location is open.

Syntax

def get_location_normal_hours_description(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the description for the normal hours, specified by location_normal_hours_index, that the current location is open.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_normal_hours_index Property

This specifies the current index for the array containing the current location's normal hours.

Syntax

def get_location_normal_hours_index(location_index: int) -> int: ...
def set_location_normal_hours_index(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

This specifies the current index for the array containing the current location's normal hours.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_normal_hours_operational_hours Property

This contains the time range for the normal hours, specified by NormalHoursIndex , that the current location is open.

Syntax

def get_location_normal_hours_operational_hours(location_index: int) -> str: ...

Default Value

""

Remarks

This contains the time range for the normal hours, specified by location_normal_hours_index, that the current location is open.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_person_name Property

The name of the person listed as the contact for the current location.

Syntax

def get_location_person_name(location_index: int) -> str: ...

Default Value

""

Remarks

The name of the person listed as the contact for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_phone Property

The phone number for the current location.

Syntax

def get_location_phone(location_index: int) -> str: ...

Default Value

""

Remarks

The phone number for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_special_instructions Property

This contains any special instructions provided for the current location.

Syntax

def get_location_special_instructions(location_index: int) -> str: ...

Default Value

""

Remarks

This contains any special instructions provided for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_state Property

State or province code of the current location.

Syntax

def get_location_state(location_index: int) -> str: ...

Default Value

""

Remarks

State or province code of the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_store_number Property

The store number for the current location.

Syntax

def get_location_store_number(location_index: int) -> int: ...

Default Value

0

Remarks

The store number for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_street_address Property

Street address or intersection of this FedEx location.

Syntax

def get_location_street_address(location_index: int) -> str: ...

Default Value

""

Remarks

Street address or intersection of this FedEx location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

location_type Property

The type of this FedEx location.

Syntax

def get_location_type(location_index: int) -> int: ...
def set_location_type(location_index: int, value: int) -> None: ...

Default Value

0

Remarks

The type of this FedEx location. This is populated after a call to find_locations.

Possible values are as follows:

Value	Description
fltAuthorizedShipCenter (0)	Authorized Ship Center
fltExpressStation (1)	Express Station
fltFreightServiceCenter (2)	Freight Service Center
fltGroundTerminal (3)	Ground Terminal
fltHomeDeliveryStation (4)	Home Delivery Station
fltFedExOffice (5)	FedEx Office
fltSelfServiceStation (6)	Self Service Station
fltSmartPostHub (7)	Smart Post Hub

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

location_zip_code Property

The postal code for the current location.

Syntax

def get_location_zip_code(location_index: int) -> str: ...

Default Value

""

Remarks

The postal code for the current location. This is populated after a call to find_locations.

The location_index parameter specifies the index of the item in the array. The size of the array is controlled by the location_count property.

This property is read-only.

match_count Property

The number of records in the Match arrays.

Syntax

def get_match_count() -> int: ...

match_count = property(get_match_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• match_address1
• match_address2
• match_change_type
• match_city
• match_company
• match_country_code
• match_quality
• match_residential_status
• match_state
• match_zip_code

The array indices start at 0 and end at match_count - 1.

This property is read-only.

match_address1 Property

Address line 1 of an address candidate in the list of matches (if any).

Syntax

def get_match_address1(match_idx: int) -> str: ...

Default Value

""

Remarks

Address line 1 of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_address2 Property

Address line 2 of an address candidate in the list of matches (if any).

Syntax

def get_match_address2(match_idx: int) -> str: ...

Default Value

""

Remarks

Address line 2 of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_change_type Property

Changes made to the Address (during validation process) compared to this address candidate.

Syntax

def get_match_change_type(match_idx: int) -> str: ...

Default Value

""

Remarks

Changes made to the address (during validation process) compared to this address candidate. This is a comma-separated string collection. Possible returned values are

• APARTMENT_NUMBER_NOT_FOUND
• APARTMENT_NUMBER_REQUIRED
• NORMALIZED
• REMOVED_DATA
• BOX_NUMBER_REQUIRED
• NO_CHANGES
• MODIFIED_TO_ACHIEVE_MATCH
• STREET_RANGE_MATCH
• BOX_NUMBER_MATCH
• RR_OR_HC_MATCH
• CITY_MATCH
• POSTAL_CODE_MATCH
• RR_OR_HC_BOX_NUMBER_NEEDED
• FORMATTED_FOR_COUNTRY
• APO_OR_FPO_MATCH
• GENERAL_DELIVERY_MATCH
• FIELD_TRUNCATED
• UNABLE_TO_APPEND_NON_ADDRESS_DATA
• INSUFFICIENT_DATA
• HOUSE_OR_BOX_NUMBER_NOT_FOUND
• POSTAL_CODE_NOT_FOUND
• INVALID_COUNTRY
• SERVICE_UNAVAILABLE_FOR_ADDRESS

This is only valid for FedEx.

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_city Property

City name of an address candidate in the list of matches (if any).

Syntax

def get_match_city(match_idx: int) -> str: ...

Default Value

""

Remarks

City name of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_company Property

Name of the company that resides at an address candidate in the list of matches (if any).

Syntax

def get_match_company(match_idx: int) -> str: ...

Default Value

""

Remarks

Name of the company that resides at an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_country_code Property

Country code of an address candidate in the list of matches (if any).

Syntax

def get_match_country_code(match_idx: int) -> str: ...

Default Value

""

Remarks

Country code of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_quality Property

Quality factor an address candidate in the list of matches (if any).

Syntax

def get_match_quality(match_idx: int) -> str: ...

Default Value

""

Remarks

Quality factor an address candidate in the list of matches (if any).

Each address is returned with an assigned quality value that indicates how closely the address candidate matches the search criteria. This is used to rate the submitted address. If the match_quality is too low, the class returns the "Address Not Validated" message.

In FedEx, possible values range from 0 to 100, with 100 being the highest and zero indicating failure.

In UPS, this is applicable for a non street-level address validation and/or classification (i.e., when the address1 is not set in the request). Possible values are:

Value	Meaning
1.0	Exact Match - The input address matches an address in the Address Matching Systems database; under the condition where the Address Matching System is able to explicitly differentiate an address from all others in the database.
.95-.99	Very close match
.90-.94	Close match
.70-.89	Possible match
.01-.69	Poor match
0	No candidates found. The Address Matching System is not able to match the address from any other one in the database.

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_residential_status Property

Residential status of an address candidate in the list of matches (if any).

Syntax

def get_match_residential_status(match_idx: int) -> str: ...

Default Value

""

Remarks

Residential status of an address candidate in the list of matches (if any). Possible returned values are:

• UNDETERMINED
• BUSINESS
• RESIDENTIAL
• INSUFFICIENT_DATA
• UNAVAILABLE
• UNKNOWN
• NOT_APPLICABLE_TO_COUNTRY

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_state Property

State or province code of an address candidate in the list of matches (if any).

Syntax

def get_match_state(match_idx: int) -> str: ...

Default Value

""

Remarks

State or province code of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

match_zip_code Property

Postal Code of an address candidate in the list of matches (if any).

Syntax

def get_match_zip_code(match_idx: int) -> str: ...

Default Value

""

Remarks

Postal Code of an address candidate in the list of matches (if any).

This may be returned in the server response when the validate_address method is called and if the connection to the server is successful (no errors returned).

The match_idx parameter specifies the index of the item in the array. The size of the array is controlled by the match_count property.

This property is read-only.

phone Property

Phone number for which nearby FedEx locations are to be found.

Syntax

def get_phone() -> str: ...
def set_phone(value: str) -> None: ...

phone = property(get_phone, set_phone)

Default Value

""

Remarks

This property is optional, unless search_criteria is set to sctPhoneNumber.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)	Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

search_criteria Property

The criteria to be used to find FedEx Locations.

Syntax

def get_search_criteria() -> int: ...
def set_search_criteria(value: int) -> None: ...

search_criteria = property(get_search_criteria, set_search_criteria)

Default Value

0

Remarks

This specifies what criteria is to be used to search for FedEx locations when find_locations is called.

If sctAddress is specified, the address, must be set. Likewise, if sctGeographicCoordinates is specified, geographic_coordinates must be set and if sctPhoneNumber is specified phone_number must be set.

sort_criteria Property

The criteria to be used to sort the results.

Syntax

def get_sort_criteria() -> int: ...
def set_sort_criteria(value: int) -> None: ...

sort_criteria = property(get_sort_criteria, set_sort_criteria)

Default Value

0

Remarks

This specifies what criteria will be used to sort the results that are returned from FedEx when find_locations is called.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

total_locations_found Property

Specifies the total number of locations found.

Syntax

def get_total_locations_found() -> int: ...
def set_total_locations_found(value: int) -> None: ...

total_locations_found = property(get_total_locations_found, set_total_locations_found)

Default Value

0

Remarks

This specifies the total number of locations found based on the criteria provided when find_locations is called.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

find_locations Method

Finds FedEx location(s) based on the input data.

Syntax

def find_locations() -> None: ...

Remarks

FedEx drop-off locations can be searched by phone number or address. On each request, the following properties can be passed in the request (the optional ones are used to narrow down the search and the conditional ones depend on other property values):

• fed_ex_server (required)
• fed_ex_developer_key (required)
• fed_ex_password (required)
• fed_ex_account_number (required)
• fed_ex_meter_number (required)
• phone (required if searched by phone number)
• address (required if searched by address)
• constraint_location_type_flags (optional)

If there are any locations returned, the following properties will be filled:

• Location*

reset Method

Resets the internal state of the class and all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

The Reset method does not have any parameters and does not return any value.

validate_address Method

Returns corrected and standardized address information.

Syntax

def validate_address() -> None: ...

Remarks

This method is used to verify and correct the address specified by the address. Any of the following input combinations are valid:

• city, state and zip_code
• city
• zip_code
• city and state
• city and zip_code
• state and zip_code

on_error Event

Information about errors during data delivery.

Syntax

class FedExAddressErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class FedExAddress:
@property
def on_error() -> Callable[[FedExAddressErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FedExAddressErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_notification Event

Notification returned by the server upon successful request (if applicable).

Syntax

class FedExAddressNotificationEventParams(object):
  @property
  def message() -> str: ...

# In class FedExAddress:
@property
def on_notification() -> Callable[[FedExAddressNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[FedExAddressNotificationEventParams], None]) -> None: ...

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the on_notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class FedExAddressSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class FedExAddress:
@property
def on_ssl_server_authentication() -> Callable[[FedExAddressSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[FedExAddressSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class FedExAddressSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class FedExAddress:
@property
def on_ssl_status() -> Callable[[FedExAddressSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[FedExAddressSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

FedExAddress Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

FedExAddress Config Settings

CSPProductId:   Identifies the CSP product. This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the fed_ex_account_number, fed_ex_meter_number and CSPProductVersion.

CSPProductVersion:   Identifies the CSP product version. This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the fed_ex_account_number, fed_ex_meter_number and CSPProductId.

CSPUserKey:   CSP end user key. This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user. This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (fed_ex_developer_key and fed_ex_password respectively).

CSPUserPassword:   CSP end user password. This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user. This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (fed_ex_developer_key and fed_ex_password respectively).

CustomContent:   Defines any custom content to print on the label. FedEx allows you to add customizable content on select label types. FedEx requires that the customizable graphic or text must not exceed 1-1/2 inches high and 4-1/2 inches wide. You must insert the XML necessary to display your graphic or text. For example if you wanted to add some custom text to the label you would do something like this: string customContent = "CustomContent=<CustomContent><TextEntries><Position><X>150</X><Y>70</Y></Position><Format>My text here</Format><ThermalFontId>2</ThermalFontId></TextEntries></CustomContent>" When using the CustomContent, the LabelStockType must be either 4 (Stock 4x8) or 5 (Stock 4x9 Leading Doc Tab). Also LabelFormatType must be 0 (Common2D) and label_image_type must 2 (fitEltron), 3 (fitZebra) or 4 (fitUniMark).

CustomerTransactionId:   Customer transaction id. This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies. Maximum of 40 characters.

EstimateDelivery:   Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day. If True (default), the class will attempt to estimate Transit Time, Delivery Date, and/or Delivery Day based on what information came back in the response. This does not account for non-business days, holidays, or weekend delivery and should be treated accordingly. If False, the class will not estimate Transit Time, Delivery Date, and/or Delivery Day. Instead it will ONLY use the values returned in the response from FedEx. If a property is empty, it means that FedEx did not return this information.

HasXPath:   Determines whether a specific element exists in the document. This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath. This method returns True if the XPath exists, False if not.

RawRequest:   Contains the complete request sent to the Server. This returns the complete request as sent to the server. Used for debugging purposes.

RawResponse:   Contains the complete response returned by the Server. This returns the complete response as received from the server. Used for debugging purposes.

UseSOAP:   Determines if the FedEx SOAP web services are used instead of the FedEx XML web services. If True (default), the class will use the FedEx SOAP based web services. When using the SOAP based web services the fed_ex_server should end in "web-services". For instance: "https://gatewaybeta.fedex.com:443/web-services". If False, the class will use the FedEx XML based web services. When using the XML based web services the fed_ex_server should end in "xml". For instance: "https://gatewaybeta.fedex.com:443/xml".

Warning:   Warning message returned by the server. This might be returned by the server even upon successful response. These warnings are usually informational.

XAttrCount:   The number of records in the XAttr arrays. This property controls the size of the following arrays: XAttrElement[i] XAttrText[i]

XAttrName[i]:   The name of the indexed attribute. The size of the array is controlled by XAttrCount.

XAttrValue[i]:   The value of the indexed attribute. The size of the array is controlled by XAttrCount.

XChildCount:   The number of records in the XChild arrays. This property controls the size of the following arrays: XChildElement[i] XChildText[i]

XChildElement[i]:   The name of the indexed child element. The size of the array is controlled by XChildCount.

XChildText[i]:   The text of the indexed child element. The size of the array is controlled by XChildCount.

XElement:   The name of the current element. The current element is specified via the XPath.

XParent:   The parent of the current element. The current element is specified via the XPath.

XPath:   Used to set the XPath within the response from the server. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the RawResponse. XPath is 1-indexed. The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. The following are possible values for an element accessor: 'name' A particular element name name[i] The i-th subelement of the current element with the given name [i] The i-th subelement of the current element [last()] The last subelement of the current element [last()-i] The subelement located at the last location minus i in the current element name[@attrname="attrvalue"] The subelement containing a particular value for a given attribute (supports single AND double quotes) .. The parent of the current element When XPath is set to a valid path... XElement points to the name of the element. XText points to the text of the element. XParent points to the name of the parent element. XChildCount provides the number of child elements. XChildElement[i] points to the name of the indexed child element. XChildText[i] points to the text of the indexed child element. XAttrCount provides the number of attributes for this element. XAttrName[i] points to the name of the indexed attribute for XElement. XAttrValue[i] points to the value of the indexed attribute for XElement.

XText:   The text of the current element. The current element is specified via the XPath.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports. When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data. This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2. The default value is True.

Append:   Whether to append data to LocalFile. This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

Authorization:   The Authorization string to be sent to the server. If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data. This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding. This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request. If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class. If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect. This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error. Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead. Following are the valid options: 0 - Never 1 - Always 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location. The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing. HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class. This property specifies the HTTP version used by the class. Possible values are as follows: "1.0" "1.1" (default) "2.0" "3.0" When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details. HTTP/2 Notes When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed. HTTP/3 Notes HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document. If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request. If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received. The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller. If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged. This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows: 0 (None) No events are logged. 1 (Info - default) Informational events are logged. 2 (Verbose) Detailed data are logged. 3 (Debug) Debug data are logged. The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request. When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version. This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional). This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server. This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy. This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy. This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80). This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional). This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy. This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client. This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server. This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server. This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class. If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server. This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client. This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers. If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names. This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client. When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection. This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True. When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser). This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection. When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available. This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting. If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;. The FirewallPort is set automatically when FirewallType is set to a valid value. Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through. The appropriate values are as follows: 0 No firewall (default setting). 1 Connect through a tunneling proxy. FirewallPort is set to 80. 2 Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. 3 Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. 10 Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error. Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent. When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully. This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted. The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address. In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds. This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found. MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset. If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second. This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy. This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled. If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets. Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets. When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this config is set to false.

UseIPv6:   Whether to use IPv6. When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are: 0 IPv4 Only 1 IPv6 Only 2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API. When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes. When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates. This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application. This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL. This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG). This functionality is available only when the provider is OpenSSL. By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused. If set to true, the class will reuse the context if and only if the following criteria are met: The target host name is the same. The system cache entry has not expired (default timeout is 10 hours). The application process that calls the function is the same. The logon session is the same. The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux. This setting specifies the paths on disk to CA certificate files on Unix/Linux. The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is: /etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication. This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate. This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate. This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption. This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation. The enabled cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include: CALG_3DES CALG_3DES_112 CALG_AES CALG_AES_128 CALG_AES_192 CALG_AES_256 CALG_AGREEDKEY_ANY CALG_CYLINK_MEK CALG_DES CALG_DESX CALG_DH_EPHEM CALG_DH_SF CALG_DSS_SIGN CALG_ECDH CALG_ECDH_EPHEM CALG_ECDSA CALG_ECMQV CALG_HASH_REPLACE_OWF CALG_HUGHES_MD5 CALG_HMAC CALG_KEA_KEYX CALG_MAC CALG_MD2 CALG_MD4 CALG_MD5 CALG_NO_SIGN CALG_OID_INFO_CNG_ONLY CALG_OID_INFO_PARAMETERS CALG_PCT1_MASTER CALG_RC2 CALG_RC4 CALG_RC5 CALG_RSA_KEYX CALG_RSA_SIGN CALG_SCHANNEL_ENC_KEY CALG_SCHANNEL_MAC_KEY CALG_SCHANNEL_MASTER_HASH CALG_SEAL CALG_SHA CALG_SHA1 CALG_SHA_256 CALG_SHA_384 CALG_SHA_512 CALG_SKIPJACK CALG_SSL2_MASTER CALG_SSL3_MASTER CALG_SSL3_SHAMD5 CALG_TEK CALG_TLS1_MASTER CALG_TLS1PRF Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended) TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended) TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_RSA_WITH_AES_256_CBC_SHA TLS_DHE_DSS_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_DSS_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_DES_CBC_SHA TLS_DHE_RSA_WITH_DES_CBC_SHA TLS_DHE_DSS_WITH_DES_CBC_SHA TLS_RSA_WITH_RC4_128_MD5 TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols. Used to enable/disable the supported security protocols. Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values: TLS1.3 12288 (Hex 3000) TLS1.2 3072 (Hex C00) (Default) TLS1.1 768 (Hex 300) (Default) TLS1 192 (Hex C0) (Default) SSL3 48 (Hex 30) SSL2 12 (Hex 0C) SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions. In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes: The platform provider is only available on Windows 11 / Windows Server 2022 and up. SSLEnabledCipherSuites and other similar SSL configuration settings are not supported. If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported. This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension. This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event. This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event. If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes. This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake represented as a single string. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm. Returns the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength. Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version. Returns the protocol version negotiated during the SSL handshake. Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions: 0x00000001 Ignore time validity status of certificate. 0x00000002 Ignore time validity status of CTL. 0x00000004 Ignore non-nested certificate times. 0x00000010 Allow unknown Certificate Authority. 0x00000020 Ignore wrong certificate usage. 0x00000100 Ignore unknown certificate revocation status. 0x00000200 Ignore unknown CTL signer revocation status. 0x00000400 Ignore unknown Certificate Authority revocation status. 0x00000800 Ignore unknown Root revocation status. 0x00008000 Allow test Root certificate. 0x00004000 Trust test Root certificate. 0x80000000 Ignore non-matching CN (certificate CN not-matching server name). This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation. This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa. In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC. This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC. The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported: "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" "ffdhe_6144" "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms. This setting holds a comma separated list of allowed signature algorithms. Possible values are: "ed25519" (default) "ed448" (default) "ecdsa_secp256r1_sha256" (default) "ecdsa_secp384r1_sha384" (default) "ecdsa_secp521r1_sha512" (default) "rsa_pkcs1_sha256" (default) "rsa_pkcs1_sha384" (default) "rsa_pkcs1_sha512" (default) "rsa_pss_sha256" (default) "rsa_pss_sha384" (default) "rsa_pss_sha512" (default) The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange. This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported: "ecdhe_x25519" (default) "ecdhe_x448" (default) "ecdhe_secp256r1" (default) "ecdhe_secp384r1" (default) "ecdhe_secp521r1" (default) "ffdhe_2048" (default) "ffdhe_3072" (default) "ffdhe_4096" (default) "ffdhe_6144" (default) "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts. If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall. When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket. This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build. When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations. The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: Identifier Name 037 IBM EBCDIC - U.S./Canada 437 OEM - United States 500 IBM EBCDIC - International 708 Arabic - ASMO 708 709 Arabic - ASMO 449+, BCON V4 710 Arabic - Transparent Arabic 720 Arabic - Transparent ASMO 737 OEM - Greek (formerly 437G) 775 OEM - Baltic 850 OEM - Multilingual Latin I 852 OEM - Latin II 855 OEM - Cyrillic (primarily Russian) 857 OEM - Turkish 858 OEM - Multilingual Latin I + Euro symbol 860 OEM - Portuguese 861 OEM - Icelandic 862 OEM - Hebrew 863 OEM - Canadian-French 864 OEM - Arabic 865 OEM - Nordic 866 OEM - Russian 869 OEM - Modern Greek 870 IBM EBCDIC - Multilingual/ROECE (Latin-2) 874 ANSI/OEM - Thai (same as 28605, ISO 8859-15) 875 IBM EBCDIC - Modern Greek 932 ANSI/OEM - Japanese, Shift-JIS 936 ANSI/OEM - Simplified Chinese (PRC, Singapore) 949 ANSI/OEM - Korean (Unified Hangul Code) 950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) 1026 IBM EBCDIC - Turkish (Latin-5) 1047 IBM EBCDIC - Latin 1/Open System 1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol) 1141 IBM EBCDIC - Germany (20273 + Euro symbol) 1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) 1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) 1144 IBM EBCDIC - Italy (20280 + Euro symbol) 1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) 1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol) 1147 IBM EBCDIC - France (20297 + Euro symbol) 1148 IBM EBCDIC - International (500 + Euro symbol) 1149 IBM EBCDIC - Icelandic (20871 + Euro symbol) 1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646) 1201 Unicode UCS-2 Big-Endian 1250 ANSI - Central European 1251 ANSI - Cyrillic 1252 ANSI - Latin I 1253 ANSI - Greek 1254 ANSI - Turkish 1255 ANSI - Hebrew 1256 ANSI - Arabic 1257 ANSI - Baltic 1258 ANSI/OEM - Vietnamese 1361 Korean (Johab) 10000 MAC - Roman 10001 MAC - Japanese 10002 MAC - Traditional Chinese (Big5) 10003 MAC - Korean 10004 MAC - Arabic 10005 MAC - Hebrew 10006 MAC - Greek I 10007 MAC - Cyrillic 10008 MAC - Simplified Chinese (GB 2312) 10010 MAC - Romania 10017 MAC - Ukraine 10021 MAC - Thai 10029 MAC - Latin II 10079 MAC - Icelandic 10081 MAC - Turkish 10082 MAC - Croatia 12000 Unicode UCS-4 Little-Endian 12001 Unicode UCS-4 Big-Endian 20000 CNS - Taiwan 20001 TCA - Taiwan 20002 Eten - Taiwan 20003 IBM5550 - Taiwan 20004 TeleText - Taiwan 20005 Wang - Taiwan 20105 IA5 IRV International Alphabet No. 5 (7-bit) 20106 IA5 German (7-bit) 20107 IA5 Swedish (7-bit) 20108 IA5 Norwegian (7-bit) 20127 US-ASCII (7-bit) 20261 T.61 20269 ISO 6937 Non-Spacing Accent 20273 IBM EBCDIC - Germany 20277 IBM EBCDIC - Denmark/Norway 20278 IBM EBCDIC - Finland/Sweden 20280 IBM EBCDIC - Italy 20284 IBM EBCDIC - Latin America/Spain 20285 IBM EBCDIC - United Kingdom 20290 IBM EBCDIC - Japanese Katakana Extended 20297 IBM EBCDIC - France 20420 IBM EBCDIC - Arabic 20423 IBM EBCDIC - Greek 20424 IBM EBCDIC - Hebrew 20833 IBM EBCDIC - Korean Extended 20838 IBM EBCDIC - Thai 20866 Russian - KOI8-R 20871 IBM EBCDIC - Icelandic 20880 IBM EBCDIC - Cyrillic (Russian) 20905 IBM EBCDIC - Turkish 20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) 20932 JIS X 0208-1990 & 0121-1990 20936 Simplified Chinese (GB2312) 21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian) 21027 Extended Alpha Lowercase 21866 Ukrainian (KOI8-U) 28591 ISO 8859-1 Latin I 28592 ISO 8859-2 Central Europe 28593 ISO 8859-3 Latin 3 28594 ISO 8859-4 Baltic 28595 ISO 8859-5 Cyrillic 28596 ISO 8859-6 Arabic 28597 ISO 8859-7 Greek 28598 ISO 8859-8 Hebrew 28599 ISO 8859-9 Latin 5 28605 ISO 8859-15 Latin 9 29001 Europa 3 38598 ISO 8859-8 Hebrew 50220 ISO 2022 Japanese with no halfwidth Katakana 50221 ISO 2022 Japanese with halfwidth Katakana 50222 ISO 2022 Japanese JIS X 0201-1989 50225 ISO 2022 Korean 50227 ISO 2022 Simplified Chinese 50229 ISO 2022 Traditional Chinese 50930 Japanese (Katakana) Extended 50931 US/Canada and Japanese 50933 Korean Extended and Korean 50935 Simplified Chinese Extended and Simplified Chinese 50936 Simplified Chinese 50937 US/Canada and Traditional Chinese 50939 Japanese (Latin) Extended and Japanese 51932 EUC - Japanese 51936 EUC - Simplified Chinese 51949 EUC - Korean 51950 EUC - Traditional Chinese 52936 HZ-GB2312 Simplified Chinese 54936 Windows XP: GB18030 Simplified Chinese (4 Byte) 57002 ISCII Devanagari 57003 ISCII Bengali 57004 ISCII Tamil 57005 ISCII Telugu 57006 ISCII Assamese 57007 ISCII Oriya 57008 ISCII Kannada 57009 ISCII Malayalam 57010 ISCII Gujarati 57011 ISCII Punjabi 65000 Unicode UTF-7 65001 Unicode UTF-8 The following is a list of valid code page identifiers for Mac OS only: Identifier Name 1 ASCII 2 NEXTSTEP 3 JapaneseEUC 4 UTF8 5 ISOLatin1 6 Symbol 7 NonLossyASCII 8 ShiftJIS 9 ISOLatin2 10 Unicode 11 WindowsCP1251 12 WindowsCP1252 13 WindowsCP1253 14 WindowsCP1254 15 WindowsCP1250 21 ISO2022JP 30 MacOSRoman 10 UTF16String 0x90000100 UTF16BigEndian 0x94000100 UTF16LittleEndian 0x8c000100 UTF32String 0x98000100 UTF32BigEndian 0x9c000100 UTF32LittleEndian 65536 Proprietary

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server). Last Valid Build: The last valid build number for which the license will work.

MaskSensitive:   Whether sensitive data is masked in log messages. In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True. This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle. If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

FedExAddress Errors

FedExAddress Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.

The class may also return one of the following error codes, which are inherited from other classes.

SOAP Errors

	169   Invalid param index (out of range).
	170   Invalid namespace index (out of range).
	171   method not found. Please specify a valid method.
	172   No method URI. Please specify a valid method_uri.
	173   SOAP Fault. See fault_code and/or fault_string for details.

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in url
	153   Specified url_scheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

	100   You cannot change the remote_port at this time. A connection is in progress.
	101   You cannot change the remote_host (Server) at this time. A connection is in progress.
	102   The remote_host address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the local_port at this time. A connection is in progress.
	107   You cannot change the local_host at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   remote_port cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid xpath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set build_dom to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.