EzRates Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

AccountUserId The login username for your Canada Post account.
AccountPassword The login password for your Canada Post account.
AccountAccountNumber The customer number of the owner of the mail (mailed on behalf of customer).
SenderAddressZipCode Postal Code from which the parcel will be sent.
RecipientAddressCountryCode The destination country code.
RecipientAddressZipCode The destination Postal Code. Required when shipping to CA or US. Not required for all other international shipments.
PackagesWeight The weight of the parcel in kilograms (e.g. 99.999).

You can optionally set the following fields when requesting rates:

PackagesLength Longest dimension (3.1 digits e.g. 999.9 pattern).
PackagesWidth Second longest dimension (3.1 digits e.g. 999.9 pattern).
PackagesHeight Shortest dimension (3.1 digits e.g. 999.9 pattern).
PackagesPackagingType 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:

ServicesAccountBaseCharge Base cost of the shipment before taxes (numeric 99999.99).
ServicesAccountNetCharge Total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.
ServicesAccountTotalDiscount Total amount of discounts.
ServicesAccountTotalSurcharge Total amount of surcharges.
ServicesServiceType Service type for the mail service being quoted.
ServicesServiceTypeDescription Service name in preferred language.
ServicesTransitTime Indicates the number of days from drop-off or pickup to 1st delivery attempt.
ServicesDeliveryDate The estimated date of delivery, starting from the expected mailing-date.
ServicesGuaranteedDescription 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 module with short descriptions. Click on the links for further details.

AccountLogin information for the specified Provider .
FirewallA set of properties related to firewall access.
PackagesA collection of packages contained in the shipment.
ProviderWhich provider to use.
ProxyA set of properties related to proxy access.
RateTypeIndicates the type of rates to be returned.
RecipientAddressIdentifies the recipient's address.
RequestedServiceService type for which the shipping rate is requested.
SenderAddressIdentifies the sender's address.
ServicesCollection of available services returned for the shipment being rated.
ShipmentSpecialServicesContains the collection of special services offered.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
TimeoutA timeout for the module.
TotalWeightTotal shipment's weight.

Method List


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

ConfigSets or retrieves a configuration setting.
GetRatesReturns rate information for a specified or all available services.
ResetResets the internal state of the module and all properties to their default values.

Event List


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

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.

Config Settings


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

CanadaContractIdThe 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.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
EndiciaTestModeControls whether requests are test requests or live requests.
HasXPathDetermines whether a specific element exists in the document.
PostageProviderThe postage provider to use.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
TotalWeightThe total weight of the shipment.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
XChildCountThe 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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the module.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the module will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the module.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the module.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Account Property (EzRates Module)

Login information for the specified Provider .

Syntax

public var account: EzAccount {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accountNumber,setter=setAccountNumber:) NSString* accountNumber;

- (NSString*)accountNumber;
- (void)setAccountNumber :(NSString*)newAccountNumber;

@property (nonatomic,readwrite,assign,getter=authorizationToken,setter=setAuthorizationToken:) NSString* authorizationToken;

- (NSString*)authorizationToken;
- (void)setAuthorizationToken :(NSString*)newAuthorizationToken;

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

@property (nonatomic,readwrite,assign,getter=server,setter=setServer:) NSString* server;

- (NSString*)server;
- (void)setServer :(NSString*)newServer;

@property (nonatomic,readwrite,assign,getter=userId,setter=setUserId:) NSString* userId;

- (NSString*)userId;
- (void)setUserId :(NSString*)newUserId;

 

Default Value

"1.0"

Remarks

This property must be set when connecting to the server. It contains server and login information.

Firewall Property (EzRates Module)

A set of properties related to firewall access.

Syntax

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

"1.0"

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Packages Property (EzRates Module)

A collection of packages contained in the shipment.

Syntax

public var packages: Array<PackageDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=packageCount,setter=setPackageCount:) int packageCount;

- (int)packageCount;
- (void)setPackageCount :(int)newPackageCount;

- (int)packageGirth:(int)packageIdx;
- (void)setPackageGirth:(int)packageIdx :(int)newPackageGirth;

- (int)packageHeight:(int)packageIdx;
- (void)setPackageHeight:(int)packageIdx :(int)newPackageHeight;

- (NSString*)packageInsuredValue:(int)packageIdx;
- (void)setPackageInsuredValue:(int)packageIdx :(NSString*)newPackageInsuredValue;

- (int)packageLength:(int)packageIdx;
- (void)setPackageLength:(int)packageIdx :(int)newPackageLength;

- (int)packageType:(int)packageIdx;
- (void)setPackageType:(int)packageIdx :(int)newPackageType;

- (int)packageSignatureType:(int)packageIdx;
- (void)setPackageSignatureType:(int)packageIdx :(int)newPackageSignatureType;

- (int)packageSize:(int)packageIdx;
- (void)setPackageSize:(int)packageIdx :(int)newPackageSize;

- (NSString*)packageWeight:(int)packageIdx;
- (void)setPackageWeight:(int)packageIdx :(NSString*)newPackageWeight;

- (int)packageWidth:(int)packageIdx;
- (void)setPackageWidth:(int)packageIdx :(int)newPackageWidth;

Default Value

"1.0"

Remarks

At least one package must be specified.

This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.

For FedEx, the PackagesPackagingType and either the PackagesWeight or TotalWeight must be specified. The PackagesLength, PackagesWidth, PackagesHeight, PackagesInsuredValue, and PackagesSpecialServices are optional.

