EzRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides domestic or international rates based on weight, service, and origin/destination information.

Syntax

EzRates

Remarks

The EzRates class provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the class that is specific to the carrier.

When providing origin, destination information, weight, and service, this class allows a user to obtain a rate quote for a specific service, or a list of available services with the respective rate quotes.

You can send a rate request by calling the GetRates method for:

• a specific service (when RequestedService is specified). In this case, the class will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.
• all available services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination.

When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.

Rating for a Multiple Package Shipment (MPS) is available for FedEx and UPS, but not USPS.

Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.

To use this class, you must set the appropriate Account settings for the specified Provider.

Canada Post Setup and Required Properties

When retrieving rates via Canada Post, the following fields are required:

UserId	The login username for your Canada Post account.
Password	The login password for your Canada Post account.
AccountNumber	The customer number of the owner of the mail (mailed on behalf of customer).
SenderZipCode	Postal Code from which the parcel will be sent.
RecipientCountryCode	The destination country code.
RecipientZipCode	The destination Postal Code. Required when shipping to CA or US. Not required for all other international shipments.
PackageWeight	The weight of the parcel in kilograms (e.g. 99.999).

You can optionally set the following fields when requesting rates:

PackageLength	Longest dimension (3.1 digits e.g. 999.9 pattern).
PackageWidth	Second longest dimension (3.1 digits e.g. 999.9 pattern).
PackageHeight	Shortest dimension (3.1 digits e.g. 999.9 pattern).
PackageType	Specify a specific packaging type (when applicable).
RequestedService	A specific service to be rated. If no instances of service-code are included in the request, all services applicable to the shipment and destination will be rated and returned.

Note: Rates will only be retrieved for the first package within Packages, as multiple package shipments are not supported.

After a successful GetRates call, the following fields will be populated:

ServiceAccountBaseCharge	Base cost of the shipment before taxes (numeric 99999.99).
ServiceAccountNetCharge	Total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.
ServiceAccountTotalDiscount	Total amount of discounts.
ServiceAccountTotalSurcharge	Total amount of surcharges.
ServiceType	Service type for the mail service being quoted.
ServiceTypeDescription	Service name in preferred language.
ServiceTransitTime	Indicates the number of days from drop-off or pickup to 1st delivery attempt.
ServiceDeliveryDate	The estimated date of delivery, starting from the expected mailing-date.
ServiceGuaranteedDescription	Indicates if the delivery date is guaranteed ("true" or "false").
CanadaGstAmount	Goods and services tax (numeric 99999.99).
CanadaPstAmount	Provincial sales tax (numeric 99999.99).
CanadaHstAmount	Harmonized sales tax (numeric 99999.99).

Note: Contract based rate quotes are also supported by setting CanadaContractId to your Canada Post Contract ID prior to calling GetRates.

The Canada Post URLS are:

Test (Development)	https://ct.soa-gw.canadapost.ca
Production	https://soa-gw.canadapost.ca

Property List

---

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

AccessKey	An identifier required to connect to UPS.
AccountNumber	The shipper's account number.
DeveloperKey	Identifying part of the authentication key used for the sender's identity.
MeterNumber	Meter number to use for submitting requests to the FedEx Server .
Password	Password for logging in to the Server .
Server	URL for the server where the requests are sent.
UserId	User Id for logging in to the Server .
FirewallAutoDetect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
PackageCount	The number of records in the Package arrays.
PackageGirth	Measurement around the widest part of the package, perpendicular to the Length .
PackageHeight	The height of the package to be shipped.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageType	The packaging type of the package being rated and/or shipped.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageSize	Size of the package being mailed.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
Provider	Which provider to use.
ProxyAuthScheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1	Street name.
RecipientAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlags	Various flags that denote information about the address.
RecipientCity	Name of city, town, etc.
RecipientCountryCode	Country code.
RecipientState	State or province code.
RecipientZipCode	Postal code.
RequestedService	Service type for which the shipping rate is requested.
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderAddressFlags	Various flags that denote information about the address.
SenderCity	Name of city, town, etc.
SenderCountryCode	Country code.
SenderState	State or province code.
SenderZipCode	Postal code.
ServiceCount	The number of records in the Service arrays.
ServiceAccountBaseCharge	Transportation charges before surcharges and discounts applied to a ServiceType .
ServiceAccountNetCharge	Net charge amount applied to a ServiceType .
ServiceAccountTotalDiscount	Total discount amount applied to the shipment for a ServiceType .
ServiceAccountTotalSurcharge	Total surcharge amount for all additional services applied to a ServiceType .
ServiceAggregate	Aggregate of details and rates for the ServiceType in the list of available services.
ServiceBusinessDays	Number of business days from origin to destination location.
ServiceCommitments	Service commitments for the PackagingType when shipping to CountryCode .
ServiceCustomerCenterCutoff	Time the UPS Customer Service Center closes.
ServiceDeliveryDate	This indicates the shipment delivery date for the ServiceType .
ServiceEffectiveNetDiscount	Indicates the net discount applied to a ServiceType .
ServiceListBaseCharge	Transportation charges before surcharges and discounts applied to a ServiceType .
ServiceListNetCharge	Net charge amount applied to a ServiceType .
ServiceListTotalDiscount	Total discount amount applied to a ServiceType .
ServiceListTotalSurcharge	Total surcharge amount for all additional services applied to a ServiceType .
ServiceMaxDimensions	Maximum dimensions of a package allowed when sending to the CountryCode .
ServiceMaxWeight	Maximum weight of package allowed when sending to the CountryCode .
ServiceRateScale	Applicable rate scale for the ServiceType .
ServiceRateZone	Applicable rate zone for the ServiceType .
ServiceType	Indicates the service type in the list of available services returned.
ServiceTypeDescription	Indicates the textual description of a service type in the list of available services returned.
ServiceShipTime	Time UPS picks up the package from the origin.
ServiceSignatureType	Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType .
ServiceTransitTime	Expected number of days in transit from pickup to delivery for the ServiceType .
ShipmentSpecialServices	Contains the collection of special services offered.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
Timeout	A timeout for the class.
TotalWeight	Total shipment's weight.

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.
GetRates	Returns rate information for a specified or all available services.
Reset	Resets the internal state of the class and all properties to their default values.

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.

Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	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.

