CanadaPostShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate domestic labels using Canada Post.

Syntax

class dshippingsdk.CanadaPostShip

Remarks

Generating a shipping label can be done by calling the get_package_label method. You will need to specify the package details, the Canada Post service to be used for shipping the package, the origin and destination information, and any other special services that should be associated with the shipment (such as COD, Return Shipment, Deliver to Post Office, etc.).

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

  1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
  2. Call transmit_shipments with the group_id for the shipment.
  3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

If you wish to cancel a package before you call transmit_shipments for that shipment, you can call cancel_shipment and the package will be voided.

In order to use this class you will need to have a CanadaPost canada_post_account_number, which is your customer number. You will also need to have signed up for the Developer Program and obtained a canada_post_user_id and canada_post_password.

Property List


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

canada_post_account_numberThe shipper's account number.
canada_post_contract_idThis property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.
canada_post_passwordPassword for logging in to the Server .
canada_post_serverURL for the server where the requests are sent.
canada_post_user_idUser Id for logging in to the Server .
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
group_idThe Group Id that will be associated with the shipment.
manifestImage of the manifest.
manifest_countThe number of records in the Manifest arrays.
manifest_account_numberThis is the 10-digit customer number of who mailed the package(s).
manifest_base_chargeThis is the total base cost for all shipments on the manifest.
manifest_cc_auth_codeThe authorization code received from the credit card issuer.
manifest_cc_auth_timestampThe date and time that the credit card company authorized the transaction.
manifest_cc_merchant_nameThe merchant name used when charging the credit card.
manifest_cc_merchant_urlThe URL for the merchant who charged the credit card.
manifest_cc_name_on_cardThe name on the card that was charged.
manifest_contract_idThis is the contract number that was used for pricing this manifest.
manifest_customer_referenceThis is the reference property provided by the client in the transmit shipments request.
manifest_dateThis is the date the manifest was generated.
manifest_destination_postal_codeThe Postal code of the post office where the shipment is to be dropped off.
manifest_gstThe Good and Services Tax (GST) for all shipments on the manifest.
manifest_hstThe Harmonized Sales Tax (HST) for all shipments on the manifest.
manifest_media_typeThis contains the media-type attribute for the URL .
manifest_net_chargeThis is the total amount due to Canada Post for all shipments on the manifest.
manifest_origin_idThis is the Canada Post identification number of the shipment's origin.
manifest_origin_nameThis is the descriptive name of the shipment's origin as printed on the manifest.
manifest_payor_account_numberThis is the 10-digit customer number of the customer who is paying for the shipment.
manifest_po_numberThis is the PO number used for billing and will be displayed on the manifest.
manifest_pstThe Provincial Sales Tax (PST) for all shipments on the manifest.
manifest_shipper_account_numberThis is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.
manifest_timeThis is the time when the manifest was generated.
manifest_total_discountThis is the total discount for all shipments on the manifest.
manifest_total_surchargeThis is the total surcharge for all shipments on the manifest.
manifest_urlThis property will contain the URL for the manifest.
manifest_fileThe location where the manifest files will be written.
notify_countThe number of records in the Notify arrays.
notify_emailEmail address of the recipient to be notified.
notify_flagsIdentifies the type of notification requested.
origin_postal_codeThe Postal Code of the client sending location when using the Canada Post provider.
package_countThe number of records in the Package arrays.
package_base_chargeActual Base Charge applicable to this package.
package_cod_amountThe COD monetary value for the package.
package_cod_fileFilename and location to save the CODLabel of this package to.
package_cod_labelImage of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
package_cod_typeThe code that indicates the type of funds that will be used for the COD payment for this package.
package_heightThe height of the package to be shipped.
package_insured_valueAmount of insurance requested for this package.
package_lengthThe length of the package to be shipped.
package_net_chargeActual Net Charge applicable to this package.
package_typeThe packaging type of the package being rated and/or shipped.
package_rating_aggregateRating aggregate applicable to this package.
package_referenceIndicates the package reference type and value, that associates this package (assigned by the customer).
package_return_receiptImage of the receipt for a return shipment.
package_return_receipt_fileFilename and location to save the ReturnReceipt of this package to.
package_shipping_labelImage of the shipping label for this package returned by the Server upon a successful ship response.
package_shipping_label_fileFilename and location to save the ShippingLabel of this package to.
package_signature_typeSpecifies one of the Delivery Signature Options requested for this package.
package_sizeSize of the package being mailed.
package_total_discountTotal Actual Discount applicable to this package.
package_total_surchargesTotal Actual Surcharges applicable to this package.
package_tracking_numberTracking number assigned to this package.
package_weightWeight of this package.
package_widthThe width of the package to be shipped.
payment_methodThe intended payment method when using Canada Post.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_userThis property contains a username if authentication is to be used for the proxy.
recipient_address1Street name.
recipient_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
recipient_cityName of city, town, etc.
recipient_country_codeCountry code.
recipient_postal_codeThis is identifies of a region (usually small) for mail/package delivery.
recipient_provinceProvince or state code.
recipient_companyIdentifies the contact person's company name.
recipient_first_nameSender's first name.
recipient_last_namePerson's last name.
recipient_middle_initialMiddle initial.
recipient_phoneIdentifies the contact person's phone number.
return_address1Street name.
return_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
return_cityName of city, town, etc.
return_postal_codeThis is identifies of a region (usually small) for mail/package delivery.
return_provinceProvince or state code.
return_companyIdentifies the contact person's company name.
return_first_nameSender's first name.
return_last_namePerson's last name.
return_middle_initialMiddle initial.
sender_address1Street name.
sender_address2A specific detail on the address (such as building, suite, apartment, floor number etc.
sender_cityName of city, town, etc.
sender_country_codeCountry code.
sender_postal_codeThis is identifies of a region (usually small) for mail/package delivery.
sender_provinceProvince or state code.
sender_companyIdentifies the contact person's company name.
sender_first_nameSender's first name.
sender_last_namePerson's last name.
sender_middle_initialMiddle initial.
sender_phoneIdentifies the contact person's phone number.
service_typeIdentifies the domestic service to use in a ship request.
ship_dateThe date on which the package will be tendered.
shipment_idThe unique identifier for this shipment.
shipment_special_servicesContains the collection of special services offered.
ssl_accept_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/Base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerThis specifies the SSL/TLS implementation to use.
ssl_server_cert_encodedThis is the certificate (PEM/Base64 encoded).
timeoutA timeout for the class.

Method List


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

cancel_shipmentCancels a shipment.
configSets or retrieves a configuration setting.
get_manifestGets the manifest info and file for the specified manifest.
get_package_labelGenerates a shipping label for the specified package.
resetResets the internal state of the class and all properties to their default values.
search_manifestsSearch for manifests within a given date range.
transmit_shipmentsSubmits the shipment information and retrieve the manifest for the specified GroupId.

Event List


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

on_errorInformation about errors during data delivery.
on_notificationNotification returned by the server upon successful request (if applicable).
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusFired when secure connection progress messages are available.

Config Settings


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

CanadaGstAmount[i]The amount of Goods and Services Tax (GST) for the service.
CanadaHstAmount[i]The amount of Harmonized Sales Tax (HST) for the service.
CanadaPstAmount[i]The amount of Provincial Sales Tax (PST) for the service.
CancelPickupUsed to cancel a previously schedule pickup.
CODIncludePostageIndicates whether the postage should be included in the COD amount.
CODRecipientAddress1The primary street address of the COD recipient.
CODRecipientAddress2The secondary street address of the COD recipient.
CODRecipientCityThe city of the COD recipient.
CODRecipientCompanyThe company of the COD recipient.
CODRecipientNameThe name of the COD recipient.
CODRecipientPostalCodeThe postal code of the COD recipient.
CODRecipientProvinceThe province of the COD recipient.
D2POOfficeIdThe post office ID where the package should be dropped off.
ExcludedShipmentsList of shipments to be excluded when closing shipments.
GetAllPickupRequestsUsed to return all pickup requests for an account.
GetPickupAvailablityUsed to check the availability of pickups.
GetPickupDetailsUsed to return additional details for a pickup.
GetPickupPriceUsed to get pricing for a pickup.
HasXPathDetermines whether a specific element exists in the document.
LabelImageTypeThe type of label to be requested.
LabelSizeThe size of the label.
PackageReturnTrackingNumber[i]The tracking number for the return shipment.
PaidByCustomerThe customer number of the customer who will be billed for the shipment.
PromoCodePromotional discount code.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RetryCountThe number of times the class will re-attempt a transaction.
RetryDelayThe amount of time the class will wait before retrying a transaction.
SchedulePickupUsed to schedule a pickup.
ShipmentVersionThe version of the CanadaPost shipping API to be used.
ShowPackagingInstructionsIndicates that the packaging instructions should be shown.
UpdatePickupUsed to update a previously scheduled pickup.
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 class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class 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 class.
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 class.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
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 class 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 class 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.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
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.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

canada_post_account_number Property

The shipper's account number.

Syntax

def get_canada_post_account_number() -> str: ...
def set_canada_post_account_number(value: str) -> None: ...

canada_post_account_number = property(get_canada_post_account_number, set_canada_post_account_number)

Default Value

""

Remarks

The shipper's account number.

This field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

canada_post_contract_id Property

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

Syntax

def get_canada_post_contract_id() -> str: ...
def set_canada_post_contract_id(value: str) -> None: ...

canada_post_contract_id = property(get_canada_post_contract_id, set_canada_post_contract_id)

Default Value

""

Remarks

This property is used to specify 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.

canada_post_password Property

Password for logging in to the Server .

Syntax

def get_canada_post_password() -> str: ...
def set_canada_post_password(value: str) -> None: ...

canada_post_password = property(get_canada_post_password, set_canada_post_password)

Default Value

""

Remarks

Password for logging in to the server.

This property must be set to the login password for your Canada Post account.

canada_post_server Property

URL for the server where the requests are sent.

Syntax

def get_canada_post_server() -> str: ...
def set_canada_post_server(value: str) -> None: ...

canada_post_server = property(get_canada_post_server, set_canada_post_server)

Default Value

"https://soa-gw.canadapost.ca/"

Remarks

URL for the server where the requests are sent.

By default this is set to Canada Post's production server: "https://soa-gw.canadapost.ca/"

canada_post_user_id Property

User Id for logging in to the Server .

Syntax

def get_canada_post_user_id() -> str: ...
def set_canada_post_user_id(value: str) -> None: ...

canada_post_user_id = property(get_canada_post_user_id, set_canada_post_user_id)

Default Value

""

Remarks

User Id for logging in to the canada_post_server.

This property must be set to the login username for your Canada Post account

firewall_auto_detect Property

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

Syntax

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

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

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

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

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

firewall_host Property

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

Syntax

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

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

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

Syntax

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

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

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

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

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

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

group_id Property

The Group Id that will be associated with the shipment.

Syntax

def get_group_id() -> str: ...
def set_group_id(value: str) -> None: ...

group_id = property(get_group_id, set_group_id)

Default Value

""

Remarks

This property is used to specify the Group Id that will be associated with the shipment.

This is a user specified value and may be a number or string up to 32 characters in length. It is used by Canada Post to group shipments together for reporting purposes. If the specified group does not exist, it will be created automatically by the Canada Post service.

This value is required when canada_post_contract_id is specified.

manifest Property

Image of the manifest.

Syntax

def get_manifest() -> str: ...

manifest = property(get_manifest, None)

Default Value

""

Remarks

This is the decoded binary image file of the Manifest and will be populated on a get_manifest call if manifest_file is not set.

This property is read-only.

manifest_count Property

The number of records in the Manifest arrays.

Syntax

def get_manifest_count() -> int: ...

manifest_count = property(get_manifest_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

manifest_account_number Property

This is the 10-digit customer number of who mailed the package(s).

Syntax

def get_manifest_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of who mailed the package(s).

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_base_charge Property

This is the total base cost for all shipments on the manifest.

Syntax

def get_manifest_base_charge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total base cost for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_auth_code Property

The authorization code received from the credit card issuer.

Syntax

def get_manifest_cc_auth_code(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The authorization code received from the credit card issuer.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_auth_timestamp Property

The date and time that the credit card company authorized the transaction.

Syntax

def get_manifest_cc_auth_timestamp(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The date and time that the credit card company authorized the transaction.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_merchant_name Property

The merchant name used when charging the credit card.

Syntax

def get_manifest_cc_merchant_name(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The merchant name used when charging the credit card.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_merchant_url Property

The URL for the merchant who charged the credit card.

Syntax

def get_manifest_cc_merchant_url(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The URL for the merchant who charged the credit card.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_cc_name_on_card Property

The name on the card that was charged.

Syntax

def get_manifest_cc_name_on_card(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The name on the card that was charged.

This will only be populated if a credit card was used to pay for the postage.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_contract_id Property

This is the contract number that was used for pricing this manifest.

Syntax

def get_manifest_contract_id(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the contract number that was used for pricing this manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_customer_reference Property

This is the reference property provided by the client in the transmit shipments request.

Syntax

def get_manifest_customer_reference(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the reference field provided by the client in the transmit shipments request.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_date Property

This is the date the manifest was generated.

Syntax

def get_manifest_date(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the date the manifest was generated.

The date format is as follows YYYY-MM-DD.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_destination_postal_code Property

The Postal code of the post office where the shipment is to be dropped off.

Syntax

def get_manifest_destination_postal_code(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Postal code of the post office where the shipment is to be dropped off.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_gst Property

The Good and Services Tax (GST) for all shipments on the manifest.

Syntax

def get_manifest_gst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Good and Services Tax (GST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_hst Property

The Harmonized Sales Tax (HST) for all shipments on the manifest.

Syntax

def get_manifest_hst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Harmonized Sales Tax (HST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_media_type Property

This contains the media-type attribute for the URL .

Syntax

def get_manifest_media_type(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This contains the media-type attribute for the manifest_url.

This will be populated after a call to transmit_shipments or search_manifests.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_net_charge Property

This is the total amount due to Canada Post for all shipments on the manifest.

Syntax

def get_manifest_net_charge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total amount due to Canada Post for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_origin_id Property

This is the Canada Post identification number of the shipment's origin.

Syntax

def get_manifest_origin_id(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the Canada Post identification number of the shipment's origin.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_origin_name Property

This is the descriptive name of the shipment's origin as printed on the manifest.

Syntax

def get_manifest_origin_name(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the descriptive name of the shipment's origin as printed on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_payor_account_number Property

This is the 10-digit customer number of the customer who is paying for the shipment.

Syntax

def get_manifest_payor_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of the customer who is paying for the shipment. This is often the same as the manifest_shipper_account_number.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_po_number Property

This is the PO number used for billing and will be displayed on the manifest.

Syntax

def get_manifest_po_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the PO number used for billing and will be displayed on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_pst Property

The Provincial Sales Tax (PST) for all shipments on the manifest.

Syntax

def get_manifest_pst(manifest_idx: int) -> str: ...

Default Value

""

Remarks

The Provincial Sales Tax (PST) for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_shipper_account_number Property

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

Syntax

def get_manifest_shipper_account_number(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_time Property

This is the time when the manifest was generated.

Syntax

def get_manifest_time(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the time when the manifest was generated.

The format for the time is HH:MM TZ.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_total_discount Property

This is the total discount for all shipments on the manifest.

Syntax

def get_manifest_total_discount(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total discount for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_total_surcharge Property

This is the total surcharge for all shipments on the manifest.

Syntax

def get_manifest_total_surcharge(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This is the total surcharge for all shipments on the manifest.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_url Property

This property will contain the URL for the manifest.

Syntax

def get_manifest_url(manifest_idx: int) -> str: ...

Default Value

""

Remarks

This property will contain the URL for the manifest.

This will be populated after a call to transmit_shipments or search_manifests.

The manifest_idx parameter specifies the index of the item in the array. The size of the array is controlled by the manifest_count property.

This property is read-only.

manifest_file Property

The location where the manifest files will be written.

Syntax

def get_manifest_file() -> str: ...
def set_manifest_file(value: str) -> None: ...

manifest_file = property(get_manifest_file, set_manifest_file)

Default Value

""

Remarks

This should contain the full path to where the manifest file will be written.

notify_count Property

The number of records in the Notify arrays.

Syntax

def get_notify_count() -> int: ...
def set_notify_count(value: int) -> None: ...

notify_count = property(get_notify_count, set_notify_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

notify_email Property

Email address of the recipient to be notified.

Syntax

def get_notify_email(notify_idx: int) -> str: ...
def set_notify_email(notify_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

notify_flags Property

Identifies the type of notification requested.

Syntax

def get_notify_flags(notify_idx: int) -> int: ...
def set_notify_flags(notify_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

Value Meaning
0x00000001 (On Shipment) An email notification is requested to be sent to the notify_email when the package is shipped.
0x00000002 (On Exception) An email notification should be sent to the notify_email when an exception occurs during package movement from origin to destination.
0x00000004 (On Delivery) An email notification is requested to be sent to the notify_email when the package is delivered.
0x00000008 (On Tender) An email notification is requested to be sent to the notify_email when the package is tendered.
0x00000010 (On Return) An email notification is requested to be sent to the notify_email when the package is returned.
0x00000020 (HTML) The email should be sent in HTML format.
0x00000040 (Text) The email should be sent in Text format.
0x00000080 (Wireless) The email should be sent in Wireless format.
0x00000200 (In Transit) An email notification is requested to be sent to the notify_email when the package is in transit.
0x00000400 (ADL) Alternate Delivery Location
0x00000800 (UAP) UAP Shipper.
0x00001000 (On Estimated Delivery) An email notification is requested to be sent to notify_email when the package was estimated to be delivered.

For FedEx notifications, the following flags apply:

  • On Shipment
  • On Exception
  • On Delivery
  • On Tender
  • On Estimated Delivery
  • HTML
  • Text
To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

  • On Shipment
  • On Exception
  • On Delivery
  • On Return
  • In Transit
  • ADL
  • UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

The notify_idx parameter specifies the index of the item in the array. The size of the array is controlled by the notify_count property.

origin_postal_code Property

The Postal Code of the client sending location when using the Canada Post provider.

Syntax

def get_origin_postal_code() -> str: ...
def set_origin_postal_code(value: str) -> None: ...

origin_postal_code = property(get_origin_postal_code, set_origin_postal_code)

Default Value

""

Remarks

This property is used to specify the postal code of the client sending location to determine the nearest Post Office (this information is used for pricing). To force selection of a particular Post Office, the postal code of the desired Post Office should be used.

If packages are picked up by Canada Post enter the postal code of your location.

This must be set to a valid six character postal code such as A9A9A9

Note: This value is only used when a canada_post_contract_id is specified.

package_count Property

The number of records in the Package arrays.

Syntax

def get_package_count() -> int: ...
def set_package_count(value: int) -> None: ...

package_count = property(get_package_count, set_package_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

package_base_charge Property

Actual Base Charge applicable to this package.

Syntax

def get_package_base_charge(package_idx: int) -> str: ...

Default Value

""

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the payor_account_number. 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: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_cod_amount Property

The COD monetary value for the package.

Syntax

def get_package_cod_amount(package_idx: int) -> str: ...
def set_package_cod_amount(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

For UPS, if the package_cod_amount 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 package_cod_type. 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 package_type Letter/Envelope. COD special service is available for shipper's with pickup_type 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by package_signature_type) 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_cod_file Property

Filename and location to save the CODLabel of this package to.

Syntax

def get_package_cod_file(package_idx: int) -> str: ...
def set_package_cod_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

When the package_cod_file is set to a valid path and filename, the contents of the package_cod_label are written to disk when either the get_package_label or get_shipment_labels method is called.

This filename should have the same extension defined by label_image_type (for example, if label_image_type is set to PDF, then package_cod_file 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_cod_label Property

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

Syntax

def get_package_cod_label(package_idx: int) -> bytes: ...

Default Value

""

Remarks

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 get_package_label or the get_shipment_labels method is called. The kind of label data returned depends on the label formatting specified in your ship request via label_image_type. 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 package_cod_file is set to a valid path and filename, the label is also saved to disk in a label_image_type format.

Since MPS Ground packages do not travel together and may be delivered at different times, a package_cod_label 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_cod_type Property

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

Syntax

def get_package_cod_type(package_idx: int) -> int: ...
def set_package_cod_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_height Property

The height of the package to be shipped.

Syntax

def get_package_height(package_idx: int) -> int: ...
def set_package_height(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The height of the package to be shipped.

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

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

Note also that this applies to Endicia shipping label requests.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_insured_value Property

Amount of insurance requested for this package.

Syntax

def get_package_insured_value(package_idx: int) -> str: ...
def set_package_insured_value(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_length Property

The length of the package to be shipped.

Syntax

def get_package_length(package_idx: int) -> int: ...
def set_package_length(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The length of the package to be shipped.

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

Note: For parcels, the package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth 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 package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_net_charge Property

Actual Net Charge applicable to this package.

Syntax

def get_package_net_charge(package_idx: int) -> str: ...
def set_package_net_charge(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the payor_account_number. 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: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, 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 get_rates, 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_type Property

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

Syntax

def get_package_type(package_idx: int) -> int: ...
def set_package_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

Possible values are:

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

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

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

If the package_packaging_type is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: package_length, package_width, and package_height.

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

Also the following restrictions apply when using UPS Mail Innovations:

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

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

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_rating_aggregate Property

Rating aggregate applicable to this package.

Syntax

def get_package_rating_aggregate(package_idx: int) -> str: ...

Default Value

""

Remarks

Rating aggregate applicable to this package.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_reference Property

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

Syntax

def get_package_reference(package_idx: int) -> str: ...
def set_package_reference(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_return_receipt Property

Image of the receipt for a return shipment.

Syntax

def get_package_return_receipt(package_idx: int) -> bytes: ...

Default Value

""

Remarks

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 package_return_receipt_file is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_return_receipt_file Property

Filename and location to save the ReturnReceipt of this package to.

Syntax

def get_package_return_receipt_file(package_idx: int) -> str: ...
def set_package_return_receipt_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_shipping_label Property

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

Syntax

def get_package_shipping_label(package_idx: int) -> bytes: ...

Default Value

""

Remarks

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 label_image_type. 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 package_shipping_label_file is set to a valid path and filename, the label is also saved to disk in a label_image_type format.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_shipping_label_file Property

Filename and location to save the ShippingLabel of this package to.

Syntax

def get_package_shipping_label_file(package_idx: int) -> str: ...
def set_package_shipping_label_file(package_idx: int, value: str) -> None: ...

Default Value

""

Remarks

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

This filename should have the same extension defined by label_image_type (for example, if label_image_type is set to GIF, then package_shipping_label_file 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).

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_signature_type Property

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

Syntax

def get_package_signature_type(package_idx: int) -> int: ...
def set_package_signature_type(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

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

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

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_size Property

Size of the package being mailed.

Syntax

def get_package_size(package_idx: int) -> int: ...
def set_package_size(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

Size of the package being mailed.

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

See below for valid entries:

Package SizeDescriptionservice_type
psRegularFor Priority Mail: Package is less than one cubic foot in size. For all other service_types: 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 service_types: 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 package_length, package_height, package_width and optionally package_girth (irregular shaped packages only) properties to specify the dimensions of the package.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_total_discount Property

Total Actual Discount applicable to this package.

Syntax

def get_package_total_discount(package_idx: int) -> str: ...

Default Value

""

Remarks

Total Actual Discount applicable to this package.

This is normally specific to the FedEx payor_account_number. 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: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_total_surcharges Property

Total Actual Surcharges applicable to this package.

Syntax

def get_package_total_surcharges(package_idx: int) -> str: ...

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the payor_account_number. 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: package_base_charge, package_net_charge, package_total_surcharges, and package_total_discount, 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.

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_tracking_number Property

Tracking number assigned to this package.

Syntax

def get_package_tracking_number(package_idx: int) -> str: ...

Default Value

""

Remarks

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

This property is read-only.

package_weight Property

Weight of this package.

Syntax

def get_package_weight(package_idx: int) -> str: ...
def set_package_weight(package_idx: int, value: str) -> None: ...

Default Value

"0.0"

Remarks

Weight of this package.

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

For UPS, this is required to be provided in the request for each package contained in the shipment if package_packaging_type 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 service_type stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the service_type stUPSExpeditedMailInovations is used with the package_packaging_type 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 postage_provider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

package_width Property

The width of the package to be shipped.

Syntax

def get_package_width(package_idx: int) -> int: ...
def set_package_width(package_idx: int, value: int) -> None: ...

Default Value

0

Remarks

The width of the package to be shipped.

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

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

Note: For parcels, package_length is the measurement of the longest dimension and package_width and package_height make up the other two dimensions. package_girth 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 package_length, package_width, and package_height are required for Priority Mail packages when the package_size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

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

The package_idx parameter specifies the index of the item in the array. The size of the array is controlled by the package_count property.

payment_method Property

The intended payment method when using Canada Post.

Syntax

def get_payment_method() -> int: ...
def set_payment_method(value: int) -> None: ...

payment_method = property(get_payment_method, set_payment_method)

Default Value

0

Remarks

This field is used to specify the intended method of payment when shipping via Canada Post.

The available values are:

Value Meaning
0 (default) Account
1 Credit Card

Note: This value is only used when a canada_post_contract_id is specified.

proxy_auth_scheme Property

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

Syntax

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

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

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

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

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

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

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

proxy_auto_detect Property

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

Syntax

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

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

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

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

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

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

proxy_port Property

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

Syntax

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

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

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

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

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

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

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

proxy_user Property

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

Syntax

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

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

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

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

recipient_address1 Property

Street name.

Syntax

def get_recipient_address1() -> str: ...
def set_recipient_address1(value: str) -> None: ...

recipient_address1 = property(get_recipient_address1, set_recipient_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

recipient_address2 Property

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

Syntax

def get_recipient_address2() -> str: ...
def set_recipient_address2(value: str) -> None: ...

recipient_address2 = property(get_recipient_address2, set_recipient_address2)

Default Value

""

Remarks

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

Maximum Length: 44 characters

recipient_city Property

Name of city, town, etc.

Syntax

def get_recipient_city() -> str: ...
def set_recipient_city(value: str) -> None: ...

recipient_city = property(get_recipient_city, set_recipient_city)

Default Value

""

Remarks

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

recipient_country_code Property

Country code.

Syntax

def get_recipient_country_code() -> str: ...
def set_recipient_country_code(value: str) -> None: ...

recipient_country_code = property(get_recipient_country_code, set_recipient_country_code)

Default Value

"CA"

Remarks

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

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.

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

recipient_postal_code Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

def get_recipient_postal_code() -> str: ...
def set_recipient_postal_code(value: str) -> None: ...

recipient_postal_code = property(get_recipient_postal_code, set_recipient_postal_code)

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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

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

recipient_province Property

Province or state code.

Syntax

def get_recipient_province() -> str: ...
def set_recipient_province(value: str) -> None: ...

recipient_province = property(get_recipient_province, set_recipient_province)

Default Value

""

Remarks

Province or state code. This is the identifying abbreviation for Canada province, US state, 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.

This is required when recipient_country_code is either CA or US.

recipient_company Property

Identifies the contact person's company name.

Syntax

def get_recipient_company() -> str: ...
def set_recipient_company(value: str) -> None: ...

recipient_company = property(get_recipient_company, set_recipient_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either recipient_first_name and recipient_last_name or recipient_company are required to be provided.

recipient_first_name Property

Sender's first name.

Syntax

def get_recipient_first_name() -> str: ...
def set_recipient_first_name(value: str) -> None: ...

recipient_first_name = property(get_recipient_first_name, set_recipient_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent.

recipient_last_name Property

Person's last name.

Syntax

def get_recipient_last_name() -> str: ...
def set_recipient_last_name(value: str) -> None: ...

recipient_last_name = property(get_recipient_last_name, set_recipient_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either recipient_first_name and recipient_last_name or recipient_company must be sent. Maximum length: 45 characters for both names or company name.

recipient_middle_initial Property

Middle initial.

Syntax

def get_recipient_middle_initial() -> str: ...
def set_recipient_middle_initial(value: str) -> None: ...

recipient_middle_initial = property(get_recipient_middle_initial, set_recipient_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

recipient_phone Property

Identifies the contact person's phone number.

Syntax

def get_recipient_phone() -> str: ...
def set_recipient_phone(value: str) -> None: ...

recipient_phone = property(get_recipient_phone, set_recipient_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

return_address1 Property

Street name.

Syntax

def get_return_address1() -> str: ...
def set_return_address1(value: str) -> None: ...

return_address1 = property(get_return_address1, set_return_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

return_address2 Property

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

Syntax

def get_return_address2() -> str: ...
def set_return_address2(value: str) -> None: ...

return_address2 = property(get_return_address2, set_return_address2)

Default Value

""

Remarks

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

Maximum Length: 44 characters

return_city Property

Name of city, town, etc.

Syntax

def get_return_city() -> str: ...
def set_return_city(value: str) -> None: ...

return_city = property(get_return_city, set_return_city)

Default Value

""

Remarks

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

return_postal_code Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

def get_return_postal_code() -> str: ...
def set_return_postal_code(value: str) -> None: ...

return_postal_code = property(get_return_postal_code, set_return_postal_code)

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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

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

return_province Property

Province or state code.

Syntax

def get_return_province() -> str: ...
def set_return_province(value: str) -> None: ...

return_province = property(get_return_province, set_return_province)

Default Value

""

Remarks

Province or state code. This is the identifying abbreviation for Canada province, US state, 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.

This is required when return_country_code is either CA or US.

return_company Property

Identifies the contact person's company name.

Syntax

def get_return_company() -> str: ...
def set_return_company(value: str) -> None: ...

return_company = property(get_return_company, set_return_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either return_first_name and return_last_name or return_company are required to be provided.

return_first_name Property

Sender's first name.

Syntax

def get_return_first_name() -> str: ...
def set_return_first_name(value: str) -> None: ...

return_first_name = property(get_return_first_name, set_return_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either return_first_name and return_last_name or return_company must be sent.

return_last_name Property

Person's last name.

Syntax

def get_return_last_name() -> str: ...
def set_return_last_name(value: str) -> None: ...

return_last_name = property(get_return_last_name, set_return_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either return_first_name and return_last_name or return_company must be sent. Maximum length: 45 characters for both names or company name.

return_middle_initial Property

Middle initial.

Syntax

def get_return_middle_initial() -> str: ...
def set_return_middle_initial(value: str) -> None: ...

return_middle_initial = property(get_return_middle_initial, set_return_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sender_address1 Property

Street name.

Syntax

def get_sender_address1() -> str: ...
def set_sender_address1(value: str) -> None: ...

sender_address1 = property(get_sender_address1, set_sender_address1)

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

sender_address2 Property

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

Syntax

def get_sender_address2() -> str: ...
def set_sender_address2(value: str) -> None: ...

sender_address2 = property(get_sender_address2, set_sender_address2)

Default Value

""

Remarks

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

Maximum Length: 44 characters

sender_city Property

Name of city, town, etc.

Syntax

def get_sender_city() -> str: ...
def set_sender_city(value: str) -> None: ...

sender_city = property(get_sender_city, set_sender_city)

Default Value

""

Remarks

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

sender_country_code Property

Country code.

Syntax

def get_sender_country_code() -> str: ...
def set_sender_country_code(value: str) -> None: ...

sender_country_code = property(get_sender_country_code, set_sender_country_code)

Default Value

"CA"

Remarks

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

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.

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

sender_postal_code Property

This is identifies of a region (usually small) for mail/package delivery.

Syntax

def get_sender_postal_code() -> str: ...
def set_sender_postal_code(value: str) -> None: ...

sender_postal_code = property(get_sender_postal_code, set_sender_postal_code)

Default Value

""

Remarks

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

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

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

sender_province Property

Province or state code.

Syntax

def get_sender_province() -> str: ...
def set_sender_province(value: str) -> None: ...

sender_province = property(get_sender_province, set_sender_province)

Default Value

""

Remarks

Province or state code. This is the identifying abbreviation for Canada province, US state, 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.

This is required when sender_country_code is either CA or US.

sender_company Property

Identifies the contact person's company name.

Syntax

def get_sender_company() -> str: ...
def set_sender_company(value: str) -> None: ...

sender_company = property(get_sender_company, set_sender_company)

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either sender_first_name and sender_last_name or sender_company are required to be provided.

sender_first_name Property

Sender's first name.

Syntax

def get_sender_first_name() -> str: ...
def set_sender_first_name(value: str) -> None: ...

sender_first_name = property(get_sender_first_name, set_sender_first_name)

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent.

sender_last_name Property

Person's last name.

Syntax

def get_sender_last_name() -> str: ...
def set_sender_last_name(value: str) -> None: ...

sender_last_name = property(get_sender_last_name, set_sender_last_name)

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either sender_first_name and sender_last_name or sender_company must be sent. Maximum length: 45 characters for both names or company name.

sender_middle_initial Property

Middle initial.

Syntax

def get_sender_middle_initial() -> str: ...
def set_sender_middle_initial(value: str) -> None: ...

sender_middle_initial = property(get_sender_middle_initial, set_sender_middle_initial)

Default Value

""

Remarks

Middle initial. The value of this property is optional.

sender_phone Property

Identifies the contact person's phone number.

Syntax

def get_sender_phone() -> str: ...
def set_sender_phone(value: str) -> None: ...

sender_phone = property(get_sender_phone, set_sender_phone)

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

service_type Property

Identifies the domestic service to use in a ship request.

Syntax

def get_service_type() -> int: ...
def set_service_type(value: int) -> None: ...

service_type = property(get_service_type, set_service_type)

Default Value

0

Remarks

This property is required to be provided in a ship request.

Valid values for Canada Post are:

stCanadaRegularParcel (90)
stCanadaExpeditedParcel (91)
stCanadaXpresspost (92)
stCanadaLibrary (93)
stCanadaPriority (94)

ship_date Property

The date on which the package will be tendered.

Syntax

def get_ship_date() -> str: ...
def set_ship_date(value: str) -> None: ...

ship_date = property(get_ship_date, set_ship_date)

Default Value

""

Remarks

This property contains the expected ship date for the package(s).

shipment_id Property

The unique identifier for this shipment.

Syntax

def get_shipment_id() -> str: ...

shipment_id = property(get_shipment_id, None)

Default Value

""

Remarks

A unique identifier for the shipment. This can be used in any future calls to transmit_shipments, using the ExcludedShipments config to indicate that this shipment is to be excluded from the manifest.

This property is read-only.

shipment_special_services Property

Contains the collection of special services offered.

Syntax

def get_shipment_special_services() -> int: ...
def set_shipment_special_services(value: int) -> None: ...

shipment_special_services = property(get_shipment_special_services, set_shipment_special_services)

Default Value

0

Remarks

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

Value Meaning
0x0000000000000004L COD
0x0000000008000000L Return shipment
0x0000800000000000L Card for pickup
0x0001000000000000L Do not safe drop
0x0002000000000000L Deliver to post office
0x0004000000000000L Return at sender's expense
0x0008000000000000L Return to sender
0x0010000000000000L Abandon

COD

When set, this will request that the amount specified in package_cod_amount to be collected on delivery of the package, either in the form of cash, guaranteed funds, or by check, as specified in cod_type. After making a call to get_package_label, the COD label will stored in package_cod_label, unless package_cod_file has been set, in which case the label will be saved to the path specified. Note that the label will be in PDF format.

If you want Canada Post to automatically add the postage amount to the cod_total_amount, you can set the CODIncludePostage configuration setting to True. Also if you wish to have the COD payment returned to a different address than specified in sender_address you may specify the address to be printed on the COD return label using the following configuration settings:

Deliver to post office

When this is set, the package will be delivered directly to the Post Office specified by D2POOfficeId and the recipient will be notified that the package is ready to be picked up. When set, the following must also be set:

This only applies when using the service_type is set to stCanadaExpeditedParcel or stCanadaXpresspost.

Return Shipment

This indicates that a return shipment is requested. If you wish to have the return shipment go to a different address, you can set the return_address and return_contact properties.

Card for Pickup

When this is set, the package will be held at the post office and the recipient will be notified that their package is ready to be picked up. The recipient must show ID before they can pickup the package.

Do Not Safe Drop

Indicates that if no one is available to accept the package when delivery is attempted, a Delivery Notice Card is left and the recipient must pick up the package at the post office.

Return at Sender's Expense

This indicates that if unable to delivery the package, the package should be returned to the sender at the sender's expense.

Return to Sender

This indicates that if unable to delivery the package, the package should be returned to the sender.

Abandon

This indicates that if unable to delivery the package, the package should be abandoned.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

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

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

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

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

ssl_cert_store_password Property

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

Syntax

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

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

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

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (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 list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

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

Syntax

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

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

This property must be set after all other certificate 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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

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

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

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

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

cancel_shipment Method

Cancels a shipment.

Syntax

def cancel_shipment(shipment_id: str) -> None: ...

Remarks

This method cancels a shipment. The ShipmentId parameter is the value returned by the shipment_id property when get_package_label was called.

Note: This is only valid for shipments created using a contract (e.g. when canada_post_contract_id is specified) and must be called before transmit_shipments has been called for the specified shipment;

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

get_manifest Method

Gets the manifest info and file for the specified manifest.

Syntax

def get_manifest(manifest_idx: int) -> None: ...

Remarks

When called, this will populate the manifest details in manifest_details at the specified index, specified by ManifestIdx. It will also write the manifest file to the path specified in manifest_file.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

  1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
  2. Call transmit_shipments with the group_id for the shipment.
  3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

get_package_label Method

Generates a shipping label for the specified package.

Syntax

def get_package_label(package_index: int) -> None: ...

Remarks

When this method is called, the following properties must have been set:

To print out the package_shipping_label, you can save it to the package_shipping_label_file file in label_image_type format.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

  1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
  2. Call transmit_shipments with the group_id for the shipment.
  3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

reset Method

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

Syntax

def reset() -> None: ...

Remarks

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

search_manifests Method

Search for manifests within a given date range.

Syntax

def search_manifests(start_date: str, end_date: str) -> None: ...

Remarks

This will retrieve any manifests printed between the StartDate and EndDate and populates the manifest_url. The date must be specified in the format "YYYYMMDD".

transmit_shipments Method

Submits the shipment information and retrieve the manifest for the specified GroupId.

Syntax

def transmit_shipments() -> None: ...

Remarks

This will transmit the shipment information for the specified group_id and print the manifest for that shipment.

If you wish to get the manifest for more than one group, you can specify more than one group ID in a comma separated list in the group_id property.

The following properties must be set before making a call to transmit_shipments:

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

  1. Assign each shipment a group_id and then call get_package_label for each package in the shipment.
  2. Call transmit_shipments with the group_id for the shipment.
  3. Call get_manifest for each manifest in manifest_details.

Note that this only applies when submitting a contract shipment (ie. canada_post_contract_id is set).

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

Remarks

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

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

on_notification Event

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

Syntax

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

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

Remarks

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

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

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

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

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

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

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

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

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

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

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

Remarks

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

CanadaPostShip Config Settings

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

CanadaPostShip Config Settings

CanadaGstAmount[i]:   The amount of Goods and Services Tax (GST) for the service.

This field is populated after a call to get_package_label. This allows you to get the Goods and Services Tax (GST) amount of the specified package with i being the index of the current package.

Valid array indices are from 0 to PacakgeCount - 1.

Note that this config is read only.

CanadaHstAmount[i]:   The amount of Harmonized Sales Tax (HST) for the service.

This field is populated after a call to get_package_label. This allows you to get the Harmonized Sales Tax (HST) amount of the specified package with i being the index of the current package.

Valid array indices are from 0 to PacakgeCount - 1.

Note that this config is read only.

CanadaPstAmount[i]:   The amount of Provincial Sales Tax (PST) for the service.

This field is populated after a call to get_package_label. This allows you to get the Provincial Sales Tax (PST) amount of the specified package with i being the index of the current package.

Valid array indices are from 0 to PacakgeCount - 1.

Note that this config is read only.

CancelPickup:   Used to cancel a previously schedule pickup.

When set to the request-id from a previously schedule pickup class will cancel a previously schedule pickup. If the cancellation fails class will throw an exception.

CODIncludePostage:   Indicates whether the postage should be included in the COD amount.

If set to True, Canada Post will add the postage amount to the value set in cod_total_amount.

CODRecipientAddress1:   The primary street address of the COD recipient.

This specifies the primary address of the COD Recipient, which will be printed on the COD label.

CODRecipientAddress2:   The secondary street address of the COD recipient.

This specifies the secondary address of the COD Recipient, which will be printed on the COD label.

CODRecipientCity:   The city of the COD recipient.

This specifies the city of the COD Recipient, which will be printed on the COD label.

CODRecipientCompany:   The company of the COD recipient.

This specifies the company of the COD Recipient, which will be printed on the COD label.

CODRecipientName:   The name of the COD recipient.

This specifies the name of the COD Recipient, which will be printed on the COD label.

CODRecipientPostalCode:   The postal code of the COD recipient.

This specifies the postal code of the COD Recipient, which will be printed on the COD label.

CODRecipientProvince:   The province of the COD recipient.

This specifies the province of the COD Recipient, which will be printed on the COD label.

D2POOfficeId:   The post office ID where the package should be dropped off.

This should be set to the Post Office ID for the Post Office that the package should be dropped off at when the Deliver to Post Office shipment_special_services flag is set.

ExcludedShipments:   List of shipments to be excluded when closing shipments.

This is used in the transmit_shipments method to specify which shipments are to be excluded being closed. This should be a comma separated list of the tracking numbers for the shipments that should be excluded.

GetAllPickupRequests:   Used to return all pickup requests for an account.

When queried this will return all pickup requests for the account specified with canada_post_account_number. The RawResponse will contain the response from the server and can be parsed with XPath.

GetPickupAvailablity:   Used to check the availability of pickups.

When set to a postal code the class will get the availability of pickups. The RawResponse will contain the response from the server and can be parsed with XPath. canadapostship1.Config("GetPickupAvailability=K2B8J6");

GetPickupDetails:   Used to return additional details for a pickup.

When set to the request-id from a previously schedule pickup class will return additional details for a pickup. The RawResponse will contain the response from the server and can be parsed with XPath.

GetPickupPrice:   Used to get pricing for a pickup.

When set to a pickup-request-details aggregate class will get the pricing details for a specific pickup request. The RawResponse will contain the response from the server and can be parsed with XPath. Example: string xml = @"<pickup-details xmlns='http://www.canadapost.ca/ws/pickuprequest'> <date>2019-07-18</date> <pww-flag>false</pww-flag> <priority-flag>false</priority-flag> </pickup-details>"; canadapostship1.Config("GetPickupPrice=" + xml); Documentation for pickup-request-details can be found here: https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/parcelpickup/pickupprice.jsf

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.

LabelImageType:   The type of label to be requested.

If canada_post_contract_id is specified, you can set the type of label to one of the following values:

Value Meaning
0 No encoding specified (defaults to PDF)
1 PDF
2 ZPL (Thermal Label, requires that label size is 4x6)

Requires that ShipmentVersion be set to 6.

LabelSize:   The size of the label.

If canada_post_contract_id is specified, you can set the label size to one of the following values:

Value Meaning
0 8.5x11 paper label
1 4x6 thermal label

PackageReturnTrackingNumber[i]:   The tracking number for the return shipment.

This is set to the tracking number for the return shipment if a return shipment was requested.

Note that this config is read only.

PaidByCustomer:   The customer number of the customer who will be billed for the shipment.

By default, this field is not sent in the request and the canada_post_account_number is billed for the shipment. This is the typical case, but this configuration setting can be used to identify a different paid-by account to use.

PromoCode:   Promotional discount code.

This provides the promotional discount code. Note that a promotion code is only valid for a certain period and product.

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.

RetryCount:   The number of times the component will re-attempt a transaction.

This field is used to specify the number of times that the component will re-try a transaction due to an empty response. The default value is 3.

RetryDelay:   The amount of time the component will wait before retrying a transaction.

This field is used to specify the number of milliseconds the component will delay before retrying a transaction. The default value is 500 (milliseconds).

SchedulePickup:   Used to schedule a pickup.

When set to a pickup-request-details aggregate class will make a request to schedule a pickup. The RawResponse will contain the response from the server and can be parsed with XPath. Example: string xml = @"<pickup-request-details xmlns='http://www.canadapost.ca/ws/pickuprequest'> <pickup-type>OnDemand</pickup-type> <pickup-location> <business-address-flag>false</business-address-flag> <alternate-address> <company>Jim Duggan</company> <address-line-1>2271 Herring Cove</address-line-1> <city>Halifax</city> <province>NS</province> <postal-code>B3L2C2</postal-code> </alternate-address> </pickup-location> <contact-info> <contact-name>John Doe</contact-name> <email>john.doe@canadapost.ca</email> <contact-phone>800-555-1212</contact-phone> </contact-info> <location-details> <five-ton-flag>false</five-ton-flag> <loading-dock-flag>true</loading-dock-flag> <pickup-instructions>Door at Back</pickup-instructions> </location-details> <items-characteristics> <pww-flag>true</pww-flag> <priority-flag>false</priority-flag> <returns-flag>true</returns-flag> <heavy-item-flag>true</heavy-item-flag> </items-characteristics> <pickup-volume>50</pickup-volume> <pickup-times> <on-demand-pickup-time> <date>2015-01-28</date> <preferred-time>15:00</preferred-time> <closing-time>17:00</closing-time> </on-demand-pickup-time> </pickup-times> </pickup-request-details>"; canadapostship1.Config("SchedulePickup=" + xml); Documentation for pickup-request-details can be found here: https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/parcelpickup/createpickup.jsf

ShipmentVersion:   The version of the CanadaPost shipping API to be used.

This configuration setting can be used to specify the version of the CanadaPost Shipping API that is to be used in the request.

ShowPackagingInstructions:   Indicates that the packaging instructions should be shown.

When set to True, Canada Post will show the packaging instructions on the label.

UpdatePickup:   Used to update a previously scheduled pickup.

When set to the request-id and a pickup-request-update aggregate (separated by a semi-colon) class will update a previously scheduled pickup. If the update fails class will throw an exception. Example: string reqId = "1234567890"; string xml = @"<pickup-request-update xmlns='http://www.canadapost.ca/ws/pickuprequest'> <contact-info> <contact-name>Jane Doe</contact-name> <email>john.doe@canadapost.ca</email> <contact-phone>800-555-1212</contact-phone> <receive-email-updates-flag>true</receive-email-updates-flag> </contact-info> <location-details> <five-ton-flag>false</five-ton-flag> <loading-dock-flag>true</loading-dock-flag> <pickup-instructions>Door at Back</pickup-instructions> </location-details> <items-characteristics> <heavy-item-flag>true</heavy-item-flag> </items-characteristics> <pickup-volume>50</pickup-volume> <pickup-times> <on-demand-pickup-time> <date>2015-01-28</date> <preferred-time>15:00</preferred-time> <closing-time>17:00</closing-time> </on-demand-pickup-time> </pickup-times> </pickup-request-update>"; canadapostship1.Config("UpdatePickup=" + reqId + ";" + xml); Documentation for pickup-request-details can be found here: https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/parcelpickup/updatepickup.jsf

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 http_version is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

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

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

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

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

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

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

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

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

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

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

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

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

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

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

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

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

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

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

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

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

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. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

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

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

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

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

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

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

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

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

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

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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 fails with an error.

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

LingerTime:   Time in seconds to have the connection linger.

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

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

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

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

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

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

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

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

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

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

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

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

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

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

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

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

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

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.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 ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider 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 True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated 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 ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

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

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

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

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

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

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

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

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

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

CanadaPostShip Errors

CanadaPostShip Errors

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

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