For UPS, the PackagesPackagingType is required. The PackagesDescription is optional. The PackagesWeight, PackagesLength, PackagesWidth, and PackagesHeight are all conditionally required. More information can be found in the individual property definitions.

For USPS, the PackagesPackagingType, PackagesSize, and PackagesWeight properties are required. PackagesLength, PackagesWidth, PackagesHeight, and PackagesGirth are all conditionally required, and more information may be found in the individual property definitions.

Note: USPS only supports one package per shipment.

For Canada Post the PackagesPackagingType and the PackagesWeight must be specified. The PackagesLength, PackagesWidth, PackagesHeight, PackagesInsuredValue, and PackagesSpecialServices are optional.

Provider Property (EzRates Module)

Which provider to use.

Syntax

public var provider: EzratesProviders {
  get {...}
  set {...}
}

public enum EzratesProviders: Int32 { case pFedEx = 0 case pUPS = 1 case pUSPS = 2 case pCanadaPost = 3 }

@property (nonatomic,readwrite,assign,getter=provider,setter=setProvider:) int provider;

- (int)provider;
- (void)setProvider :(int)newProvider;

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.

Proxy Property (EzRates Module)

A set of properties related to proxy access.

Syntax

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

"1.0"

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

RateType Property (EzRates Module)

Indicates the type of rates to be returned.

Syntax

public var rateType: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=rateType,setter=setRateType:) int rateType;

- (int)rateType;
- (void)setRateType :(int)newRateType;

Default Value

1

Remarks

Possible values are listed below (specified in hexadecimal notation). They can be or-ed together to include multiple options:

ValueMeaning
0x001 List (Default)Returns FedEx published list rates in addition to account-specific (discount) rates (if applicable).
0x002 Account Returns account-specific (discount) rates.
0x004 Preferred Returns rates in the preferred currency specified in the CurrencyCode config.
0x008 Incentive This is one-time discount for incentivising the customer. For more information, contact your FedEx representative.
0x010 Retail Returns customer rate from one of retail FedEx service centers.

Note: b>This property is only applicable to FedEx.

RecipientAddress Property (EzRates Module)

Identifies the recipient's address.

Syntax

public var recipientAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientAddress1,setter=setRecipientAddress1:) NSString* recipientAddress1;

- (NSString*)recipientAddress1;
- (void)setRecipientAddress1 :(NSString*)newRecipientAddress1;

@property (nonatomic,readwrite,assign,getter=recipientAddress2,setter=setRecipientAddress2:) NSString* recipientAddress2;

- (NSString*)recipientAddress2;
- (void)setRecipientAddress2 :(NSString*)newRecipientAddress2;

@property (nonatomic,readwrite,assign,getter=recipientAddressFlags,setter=setRecipientAddressFlags:) int recipientAddressFlags;

- (int)recipientAddressFlags;
- (void)setRecipientAddressFlags :(int)newRecipientAddressFlags;

@property (nonatomic,readwrite,assign,getter=recipientCity,setter=setRecipientCity:) NSString* recipientCity;

- (NSString*)recipientCity;
- (void)setRecipientCity :(NSString*)newRecipientCity;

@property (nonatomic,readwrite,assign,getter=recipientCountryCode,setter=setRecipientCountryCode:) NSString* recipientCountryCode;

- (NSString*)recipientCountryCode;
- (void)setRecipientCountryCode :(NSString*)newRecipientCountryCode;

@property (nonatomic,readwrite,assign,getter=recipientState,setter=setRecipientState:) NSString* recipientState;

- (NSString*)recipientState;
- (void)setRecipientState :(NSString*)newRecipientState;

@property (nonatomic,readwrite,assign,getter=recipientZipCode,setter=setRecipientZipCode:) NSString* recipientZipCode;

- (NSString*)recipientZipCode;
- (void)setRecipientZipCode :(NSString*)newRecipientZipCode;

 

Default Value

"1.0"

Remarks

The RecipientAddress is required to be provided in a rate request (when the GetRates method is called).

For FedEx, the Residential flag in RecipientAddressAddressFlags is applicable for all services (i.e. either Ground or Express). If True, extra charge will be added to rate quote as this is considered a special service. A residential package surcharge applies to shipments to a home or private residence, including locations where a business is operated from a home. This surcharge is applicable for: U.S. Express and Ground services, International Ground service (Canada only), U.S. Express Freight services, and FedEx International Premium.

For UPS, the Residential flag in the RecipientAddressAddressFlags property is applicable for US domestic requests only. When this is set, it indicates that the rate request is made for Residential delivery address. Otherwise, the rate query is calculated for a Commercial delivery address. Requests outside the US will only be calculated for Commercial. In this case, even if the Residential flag is set, the entry will be ignored. If negotiated rates are requested to be received, then the RecipientAddressState is required to be provided in the request. Otherwise, it is optional.

The Residential flag does not apply to USPS requests.

This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.

RequestedService Property (EzRates Module)

Service type for which the shipping rate is requested.

Syntax

public var requestedService: ServiceTypes {
  get {...}
  set {...}
}