CanadaContractId	The Contract Id of a Canada Post account used to identify a commercial contract.
CanadaGstAmount[i]	The amount of Goods and Services Tax (GST) for the service, specified by 'i', when using Canada Post.
CanadaHstAmount[i]	The amount of Harmonized Sales Tax (HST) for the service, specified by 'i', when using Canada Post.
CanadaPstAmount[i]	The amount of Provincial Sales Tax (PST) for the service, specified by 'i', when using Canada Post.
CSPProductId	Identifies the CSP product.
CSPProductVersion	Identifies the CSP product version.
CSPUserKey	CSP end user key.
CSPUserPassword	CSP end user password.
EndiciaInsuranceType	The Insurance type when using Endicia.
EndiciaInsuredMail	Used to request Endicia mailpiece insurance.
EndiciaTestMode	Controls whether requests are test requests or live requests.
HasXPath	Determines whether a specific element exists in the document.
PostageProvider	The postage provider to use.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
TotalWeight	The total weight of the shipment.
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.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
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.
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.

AccessKey Property (EzRates Class)

An identifier required to connect to UPS.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

An identifier required to connect to UPS. A UserId, Password and AccessKey will be required for each request sent to UPS.

This property is only applicable to UPS accounts.

This Access Key is provided to you by UPS. For this, please visit http://www.ups.com/e_comm_access/gettools_index?loc=en_US and follow the steps as instructed on that page.

Please read the instructions carefully. You should register first, and after reviewing and accepting the UPS User Agreement, you should submit a request for an UPS OnLine Tools Developer's Key. After the request has been submitted, your Developer's Key will be emailed to the email address you provided to UPS during registration process.

After obtaining the Developer's Key, you can then submit a request for the Access License Key (for XML tools). This will also be sent to you via email. Please save it as it is required to be used with all requests sent to any UPS server (via our class which utilizes UPS Online Tools). An Access Key provides access to UPS systems, which hold the information you or your customers need to ship, track, or rate a package. Your Developer's Key lets you get UPS OnLine Tool documentation; the Access Key lets you actually implement UPS OnLine Tools.

You need only one Access Key for access to all UPS OnLine Tools. However, if multiple locations or departments will be accessing the Tools, a great way to monitor and assess usage is to have an Access Key per location. UPS recommends each site implementation of your EC (E-Commerce) solution have separate Access Keys. An example would be a company that is implementing the Tools into three parts of their organization in three different cities. In this case, it is recommended that you obtain three separate Access Keys to uniquely identify each site.

If you have Production access for an API, you can still access the Test environment. If you have Test access for one or more APIs, you must Request Production Access in order to use those APIs for production requests.

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. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement.

Data Type

String

AccountNumber Property (EzRates Class)

The shipper's account number.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

The shipper's account number.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

Data Type

String

DeveloperKey Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

The DeveloperKey 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 DeveloperKey, AccountNumber, MeterNumber, and 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.

This property is only applicable to FedEx servers.

Data Type

String

MeterNumber Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

An AccountNumber and MeterNumber 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.

This property is only applicable to FedEx servers.

Data Type

String

Password Property (EzRates Class)

Password for logging in to the Server .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Password for logging in to the Server.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the login password for your Canada Post account.

Data Type

String

Server Property (EzRates Class)

URL for the server where the requests are sent.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

URL for the server where the requests are sent.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

Data Type

String

UserId Property (EzRates Class)

User Id for logging in to the Server .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

User Id for logging in to the Server.

This property is not used by FedEx.

For Canada Post, this field should be set to the login username for your Canada Post account

Data Type

String