public enum EzratesRequestedServices: Int32 { case stUnspecified = 0 case stFedExPriorityOvernight = 10 case stFedExStandardOvernight = 11 case stFedExFirstOvernight = 12 case stFedEx2Day = 13 case stFedExExpressSaver = 14 case stFedExGround = 15 case stFedExGroundHomeDelivery = 16 case stFedEx1DayFreight = 17 case stFedEx2DayFreight = 18 case stFedEx3DayFreight = 19 case stFedExInternationalPriority = 20 case stFedExInternationalEconomy = 21 case stFedExInternationalFirst = 22 case stFedExInternationalPriorityFreight = 23 case stFedExInternationalEconomyFreight = 24 case stFedExEuropeFirstInternationalPriority = 25 case stFedExSmartPost = 26 case stFedEx2DayAM = 27 case stFedExFirstFreight = 28 case stFedExInternationalGround = 29 case stFedExFreightEconomy = 30 case stFedExFreightPriority = 31 case stFedExInternationalPriorityExpress = 32 case stFedExInternationalConnectPlus = 33 case stUPSFirstClass = 35 case stUPSPriorityMail = 36 case stUPSExpeditedMailInnovations = 37 case stUPSPriorityMailInnovations = 38 case stUPSEconomyMailInnovations = 39 case stUPSNextDayAir = 40 case stUPSExpress = 41 case stUPS2ndDayAir = 42 case stUPSGround = 43 case stUPSWorldwideExpress = 44 case stUPSWorldwideExpedited = 45 case stUPSExpedited = 46 case stUPSStandard = 47 case stUPS3DaySelect = 48 case stUPSNextDayAirSaver = 49 case stUPSSaver = 50 case stUPSNextDayAirEarlyAM = 51 case stUPSExpressEarlyAM = 52 case stUPSWorldwideExpressPlus = 53 case stUPSExpressPlus = 54 case stUPS2ndDayAirAM = 55 case stUPSTodayStandard = 56 case stUPSTodayCourrier = 57 case stUPSTodayInterCity = 58 case stUPSTodayExpress = 59 case stUPSTodayExpressSaver = 60 case stUPSWorldwideExpressFreight = 61 case stUPSSurePostLessThan1LB = 62 case stUPSSurePost1LBOrGreater = 63 case stUPSSurePostBPM = 64 case stUPSSurePostMedia = 65 case stUSPSExpress = 70 case stUSPSFirstClass = 71 case stUSPSPriority = 72 case stUSPSParcelPost = 73 case stUSPSBPM = 74 case stUSPSMedia = 75 case stUSPSLibrary = 76 case stUSPSOnline = 77 case stUSPSGlobalExpress = 78 case stUSPSParcelSelect = 79 case stUSPSCriticalMail = 80 case stUSPSStandardMail = 81 case stUSPSExpressMailInternational = 82 case stUSPSFirstClassMailInternational = 83 case stUSPSPriorityMailInternational = 84 case stUSPSPriorityExpress = 85 case stUSPSRetailGround = 86 case stUSPSFirstClassPackageInternationalService = 87 case stUSPSPriorityMailExpressInternational = 88 case stCanadaRegularParcel = 90 case stCanadaExpeditedParcel = 91 case stCanadaXpresspost = 92 case stCanadaLibrary = 93 case stCanadaPriority = 94 case stCanadaPriorityEnvelopeUSA = 95 case stCanadaPriorityPakUSA = 96 case stCanadaPriorityParcelUSA = 97 case stCanadaXpresspostUSA = 98 case stCanadaExpeditedParcelUSA = 99 case stCanadaSmallPacketAirUSA = 100 case stCanadaTrackedPacketUSA = 101 case stCanadaTrackedPacketLVMUSA = 102 case stCanadaPriorityEnvelopeInternational = 103 case stCanadaPriorityPakInternational = 104 case stCanadaPriorityParcelInternational = 105 case stCanadaXpresspostInternational = 106 case stCanadaSmallPacketAirInternational = 107 case stCanadaSmallPacketLandInternational = 108 case stCanadaParcelAirInternational = 109 case stCanadaParcelLandInternational = 110 case stCanadaTrackedPacketInternational = 111 case stFedExSameDay = 126 case stFedExSameDayCity = 127 case stFedExSameDayMetroAfternoon = 128 case stFedExSameDayMetroMorning = 129 case stFedExSameDayMetroRush = 130 case stUPSWorldwideEconomyDDU = 131 case stUPSWorldwideEconomyDDP = 132 case stUSPSParcelSelectGround = 133 case stUSPSPriorityMailCubic = 134 case stUSPSGroundAdvantage = 135 case stUSPSGroundAdvantageCubic = 136 case stFedExFirst = 140 case stFedExPriority = 141 case stFedExPriorityExpress = 142 case stFedExPriorityExpressFreight = 143 case stFedExPriorityFreight = 144 case stFedExEconomySelect = 145 }

@property (nonatomic,readwrite,assign,getter=requestedService,setter=setRequestedService:) int requestedService;

- (int)requestedService;
- (void)setRequestedService :(int)newRequestedService;

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)
stFedExFirst (140) For EU and APAC Regions only.
stFedExPriority (141) For EU and APAC Regions only.
stFedExPriorityExpress (142) For EU and APAC Regions only.
stFedExPriorityExpressFreight (143) For EU and APAC Regions only.
stFedExPriorityFreight (144) For EU and APAC Regions only.
stFedExEconomySelect (145) For UK only.

Valid values for UPS are:

Value Applicable for
stUnspecified (0)
stUPSFirstClass(35) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMailInnovations (38) All origins, requires a contract with Mail Innovations, single package shipments only
stUPSEconomyMailInnovations (39) All Origins, requires a contract with Mail Innovations, single package shipments only
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)
stUPSWorldwideExpressFreight (61) All Origins; Worldwide Express Freight
stUPSSurePostLessThan1LB (62) US Domestic Shipments, SurePost Less Than 1LB
stUPSSurePost1LBOrGreater (63) US Domestic Shipments, SurePost 1LB Or Greater
stUPSSurePostBPM (64) US Domestic Shipments, SurePost BPM (Bound Printed Matter)
stUPSSurePostMedia (65) US Domestic Shipments, SurePost Media
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) (USPS Only )
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only )
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSPriorityExpress (85) (Endicia only)
stUSPSRetailGround (86) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)
stUSPSGroundAdvantage (135)
stUSPSGroundAdvantageCubic (136)

Please note that the RequestedService stUSPSBPM (74) is no longer supported by Endicia.

SenderAddress Property (EzRates Module)

Identifies the sender's address.

Syntax

public var senderAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=senderAddress1,setter=setSenderAddress1:) NSString* senderAddress1;

- (NSString*)senderAddress1;
- (void)setSenderAddress1 :(NSString*)newSenderAddress1;

@property (nonatomic,readwrite,assign,getter=senderAddress2,setter=setSenderAddress2:) NSString* senderAddress2;

- (NSString*)senderAddress2;
- (void)setSenderAddress2 :(NSString*)newSenderAddress2;

@property (nonatomic,readwrite,assign,getter=senderAddressFlags,setter=setSenderAddressFlags:) int senderAddressFlags;

- (int)senderAddressFlags;
- (void)setSenderAddressFlags :(int)newSenderAddressFlags;

@property (nonatomic,readwrite,assign,getter=senderCity,setter=setSenderCity:) NSString* senderCity;

- (NSString*)senderCity;
- (void)setSenderCity :(NSString*)newSenderCity;

@property (nonatomic,readwrite,assign,getter=senderCountryCode,setter=setSenderCountryCode:) NSString* senderCountryCode;

- (NSString*)senderCountryCode;
- (void)setSenderCountryCode :(NSString*)newSenderCountryCode;

@property (nonatomic,readwrite,assign,getter=senderState,setter=setSenderState:) NSString* senderState;

- (NSString*)senderState;
- (void)setSenderState :(NSString*)newSenderState;

@property (nonatomic,readwrite,assign,getter=senderZipCode,setter=setSenderZipCode:) NSString* senderZipCode;

- (NSString*)senderZipCode;
- (void)setSenderZipCode :(NSString*)newSenderZipCode;

 

Default Value

"1.0"

Remarks

The SenderAddress is required to be provided in a rate request.

For FedEx, the Residential flag in RecipientAddressAddressFlags is applicable for FedEx Ground services only. If True, extra charge will be added to rate quote as this is considered a special service.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

Services Property (EzRates Module)

Collection of available services returned for the shipment being rated.

Syntax

public var services: Array<ServiceDetail> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=serviceCount) int serviceCount;

- (int)serviceCount;

- (NSString*)serviceAccountBaseCharge:(int)serviceIdx;

- (NSString*)serviceAccountNetCharge:(int)serviceIdx;

- (NSString*)serviceAccountTotalDiscount:(int)serviceIdx;

- (NSString*)serviceAccountTotalSurcharge:(int)serviceIdx;

- (NSString*)serviceAggregate:(int)serviceIdx;

- (int)serviceBusinessDays:(int)serviceIdx;

- (NSString*)serviceCommitments:(int)serviceIdx;

- (NSString*)serviceCustomerCenterCutoff:(int)serviceIdx;

- (NSString*)serviceDeliveryDate:(int)serviceIdx;

- (NSString*)serviceEffectiveNetDiscount:(int)serviceIdx;

- (NSString*)serviceListBaseCharge:(int)serviceIdx;

- (NSString*)serviceListNetCharge:(int)serviceIdx;

- (NSString*)serviceListTotalDiscount:(int)serviceIdx;

- (NSString*)serviceListTotalSurcharge:(int)serviceIdx;

- (NSString*)serviceMaxDimensions:(int)serviceIdx;

- (NSString*)serviceMaxWeight:(int)serviceIdx;

- (NSString*)serviceRateScale:(int)serviceIdx;

- (NSString*)serviceRateZone:(int)serviceIdx;

- (int)serviceType:(int)serviceIdx;

- (NSString*)serviceTypeDescription:(int)serviceIdx;

- (NSString*)serviceShipTime:(int)serviceIdx;

- (NSString*)serviceSignatureType:(int)serviceIdx;

- (NSString*)serviceTransitTime:(int)serviceIdx;

Default Value

"1.0"

Remarks

This property will contain the list of all available services that satisfy the rate request. It should be inspected after a call to GetRates. Each service has a , , , etc. tied to it.

ShipmentSpecialServices Property (EzRates Module)

Contains the collection of special services offered.

Syntax

public var shipmentSpecialServices: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipmentSpecialServices,setter=setShipmentSpecialServices:) long long shipmentSpecialServices;