FirewallAutoDetect Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (EzRates Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Data Type

Integer

FirewallHost Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a 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.

Data Type

String

FirewallPassword Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

PackageCount Property (EzRates Class)

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageGirth
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageSignatureType
• PackageSize
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageGirth Property (EzRates Class)

Measurement around the widest part of the package, perpendicular to the Length .

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

Measurement around the widest part of the package, perpendicular to the PackageLength.

This property is only applicable when requesting rates for USPS packages.

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageHeight Property (EzRates Class)

The height of the package to be shipped.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageInsuredValue Property (EzRates Class)

Amount of insurance requested for this package.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageLength Property (EzRates Class)

The length of the package to be shipped.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageType Property (EzRates Class)

The packaging type of the package being rated and/or shipped.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

Value	FedEx	UPS	USPS	USPS (Endicia)	USPS (Stamps.com)	Canada Post
ptNone (0)		X	X			X
ptPostcards (1)			X	X	X
ptLetter (2)	X	X		X	X
ptLargeEnvelope (3)			X	X	X
ptFlatRateEnvelope (4)			X	X	X
ptFlatRateLegalEnvelope (5)			X	X	X
ptFlatRatePaddedEnvelope (6)			X	X	X
ptFlatRateGiftCardEnvelope (7)			X	X
ptFlatRateWindowEnvelope (8)			X	X
ptFlatRateCardboardEnvelope (9)				X
ptSmallFlatRateEnvelope (10)			X	X
ptPak (11)	X	X
ptBox (12)	X	X
pt10kgBox (13)	X	X
pt25kgBox (14)	X	X
ptSmallExpressBox (15)		X
ptMediumExpressBox (16)		X
ptLargeExpressBox (17)		X
ptFlatRateBox (18)			X		X
ptSmallFlatRateBox (19)			X	X	X
ptMediumFlatRateBox (20)			X	X	X
ptLargeFlatRateBox (21)			X	X	X
ptDVDFlatRateBox (22)				X
ptLargeVideoFlatRateBox (23)				X
ptRegionalRateBoxA (24)			X	X	X
ptRegionalRateBoxB (25)			X	X	X
ptRectangular (26)			X
ptNonRectangular (27)			X
ptTube (28)	X	X				X
ptMatterForTheBlind (29)			X
ptPallet (30)		X
ptYourPackaging (31)	X	X	X	X	X	X
ptDocument (32)						X
ptFlats (33)		X
ptParcels (34)		X
ptBPM (35)		X
ptFirstClass (36)		X
ptPriority (37)		X
ptMachinables (38)		X
ptIrregulars (39)		X
ptParcelPost (40)		X
ptBPMParcel (41)		X
ptMediaMail (42)		X
ptBPMFlat (43)		X
ptStandardFlat (44)		X
ptRegionalRateBoxC (45)			X	X	X
ptThickEnvelope (46)			X	X	X
ptSmallBox (47)	X
ptMediumBox (48)	X
ptLargeBox (49)	X
ptExtraLargeBox (50)	X
ptPackageService (51)			X
ptCubicParcels (52)			X
ptCubicSoftPack (53)			X

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0), except for with FedEx, in which case it will default to ptLetter (2).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

ServiceType	PackagePackagingType	PackageWeight
stFirstClass (35)	ptFirstClass (36)	1 to 13 OZS
stPriorityMail (36)	ptPriority (37)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptMachinables (38)	6 to <16 OZS
stExpeditedMailInnovations (37)	ptIrregulars (39)	1 to <16 OZS
stExpeditedMailInnovations (37)	ptParcelPost (40)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMParcel (41)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptMediaMail (42)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMFlat (43)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptStandardFlat (44)	1 to <16 OZS
stPriorityMailInnovations (38)	ptFlats (33)	1 to 70 LBS
stPriorityMailInnovations (38)	ptParcels (34)	1 to 70 LBS
stPriorityMailInnovations (38)	ptBPM (35)	1 to 70 LBS
stEconomyMailInnovations (39)	ptFlats (33)	1 to 70 LBS
stEconomyMailInnovations (39)	ptParcels (34)	1 to 70 LBS
stEconomyMailInnovations (39)	ptBPM (35)	1 to 70 LBS

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSignatureType Property (EzRates Class)

Specifies one of the Delivery Signature Options requested for this package.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

stServiceDefault (0)	The default value for the requested service.
stAdult (1)	Available for both residential and nonresidential deliveries.
stDirect (2)	Available for both residential and nonresidential deliveries.
stIndirect (3)	Available for residential deliveries only.
stNoSignatureRequired (4)	Not available for Ground services.
stUSPSDeliveryConfirmation (5)	Available for UPS Mail Innovations only.
stAdult19 (6)	Available for Canada Post only.

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSize Property (EzRates Class)

Size of the package being mailed.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Package Size	Description	ServiceType
psRegular	For Priority Mail: Package is less than one cubic foot in size. For all other ServiceTypes: Package length plus girth is 84 inches or less.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLarge	For Priority Mail: Package is greater than one cubic foot in size. For all other ServiceTypes: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversize	Package length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.	Parcel Post only.

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageWeight Property (EzRates Class)