- (long long)shipmentSpecialServices;
- (void)setShipmentSpecialServices :(long long)newShipmentSpecialServices;

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 Event Notification X
0x00000800L Extreme Length X
0x00001000L Food X
0x00002000L Freight Guarantee 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
0x0000000100000000LReturn Receipt X
0x0000000200000000LCertificate Of Mailing X
0x0000000400000000LSunday and Holiday Delivery X
0x0000000800000000LNo Weekend X
0x0000001000000000LRegistered Mail X
0x0000002000000000LPremium Service (Sunday/Holiday) X
0x0000004000000000LCommercial X
0x0000008000000000LDelivery Confirmation X
0x0000010000000000LInternational Traffic in Arms Regulations X
0x0000020000000000LReturn of Document X
0x0000040000000000LImport Control X
0x0000080000000000LCommercial Invoice Removal X
0x0000100000000000LExchange Forward X
0x0000200000000000LCarbon Neutral X
0x0000400000000000LDropoff at UPS Facility X

SSLAcceptServerCertEncoded Property (EzRates Module)

This is the certificate (PEM/Base64 encoded).

Syntax

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (EzRates Module)

This is the certificate (PEM/Base64 encoded).

Syntax

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (EzRates Module)

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

Syntax

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

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 designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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., PKCS#12 certificate store).

SSLCertStorePassword Property (EzRates Module)

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

Syntax

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (EzRates Module)

This is the type of certificate store for this certificate.

Syntax

public var sslCertStoreType: EzratesSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum EzratesSSLCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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 (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 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 PKCS#11 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.

SSLCertSubject Property (EzRates Module)

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

Syntax

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

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

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (EzRates Module)

This specifies the SSL/TLS implementation to use.

Syntax

public var sslProvider: EzratesSSLProviders {
  get {...}
  set {...}
}

public enum EzratesSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (EzRates Module)

This is the certificate (PEM/Base64 encoded).

Syntax

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (EzRates Module)

A timeout for the module.

Syntax

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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.

TotalWeight Property (EzRates Module)

Total shipment's weight.

Syntax

public var totalWeight: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=totalWeight,setter=setTotalWeight:) NSString* totalWeight;

- (NSString*)totalWeight;
- (void)setTotalWeight :(NSString*)newTotalWeight;

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

Config Method (EzRates Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)configurationString;

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.

GetRates Method (EzRates Module)

Returns rate information for a specified or all available services.

Syntax

public func getRates() throws -> Void
- (void)getRates;

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):

Returned values upon a successful reply are:

Reset Method (EzRates Module)

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

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

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

Error Event (EzRates Module)

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

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 Module)

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

Syntax

func onNotification(message: String)
- (void)onNotification:(NSString*)message;

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 Module)

Fired after the server presents its certificate to the client.

Syntax

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 Module)

Fired when secure connection progress messages are available.

Syntax

func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender SenderAddress addr = new SenderAddress addr.Address1 = "100 Somewhere St." addr.Address2 = "Ste 100" addr.City = "Raleigh" addr.State = "NC" addr.ZipCode = "27154" addr.CountryCode = "US"

The properties contained by this type are listed below.

Fields

address1
String

Default Value: ""

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

address2
String

Default Value: ""

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

addressFlags
Int32

Default Value: 0

Various flags that denote information about the address.

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

city
String

Default Value: ""

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

countryCode
String

Default Value: "US"

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 NameCountry 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 IslandsVG*
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 IslandsVG*
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 IslandsVG*
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 AntillesAN**
New Caledonia NC
New Zealand NZ
Nicaragua NI
Niger NE
Nigeria NG
Norman Island VG*
Northern Ireland GB**
Northern Mariana IslandsMP**
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 IslandsTC
U.S. Virgin Islands VI**
Uganda UG
Ukraine UA
Union Island VC**
United Arab EmiratesAE
United Kingdom GB**
United States US
Uruguay UY
Uzbekistan UZ
Vanuatu VU
Vatican City IT**
Venezuela VE
Vietnam VN
Wales GB**
Wallis & Futuna IslandsWF
Yemen YE
Zambia ZM
Zimbabwe ZW

* Not supported by USPS

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

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

state
String

Default Value: ""

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.

zipCode
String

Default Value: ""

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

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

Constructors

public init()

EzAccount Type

Represents the details of a shipper account.

Remarks

This type contains data describing the server and login information.

Example: Setting the fields of an account for FedEx servers EzAccount account = new EzAccount account.AccountNumber = "1234567" account.AuthorizationToken = "bearer_token_value" account.Server = "https://test.fedex.com"

The properties contained by this type are listed below.

Fields

accountNumber
String

Default Value: ""

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

authorizationToken
String

Default Value: ""

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

password
String

Default Value: ""

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.

server
String

Default Value: ""

URL for the server where the requests are sent.

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

userId
String

Default Value: ""

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

Constructors

public init()

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

autoDetect
Bool

Default Value: False

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

firewallType
FirewallTypes

Default Value: 0

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

host
String

Default Value: ""

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

password
String

Default Value: ""

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

port
Int32

Default Value: 0

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

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

user
String

Default Value: ""

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

Constructors

public init()

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements PackageDetail pckg = new PackageDetail pckg.Weight = "2.0" pckg.Description = "Your order for the 4D Shipping SDK" pckg.ShippingLabelFile = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields

baseCharge
String (read-only)

Default Value: ""

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

codAmount
String

Default Value: ""

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in ).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the . COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagesPackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by ) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

codFile
String

Default Value: ""