Weight of this package.

Syntax

• C++
• C
• Qt

Default Value

"0.0"

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagePackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageWidth Property (EzRates Class)

The width of the package to be shipped.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

Provider Property (EzRates Class)

Which provider to use.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

The "Ez" classs support FedEx, UPS, USPS, and Canada Post servers. This property tells the class which protocol to use.

NOTE: When this property is set, all properties of the class will be reset to their default values.

Data Type

Integer

ProxyAuthScheme Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

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 User and Password properties are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.

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

If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of User and Password.

Data Type

Integer

ProxyAutoDetect Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

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.

Data Type

Boolean

ProxyPassword Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

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.

Data Type

Integer

ProxyUser Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (EzRates Class)

Street name.

Syntax

• C++
• C
• Qt

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 RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

RecipientAddressFlags Property (EzRates Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

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.

Data Type

Integer

RecipientCity Property (EzRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

RecipientCountryCode Property (EzRates Class)

Country code.

Syntax

• C++
• C
• Qt

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

Data Type

String

RecipientState Property (EzRates Class)

State or province code.

Syntax

• C++
• C
• Qt

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.

Data Type

String

RecipientZipCode Property (EzRates Class)

Postal code.

Syntax

• C++
• C
• Qt

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 RecipientCity and RecipientState are not present.

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

Data Type

String

RequestedService Property (EzRates Class)

Service type for which the shipping rate is requested.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

This property is required to be entered in the request only if the rate request is made for a specific service type. In this case, the RequestedService should be set to a value different from 'stUnspecified'.

Otherwise, the rate request will be considered by the server as it has been made for all available services and respective rates.

Valid values for FedEx are:

stUnspecified (0)
stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15)
stFedExGroundHomeDelivery (16)
stFedEx1DayFreight (17)
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriority (20)
stFedExInternationalEconomy (21)
stFedExInternationalFirst (22)
stFedExInternationalPriorityFreight (23)
stFedExInternationalEconomyFreight (24)
stFedExEuropeFirstInternationalPriority (25)	For intra-Europe shipments only.
stFedExSmartPost (26)
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExInternationalPriorityExpress (32)
stFedExInternationalConnectPlus (33)
stFedExDistanceDeferred (120)	For intra-UK shipments only.
stFedExNextDayAfternoon (121)	For intra-UK shipments only.
stFedExNextDayEarlyMorning (122)	For intra-UK shipments only.
stFedExNextDayEndOfDay (123)	For intra-UK shipments only.
stFedExNextDayFreight (124)	For intra-UK shipments only.
stFedExNextDayMidMorning (125)	For intra-UK shipments only.

Valid values for UPS are:

Value	Applicable for
stUnspecified (0)
stUPSNextDayAir (40)	US Domestic Shipments; Originating in US/PR
stUPSExpress (41)	Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42)	US Domestic Shipments; Originating in US/PR
stUPSGround (43)	US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44)	Originating in US/PR
stUPSWorldwideExpedited (45)	US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46)	Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47)	Polish Domestic Shipments; All Origins
stUPS3DaySelect (48)	US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52)	Originating in CA
stUPSWorldwideExpressPlus (53)	Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54)	Originating in Mexico
stUPS2ndDayAirAM (55)	US Domestic Shipments; Originating in US
stUPSTodayStandard (56)	Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57)	Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58)	Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59)	Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60)	Polish Domestic Shipments (Stolica)
stUPSWorldwideEconomyDDU (131)	Originating in Canada or US, requires a contract with UPS
stUPSWorldwideEconomyDDP (132)	Originating in Canada or US, requires a contract with UPS

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Valid values for USPS are:

stUnspecified (0)
stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSBPM (74)
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only)
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)

Please note that the RequestedService stUSPSBoundPrintedMatter (74) is no longer supported by USPS or Endicia.

Data Type

Integer

SenderAddress1 Property (EzRates Class)

Street name.

Syntax

• C++
• C
• Qt

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 SenderAddress1 should not exceed 35 characters.

Data Type

String

SenderAddress2 Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

SenderAddressFlags Property (EzRates Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

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.

Data Type

Integer

SenderCity Property (EzRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

Data Type

String

SenderCountryCode Property (EzRates Class)

Country code.

Syntax

• C++
• C
• Qt

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

Data Type

String

SenderState Property (EzRates Class)

State or province code.

Syntax

• C++
• C
• Qt

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.

Data Type

String

SenderZipCode Property (EzRates Class)

Postal code.

Syntax

• C++
• C
• Qt

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 SenderCity and SenderState are not present.

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

Data Type

String

ServiceCount Property (EzRates Class)

The number of records in the Service arrays.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceAccountBaseCharge
• ServiceAccountNetCharge
• ServiceAccountTotalDiscount
• ServiceAccountTotalSurcharge
• ServiceAggregate
• ServiceBusinessDays
• ServiceCommitments
• ServiceCustomerCenterCutoff
• ServiceDeliveryDate
• ServiceEffectiveNetDiscount
• ServiceListBaseCharge
• ServiceListNetCharge
• ServiceListTotalDiscount
• ServiceListTotalSurcharge
• ServiceMaxDimensions
• ServiceMaxWeight
• ServiceRateScale
• ServiceRateZone
• ServiceShipTime
• ServiceSignatureType
• ServiceTransitTime
• ServiceType
• ServiceTypeDescription

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

This property is read-only and not available at design time.

Data Type

Integer

ServiceAccountBaseCharge Property (EzRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Transportation charges before surcharges and discounts applied to a ServiceType. This applies to FedEx only and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountBaseCharge will be filled with the value of discounted base charge amount specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceAccountNetCharge Property (EzRates Class)

Net charge amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Net charge amount applied to a ServiceType.

For FedEx, this is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountNetCharge will be filled with the value of discounted net charge amount specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned ServiceType

The UPS server response will contain negotiated rate(s) only for the qualified UPSAccountNumbers. Eligibility is determined using the combination of the UPSUserId and UPSAccountNumber. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This property is not used by the USPS class.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceAccountTotalDiscount Property (EzRates Class)

Total discount amount applied to the shipment for a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Total discount amount applied to the shipment for a ServiceType. This is for FedEx only and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountTotalDiscount will be filled with the value of total discount applied, which is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceAccountTotalSurcharge Property (EzRates Class)

Total surcharge amount for all additional services applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Total surcharge amount for all additional services applied to a ServiceType. This is only for FedEx, and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountTotalSurcharge will be filled with the value of total surcharges applied, which is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceAggregate Property (EzRates Class)

Aggregate of details and rates for the ServiceType in the list of available services.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Aggregate of details and rates for the ServiceType in the list of available services.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceBusinessDays Property (EzRates Class)

Number of business days from origin to destination location.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

Number of business days from origin to destination location. This is valid only for UPS and is returned for the number of UPS business days (Monday, Tuesday, Wednesday, Thursday, Friday and Saturday) the shipment will take to travel from one location to another.

If applicable, this property is filled after a call to the GetShippingTime.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServiceCommitments Property (EzRates Class)

Service commitments for the PackagingType when shipping to CountryCode .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Service commitments for the ServicePackagingType when shipping to RecipientCountryCode.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via ServicePackagingType.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceCustomerCenterCutoff Property (EzRates Class)

Time the UPS Customer Service Center closes.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Time the UPS Customer Service Center closes.

This value is only relevant for UPS and it provides the user with the time the Customer Service Center closes. This is applicable for shipments outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceDeliveryDate Property (EzRates Class)

This indicates the shipment delivery date for the ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

This indicates the shipment delivery date for the ServiceType.

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

For Canada Post, this field will be populated after a GetRates call and will contain the estimated date of delivery, starting from the expected mailing-date.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceEffectiveNetDiscount Property (EzRates Class)

Indicates the net discount applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Indicates the net discount applied to a ServiceType. This is only valid for FedEx.

After calling the GetRates method, the ServiceEffectiveNetDiscount will be filled with the value of net discount applied. This is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx). This is the difference between the list net charge and account net charge.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceListBaseCharge Property (EzRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Transportation charges before surcharges and discounts applied to a ServiceType. After calling the GetRates method, the ServiceListBaseCharge will be filled with the value of base charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This does not apply to USPS.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceListNetCharge Property (EzRates Class)

Net charge amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Net charge amount applied to a ServiceType.

After calling the GetRates method, the ServiceListNetCharge will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceListTotalDiscount Property (EzRates Class)

Total discount amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Total discount amount applied to a ServiceType. This applies only to FedEx. After calling the GetRates method, the ServiceListTotalDiscount will be filled with the value of total discount applied. This is returned in the server response only if the RateType is set to 0 (rtList) in the request.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceListTotalSurcharge Property (EzRates Class)

Total surcharge amount for all additional services applied to a ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Total surcharge amount for all additional services applied to a ServiceType.

After calling the GetRates method, the ServiceListTotalSurcharge will be filled with the value of total surcharges applied.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This value does not apply to USPS.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceMaxDimensions Property (EzRates Class)

Maximum dimensions of a package allowed when sending to the CountryCode .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Maximum dimensions of a package allowed when sending to the RecipientCountryCode. This is only applicable to USPS. After a call to GetRates, this property will contain the maximum allowable dimensions of a package sent to the RecipientCountryCode via the indicated ServiceType.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceMaxWeight Property (EzRates Class)

Maximum weight of package allowed when sending to the CountryCode .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Maximum weight of package allowed when sending to the RecipientCountryCode.

This is only applicable to USPS.

After a call to GetRates, this property will contain the maximum allowable weight (in pounds) of a package sent to the RecipientCountryCode via the indicated ServiceType.

Note: This property may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceRateScale Property (EzRates Class)

Applicable rate scale for the ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Applicable rate scale for the ServiceType.

The ServiceRateScale indicates the rate scale (this is specific to the FedExAccountNumber) used by FedEx to rate a shipment when shipped via the ServiceType. This is applicable for FedEx Express services only.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceRateZone Property (EzRates Class)

Applicable rate zone for the ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Applicable rate zone for the ServiceType.

The ServiceRateZone indicates the zone used by FedEx to rate a shipment (this is specific to the RecipientZipCode) when using a FedEx Express service. This is applicable for FedEx Express services only.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceType Property (EzRates Class)

Indicates the service type in the list of available services returned.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

Indicates the service type in the list of available services returned.

This is populated when the GetShippingTime or GetRates methods are called.

Valid values for FedEx are:

stUnspecified (0)
stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15)
stFedExGroundHomeDelivery (16)
stFedEx1DayFreight (17)
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriority (20)
stFedExInternationalEconomy (21)
stFedExInternationalFirst (22)
stFedExInternationalPriorityFreight (23)
stFedExInternationalEconomyFreight (24)
stFedExEuropeFirstInternationalPriority (25)	For intra-Europe shipments only.
stFedExSmartPost (26)
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExInternationalPriorityExpress (32)
stFedExInternationalConnectPlus (33)
stFedExDistanceDeferred (120)	For intra-UK shipments only.
stFedExNextDayAfternoon (121)	For intra-UK shipments only.
stFedExNextDayEarlyMorning (122)	For intra-UK shipments only.
stFedExNextDayEndOfDay (123)	For intra-UK shipments only.
stFedExNextDayFreight (124)	For intra-UK shipments only.
stFedExNextDayMidMorning (125)	For intra-UK shipments only.

Valid values for UPS are:

Value	Applicable for
stUnspecified (0)
stUPSNextDayAir (40)	US Domestic Shipments; Originating in US/PR
stUPSExpress (41)	Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42)	US Domestic Shipments; Originating in US/PR
stUPSGround (43)	US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44)	Originating in US/PR
stUPSWorldwideExpedited (45)	US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46)	Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47)	Polish Domestic Shipments; All Origins
stUPS3DaySelect (48)	US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52)	Originating in CA
stUPSWorldwideExpressPlus (53)	Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54)	Originating in Mexico
stUPS2ndDayAirAM (55)	US Domestic Shipments; Originating in US
stUPSTodayStandard (56)	Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57)	Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58)	Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59)	Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60)	Polish Domestic Shipments (Stolica)
stUPSWorldwideEconomyDDU (131)	Originating in Canada or US, requires a contract with UPS
stUPSWorldwideEconomyDDP (132)	Originating in Canada or US, requires a contract with UPS

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Valid values for USPS are:

stUnspecified (0)
stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSBPM (74)
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only)
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)

Please note that the RequestedService stUSPSBoundPrintedMatter (74) is no longer supported by USPS or Endicia.

Valid values for Canada Post are:

stCanadaRegularParcel (90)
stCanadaExpeditedParcel (91)
stCanadaXpresspost (92)
stCanadaXpresspostCertified (93)
stCanadaPriority (94)
stCanadaPriorityEnvelopeUSA (95)
stCanadaPriorityPakUSA (96)
stCanadaPriorityParcelUSA (97)
stCanadaXpresspostUSA (98)
stCanadaExpeditedParcelUSA (99)
stCanadaSmallPacketAirUSA (100)
stCanadaSmallPacketLandUSA (101)
stCanadaPriorityEnvelopeInternational (102)
stCanadaPriorityPakInternational (103)
stCanadaPriorityParcelInternational (104)
stCanadaXpresspostInternational (105)
stCanadaSmallPacketAirInternational (106)
stCanadaSmallPacketLandInternational (107)
stCanadaParcelAirInternational (108)
stCanadaParcelLandInternational (109)

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ServiceTypeDescription Property (EzRates Class)

Indicates the textual description of a service type in the list of available services returned.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:

Service Type	Service Type Description
10	PRIORITY_OVERNIGHT
11	STANDARD_OVERNIGHT
12	FIRST_OVERNIGHT
13	FEDEX_2_DAY
14	FEDEX_EXPRESS_SAVER
15	FEDEX_GROUND
16	GROUND_HOME_DELIVERY
17	FEDEX_1_DAY_FREIGHT
18	FEDEX_2_DAY_FREIGHT
19	FEDEX_3_DAY_FREIGHT
20	INTERNATIONAL_PRIORITY
21	INTERNATIONAL_ECONOMY
22	INTERNATIONAL_FIRST
23	INTERNATIONAL_PRIORITY_FREIGHT
24	INTERNATIONAL_ECONOMY_FREIGHT
25	EUROPE_FIRST_INTERNATIONAL_PRIORITY
26	FEDEX_SMART_POST
27	FEDEX_2_DAY_AM
28	FEDEX_FIRST_FREIGHT
29	FEDEX_FREIGHT_ECONOMY
30	FEDEX_FREIGHT_PRIORITY
120	FEDEX_DISTANCE_DEFERRED
121	FEDEX_NEXT_DAY_AFTERNOON
122	FEDEX_NEXT_DAY_EARLY_MORNING
123	FEDEX_NEXT_DAY_END_OF_DAY
124	FEDEX_NEXT_DAY_FREIGHT
125	FEDEX_NEXT_DAY_MID_MORNING

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceShipTime Property (EzRates Class)