Filename and location to save the of this package to. This is applicable for package(s) that use the COD service.

When the is set to a valid path and filename, the contents of the are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then has to have .pdf extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

This property is only applicable to FedEx shipments.

codLabelB
Data (read-only)

Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

codLabel
String (read-only)

Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

codType
TPCODTypes

Default Value: 0

The code that indicates the type of funds that will be used for the COD payment for this package.

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., is set to a value other than "0.00").

Valid values are:

Value Description
codtpAny (0) Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1) Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2) Cashier's check or money order
codtpCompanyCheck (3) Company check - FedEx and Canada Post only
codtpPersonalCheck (4) Personal check - FedEx and Canada Post only

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

dangerousGoodsAccessible
Bool

Default Value: False

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This property is only applicable to FedEx shipments, and is required to be specified when the contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

  • Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The should be set to True.
  • Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The should be set to False.
The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services.

dangerousGoodsOptions
Int32

Default Value: 0

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:

Value Meaning
0x00000001 Hazardous Materials
0x00000002 Battery
0x00000004 Other Regulated Materials - Domestic (ORM-D)
0x00000008 Reportable Quantities
0x00000010 Small Quantity Exception
0x00000020 Limited Quantities Commodities

Note: This is only valid when using FedEx.

description_
String

Default Value: ""

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

girth
Int32

Default Value: 0

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

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

Note: For parcels, is the measurement of the longest dimension and and make up the other two dimensions. 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 property is set to ptNonRectangular. (In this case and 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 , , and are required for Priority Mail packages when the is set to psLarge.

height
Int32

Default Value: 0

The height of the package to be shipped.

For FedEx, the is optional, but recommended, if "Your Packaging" is used as . This is required if and 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 is provided in the request, then all other dimensions ( and ) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the property is set to ptNonRectangular. (In this case and must still be set). For parcels, is the measurement of the longest dimension and and make up the other two dimensions. 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 , , and are required for Priority Mail packages when the 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).

id
String

Default Value: ""

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

insuredValue
String

Default Value: ""

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

length
Int32

Default Value: 0

The length of the package to be shipped.

For FedEx, the is optional, but recommended, if "Your Packaging" is used as . This is required if and 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 is provided in the request, then all other dimensions ( and ) 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 property is set to ptNonRectangular. (In this case and must still be set).

Note: For parcels, the is the measurement of the longest dimension and and make up the other two dimensions. 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 , , and are required for Priority Mail packages when the 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).

netCharge
String

Default Value: ""

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

packagingType
TPackagingTypes

Default Value: 0

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

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 for the first package is used in label requests.

If the is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackagesLength, PackagesWidth, and PackagesHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the 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 make sure this is valid for all the following: SenderAddressCountryCode, RecipientAddressCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

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

ratingAggregate
String (read-only)

Default Value: ""

Rating aggregate applicable to this package.

reference
String

Default Value: ""

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:

Type valueMeaning
CR Customer Reference - this gets printed on shipping label and invoice.
BL Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice.
IN Invoice Number - this gets printed on shipping label and invoice.
PO Purchase Order Number - this gets printed on shipping label and invoice.
DN Department Number - this gets printed on shipping label and invoice.
SI Shipment Integrity - this gets printed on invoice only.
SN Store Number - this gets printed on shipping label and invoice.
IR Intracountry Reglatory Reference
EPC Electronic Product Code
RMA RMA Number

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:

Code Reference Number Type
AJ Accounts Receivable Customer Account
AT Appropriation Number
BM Bill of Lading Number
9V Collect on Delivery (COD) Number
ON Dealer Order Number
DP Department Number
3Q Food and Drug Administration (FDA) Product Code
IK Invoice Number
MK Manifest Key Number
MJ Model Number
PM Part Number
PC Production Code
PO Purchase Order Number
RQ Purchase Request Number
RZ Return Authorization Number
SA Salesperson Number
SE Serial Number
ST Store Number
TN Transaction Reference Number
EI Employer ID Number
TJ Federal Taxpayer ID No.
SY Social Security Number

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

returnReceiptB
Data (read-only)

Default Value: ""

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

returnReceipt
String (read-only)

Default Value: ""

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

returnReceiptFile
String

Default Value: ""

Filename and location to save the of this package to. This is applicable only if using UPS.

When the is set to a valid path and filename, the contents of the are written to disk upon successful response (if a return shipment).

The has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

shippingLabelB
Data (read-only)

Default Value: ""

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

shippingLabel
String (read-only)

Default Value: ""

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

shippingLabelFile
String

Default Value: ""

Filename and location to save the of this package to. When the is set to a valid path and filename, the contents of the are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

shippingLabelPart2B
Data (read-only)

Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format.

For instance, if the PackagesShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via PackagesShippingLabel property whereas Part 2 can be accessed via PackagesShippingLabelPart2 property.

shippingLabelPart2
String (read-only)

Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format.

For instance, if the PackagesShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via PackagesShippingLabel property whereas Part 2 can be accessed via PackagesShippingLabelPart2 property.

signatureType
TSignatureTypes

Default Value: 0

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

size
TPackages