Time UPS picks up the package from the origin.

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Time UPS picks up the package from the origin. It is returned for requests outside the US. If applicable, this property is filled after a call to the GetShippingTime.

This is only applicable to UPS GetShippingTime.

Format: HH:MM:SS

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceSignatureType Property (EzRates Class)

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType. This might be different from the requested PackageSignatureType.

Possible returned values are:

ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ServiceTransitTime Property (EzRates Class)

Expected number of days in transit from pickup to delivery for the ServiceType .

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

Expected number of days in transit from pickup to delivery for the ServiceType. This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

The ServiceIdx parameter specifies the index of the item in the array. The size of the array is controlled by the ServiceCount property.

This property is read-only and not available at design time.

Data Type

String

ShipmentSpecialServices Property (EzRates Class)

Contains the collection of special services offered.

Syntax

• C++
• C
• Qt

Default Value

0

Remarks

To request any of the special services offered by FedEx in a ship request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Value	Meaning	FedEx	UPS	USPS	Canada Post
0x00000001L	Broker Select	X
0x00000002L	Call Before Delivery	X
0x00000004L	COD	X		X
0x00000008L	Custom Delivery Window	X
0x00000010L	Dangerous Goods	X
0x00000020L	Do Not Break Down PAllets	X
0x00000040L	Do Not Stack Pallets	X
0x00000080L	Dry Ice	X
0x00000100L	East Coast Special	X
0x00000200L	Electronic Trade Documents	X
0x00000400L	Email Notification	X
0x00000800L	Extreme Length	X
0x00001000L	Food	X
0x00002000L	Freight Guarantee	X
0x00004000L	Future Day	X
0x00008000L	Hold At Location	X	X	X
0x00010000L	International Controlled Export Service	X
0x00020000L	Home Delivery Premium	X
0x00040000L	Inside Delivery	X
0x00080000L	Inside Pickup	X
0x00100000L	Liftgate Delivery	X	X
0x00200000L	Liftgate Pickup	X	X
0x00400000L	Limited Access Delivery	X
0x00800000L	Limited Access Pickup	X
0x01000000L	Pending Shipment	X
0x02000000L	Poison	X
0x04000000L	Protection From Freezing	X
0x08000000L	Return Shipment	X	X	X
0x10000000L	Saturday Delivery	X	X
0x20000000L	Saturday Pickup	X
0x40000000L	Top Load	X
0x80000000L	Restricted Delivery			X
0x0000000100000000L	Return Receipt			X
0x0000000200000000L	Certificate Of Mailing			X
0x0000000400000000L	Sunday and Holiday Delivery			X
0x0000000800000000L	No Weekend			X
0x0000001000000000L	Registered Mail			X
0x0000002000000000L	Premium Service (Sunday/Holiday)			X
0x0000004000000000L	Commercial			X
0x0000008000000000L	Delivery Confirmation			X
0x0000010000000000L	International Traffic in Arms Regulations	X
0x0000020000000000L	Return of Document		X
0x0000040000000000L	Import Control		X
0x0000080000000000L	Commercial Invoice Removal		X
0x0000100000000000L	Exchange Forward		X
0x0000200000000000L	Carbon Neutral		X
0x0000400000000000L	Dropoff at UPS Facility		X

Data Type

Long64