Default Value: 0

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 SizeDescriptionServiceType
psRegularFor 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
psLargeFor 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
dsOversizePackage 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 , , and optionally (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.

specialServices
Int64

Default Value: 0

Contains the collection of special services offered on the package level. Valid values are:

Value Meaning FedEx FedEx FreightUPS
0x00000001 Appointment Delivery X
0x00000002 Dangerous Goods X X X
0x00000004 Dry Ice X
0x00000008 Priority Alert X
0x00000010 Non Standard Container X X
0x00000020 COD X X
0x00000040 Additional Handling X
0x00000080 Signature Option X
0x00000100 Alcohol X

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

  • Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
  • Dangerous Goods: Indicates that this package contains dangerous goods. When the contains this flag, then the is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
  • Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
  • Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
  • Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
  • COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the and must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

  • Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
  • Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the and , , and .

This property is not applicable to USPS or Canada Post.

totalDiscount
String (read-only)

Default Value: ""

Total Actual Discount applicable to this package.

This is normally specific to the FedEx PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

totalSurcharges
String (read-only)

Default Value: ""

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

trackingNumber
String (read-only)

Default Value: ""

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

weight
String

Default Value: "0.0"

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

width
Int32

Default Value: 0

The width of the package to be shipped.

For FedEx, the is optional, but recommended, if "Your Packaging" is used as . This is required if and 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 is provided in the request, then all other dimensions ( and ) are to be set as well.

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

Note: For parcels, is the measurement of the longest dimension and and make up the other two dimensions. 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 , , and are required for Priority Mail packages when the 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).

Constructors

public init()
public init(length: , width: , height: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

authScheme
ProxyAuthSchemes

Default Value: 0

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

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

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

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

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

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

autoDetect
Bool

Default Value: False

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

password
String

Default Value: ""

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

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

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

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

port
Int32

Default Value: 80

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

server
String

Default Value: ""

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

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

ssl
ProxySSLTypes

Default Value: 0

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.

user
String

Default Value: ""

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

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

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

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

Constructors

public init()
public init(server: , port: )
public init(server: , port: , user: , password: )

ServiceDetail Type

Indicates the rates and service details of a service.

Remarks

This type represents the details (on delivery time, rates, etc.) of a service type. The fields contained by this type are listed below.

Fields

accountBaseCharge
String (read-only)

Default Value: ""

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

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

accountNetCharge
String (read-only)

Default Value: ""

Net charge amount applied to a .

For FedEx, this is specific to the FedExAccountAccountNumber. After calling the GetRates method, the will be filled with the value of discounted net charge amount specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber 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

The UPS server response will contain negotiated rate(s) only for the qualified UPSAccountAccountNumbers. 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.

accountTotalDiscount
String (read-only)

Default Value: ""

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

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

accountTotalSurcharge
String (read-only)

Default Value: ""

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

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

aggregate
String (read-only)

Default Value: ""

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

businessDays
Int32 (read-only)

Default Value: 0

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.

commitments
String (read-only)

Default Value: ""

Service commitments for the when shipping to RecipientAddressCountryCode.

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

customerCenterCutoff
String (read-only)

Default Value: ""

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.

delayDays
Int32 (read-only)

Default Value: 0

Number of days the shipment is delayed in customs. This is only valid for UPS requests, and is returned for requests outside the US only and when the request indicates the query is in reference to a Non-Document type of shipment.

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

deliveryDate
String (read-only)

Default Value: ""

This indicates the shipment delivery date for the .

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.

deliveryDay
String (read-only)

Default Value: ""

Indicates the day of the week the shipment can be delivered when using the . Possible values are: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal-code supported countries and it will be returned if available.

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

This is not applicable to USPS.

deliveryTime
String (read-only)

Default Value: ""

Scheduled local delivery time. This is available only for UPS, and indicates the latest time of day the shipment will be delivered as guaranteed by UPS. Format: HH:MM:SS.

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

effectiveNetDiscount
String (read-only)

Default Value: ""

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

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

guaranteedDescription
String (read-only)

Default Value: ""

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned. This is populated when the GetShippingTime method is called for UPS only.

This method is also populated for Canada Post after the GetRates method is called. The returned value will either be "true" or "false" to indicate whether the delivery date is guaranteed.

holidays
Int32 (read-only)

Default Value: 0

Number of national holidays during transit. This is returned only for UPS when the shipment would be in transit during a national holiday. Holidays outside the US are taken into account. Returned for requests outside the US only.

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

indemnityCoverage
String (read-only)

Default Value: ""

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when TotalValue was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and TotalValue, if applicable. Otherwise it will be blank.

insuranceComment
String (read-only)

Default Value: ""

Explains why no InsuranceCost was returned in the response.

This property is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the in the response), but no was returned, then will contain text explaining why no value was returned for . It may be one of three reasons:

ValueMeaning
SERVICEInsurance is not available for this service.
DESTINATIONInsurance is not available to the given country via this service.
INSURED VALUEInsurance is available for the country and service, but not for the given value.

insuranceCost
String (read-only)

Default Value: ""

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

listBaseCharge
String (read-only)

Default Value: ""

Transportation charges before surcharges and discounts applied to a . After calling the GetRates method, the 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.

listNetCharge
String (read-only)

Default Value: ""

Net charge amount applied to a .

After calling the GetRates method, the 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.

listTotalDiscount
String (read-only)

Default Value: ""

Total discount amount applied to a . This applies only to FedEx. After calling the GetRates method, the 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.

listTotalSurcharge
String (read-only)

Default Value: ""

Total surcharge amount for all additional services applied to a .

After calling the GetRates method, the 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.

maxDimensions
String (read-only)

Default Value: ""

Maximum dimensions of a package allowed when sending to the RecipientAddressCountryCode. 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 RecipientAddressCountryCode via the indicated ServiceType.

maxWeight
String (read-only)

Default Value: ""

Maximum weight of package allowed when sending to the RecipientAddressCountryCode.

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 RecipientAddressCountryCode via the indicated ServiceType.

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

packagingType
String (read-only)

Default Value: ""

The mail service type when shipping to RecipientAddressCountryCode.

This is only valid for USPS international rate requests.

indicates what type of shipping service is being used for each InternationalService. may contain the following information:

PriorityPriority Mail rate.
FirstClassFirst Class rate.
ParcelPostParcel Post rate.
BPMBound Printed Matter rate (books, magazines).
MediaMedia Mail rate (CDs, movies, etc).
LibraryInter-library mail rate (not for public use).
ExpressExpress Mail rate.

rateScale
String (read-only)

Default Value: ""

Applicable rate scale for the .

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

rateZone
String (read-only)

Default Value: ""

Applicable rate zone for the .

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

restDays
Int32 (read-only)

Default Value: 0

Number of days the shipment is in rest due to non-business days. Returned for UPS requests outside the US only.

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

serviceType
ServiceTypes (read-only)

Default Value: 0

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)
stFedExFirst (140) For EU and APAC Regions only.
stFedExPriority (141) For EU and APAC Regions only.
stFedExPriorityExpress (142) For EU and APAC Regions only.
stFedExPriorityExpressFreight (143) For EU and APAC Regions only.
stFedExPriorityFreight (144) For EU and APAC Regions only.
stFedExEconomySelect (145) For UK only.

Valid values for UPS are:

Value Applicable for
stUnspecified (0)
stUPSFirstClass(35) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37) US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMailInnovations (38) All origins, requires a contract with Mail Innovations, single package shipments only
stUPSEconomyMailInnovations (39) All Origins, requires a contract with Mail Innovations, single package shipments only
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)
stUPSWorldwideExpressFreight (61) All Origins; Worldwide Express Freight
stUPSSurePostLessThan1LB (62) US Domestic Shipments, SurePost Less Than 1LB
stUPSSurePost1LBOrGreater (63) US Domestic Shipments, SurePost 1LB Or Greater
stUPSSurePostBPM (64) US Domestic Shipments, SurePost BPM (Bound Printed Matter)
stUPSSurePostMedia (65) US Domestic Shipments, SurePost Media
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) (USPS Only )
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only )
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSPriorityExpress (85) (Endicia only)
stUSPSRetailGround (86) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)
stUSPSGroundAdvantage (135)
stUSPSGroundAdvantageCubic (136)

Please note that the RequestedService stUSPSBPM (74) is no longer supported by 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)

serviceTypeDescription
String (read-only)

Default Value: ""

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 FEDEX_INTERNATIONAL_PRIORITY
21 INTERNATIONAL_ECONOMY
22 INTERNATIONAL_FIRST
23 INTERNATIONAL_PRIORITY_FREIGHT
24 INTERNATIONAL_ECONOMY_FREIGHT
25 EUROPE_FIRST_INTERNATIONAL_PRIORITY
26 SMART_POST
27 FEDEX_2_DAY_AM
28 FEDEX_FIRST_FREIGHT
30 FEDEX_FREIGHT_ECONOMY
31 FEDEX_FREIGHT_PRIORITY
32 FEDEX_INTERNATIONAL_PRIORITY_EXPRESS
33 FEDEX_INTERNATIONAL_CONNECT_PLUS
140 FEDEX_FIRST
141 FEDEX_PRIORITY
142 FEDEX_PRIORITY_EXPRESS
143 FEDEX_PRIORITY_EXPRESS_FREIGHT
144 FEDEX_PRIORITY_FREIGHT
145 FEDEX_ECONOMY_SELECT

shipDate
String (read-only)

Default Value: ""

Date UPS picks up the package from the origin. In the event the differs from the ShipDate provided in the request, a warning message will be returned.

This is only applicable to UPS GetShippingTime.

Format: YYYY-MM-DD.

shipTime
String (read-only)

Default Value: ""

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

signatureType
String (read-only)

Default Value: ""

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

Possible returned values are:

ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

transitTime
String (read-only)

Default Value: ""

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

Config Settings (EzRates Module)

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

EndiciaInsuranceType:   The Insurance type when using Endicia.

This will determine which type of insurance will be used when requesting a label through Endicia.

ValueMeaning
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 PackagesInsuredValue 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 USPSAccountServer as defined below.

0Live Requests to Production server (default)
1Test Requests to Sandbox server
2Test 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 USPSAccountAccountNumber, you should also have obtained a USPSAccountUserId and USPSAccountPassword 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:

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

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 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 , 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. If , the connection will be closed immediately after the server response is received.

The default value for KeepAlive is .

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 .

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.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

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.

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 .

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:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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 .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

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

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

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

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

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

LocalHost:   The name of the local host through which connections are initiated or accepted.

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

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the 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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

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.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

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 by default, but can be set to 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 cipher suite.

Returns the cipher suite 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 cipher suite strength.

Returns the strength of the cipher suite 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 cipher suite.

Returns the cipher suite 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:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore 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 .

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:

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

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 to mask sensitive data. The default is .

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.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (EzRates Module)

EzRates Errors

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