SSLAcceptServerCertEncoded Property (EzRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (EzRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

Default Value

"MY"

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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).

Data Type

Binary String

SSLCertStorePassword Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

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.

Data Type

String

SSLCertStoreType Property (EzRates Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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 ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword 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.

Data Type

Integer

SSLCertSubject Property (EzRates Class)

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

Syntax

• C++
• C
• Qt

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.

Data Type

String

SSLProvider Property (EzRates Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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.

Data Type

Integer

SSLServerCertEncoded Property (EzRates Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (EzRates Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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 DoEvents 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.

Data Type

Integer

TotalWeight Property (EzRates Class)

Total shipment's weight.

Syntax

• C++
• C
• Qt

Default Value

"1.0"

Remarks

This indicates shipment's weight.

Allows for only one decimal point and one decimal place.

For FedEx, this property is required unless there is only one package in the shipment and that package's weight is provided in the PackageWeight property.

For UPS, this is required for shipments outside the US and non-document shipments inside the US. It will be returned in the server response only if provided in the request.

This property is not applicable to USPS shipments.

Data Type

String

Config Method (EzRates Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetRates Method (EzRates Class)

Returns rate information for a specified or all available services.

Syntax

• C++
• C
• Qt

Remarks

To get the courtesy rate quotes for the Provider's services, you can call the GetRates method. If rates are needed for a specific service type, you will have to set the RequestedService to the value you need the rates for (other than 0 : stUnspecified). The RequestedService identifies the specific service for which you want to retrieve rate information.

If the rates are wanted for all available services, you should set the RequestedService to 0 (stUnspecified). Following validation, the EzRates identifies and rates all available services. The server response will include a list of services, their associated rate, and guaranteed delivery time, if available.

In either case, the following properties or config settings are sent in the request (if any of these have not been set, their default values will be used instead):

• Account (required)
• RequestedService (required)
• SenderAddress(required)
• RecipientAddress (required)
• Packages (required)

Returned values upon a successful reply are:

• Services

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (EzRates Class)

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

Syntax

• C++
• C
• Qt

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (EzRates Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

Remarks

The 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.

Notification Event (EzRates Class)

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

Syntax

• C++
• C
• Qt

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 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.

SSLServerAuthentication Event (EzRates Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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.

SSLStatus Event (EzRates Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

Remarks

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

Config Settings (EzRates Class)

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.

EzRates Config Settings

CanadaContractId:   The Contract Id of a Canada Post account used to identify a commercial contract. This specifies the Contract Id of a Canada Post account and is used to identify a commercial contract. When specified the negotiated rates for the contract will be used. If not specified the standard list rates will be used. Note: This value is only used when the Provider is set to pCanadaPost

CanadaGstAmount[i]:   The amount of Goods and Services Tax (GST) for the service, specified by 'i', when using Canada Post. This field is populated after a GetRates call. This allows you to get the Goods and Services Tax (GST) Amount of the specified Services with i being the index of the current service. Valid array indices are from 0 to ServiceCount - 1. Note this is only valid when Provider is set to pCanadaPost

CanadaHstAmount[i]:   The amount of Harmonized Sales Tax (HST) for the service, specified by 'i', when using Canada Post. This field is populated after a GetRates call. This allows you to get the Harmonized Sales Tax (HST) Amount of the specified Services with i being the index of the current service. Valid array indices are from 0 to ServiceCount - 1. Note this is only valid when Provider is set to pCanadaPost

CanadaPstAmount[i]:   The amount of Provincial Sales Tax (PST) for the service, specified by 'i', when using Canada Post. This field is populated after a GetRates call. This allows you to get the Provincial Sales Tax (PST) Amount of the specified Services with i being the index of the current service. Valid array indices are from 0 to ServiceCount - 1. Note this is only valid when Provider is set to pCanadaPost

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 FedExAccountNumber, FedExMeterNumber 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 FedExAccountNumber, FedExMeterNumber 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 (FedExDeveloperKey and FedExPassword 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 (FedExDeveloperKey and FedExPassword respectively).

EndiciaInsuranceType:   The Insurance type when using Endicia. This will determine which type of insurance will be used when requesting a label through Endicia. Value Meaning 0 None (Default) 1 USPS Insurance 2 Endicia Insurance 3 USPS Online Insurance Note that if this is set to None, and an insurance amount is provided, Endicia Insurance will be used.

EndiciaInsuredMail:   Used to request Endicia mailpiece insurance. When set to False, Endicia mailpiece insurance will not be requested. This can be applicable when generating Endicia COD labels. When PackageInsuredValue is set, the default value for this configuration setting is True.

EndiciaTestMode:   Controls whether requests are test requests or live requests. When set to a non-zero value the class will use a built-in sandbox account and set the TEST flag to "Yes" in the request itself. For all values this will automatically set USPSServer as defined below. 0 Live Requests to Production server (default) 1 Test Requests to Sandbox server 2 Test Requests to Production server This setting only applies when PostageProvider is set to ppEndicia.

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.

PostageProvider:   The postage provider to use. When set to 0 (None), the class will communicate with USPS servers to get rates and print labels. USPS web services do not provide postage. If postage is necessary, set this property to 1 (Endicia) to use Endicia's web services which provides postage. In order to use this provider, an Endicia account must be set up through their website. Once you have an Endicia USPSAccountNumber, you should also have obtained a USPSUserId and USPSPassword uniquely assigned to your account by Endicia. These values are all necessary to get rates and shipping labels through their web services.

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.

TotalWeight:   The total weight of the shipment. This is used to specify the total weight of the entire shipment.

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 HTTPVersion 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 LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile 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 AuthScheme 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 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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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 OtherHeaders 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 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 FollowRedirects 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 HTTPVersion 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 ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

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 ProxyAutoDetect 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.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected. 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 number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9. Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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 LocalHost 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 LocalHost 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 LocalPort after the connection is established. LocalPort 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 DataIn 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 DataIn 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 SSLProvider 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 SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider 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-----

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 SSLStatus 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 SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider 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 SSLProvider 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 SSLProvider 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 SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider 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 SSLProvider 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 SSLServerAuthentication 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 SSLServerAuthentication event. If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication 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 SSLProvider 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 SSLProvider 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 SSLProvider 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 DoEvents 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.

Trappable Errors (EzRates Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EzRates 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 MethodURI.
	173   SOAP Fault. See FaultCode and/or FaultString 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 URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost 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 LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort 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 BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.