The Net Tools Company - 800.225.4190
Search: 
Available in: USPS
InternationalRates Component [IBiz USPS Integrator V2]

Properties   Methods   Events   Configuration Settings  

Determine international postage rates based on weight, class of mail, and origin/destination information.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component provides automated online access to international rate information. These rates are for: International Priority Mail, International Express Mail (EMS), and International First Class Mail, along with service standards for each class of service.

To use this component to receive rate information, simply set the PackagePounds, PackageOunces, MailType, and DestinationCountry, and then call CalculatePostage. For example:

   
  InternationalRates1.PackagePounds = 0
  InternationalRates1.PackageOunces = 1
  InternationalRates1.MailType = mtPackage
  InternationalRates1.DestinationCountry = "Canada"
  InternationalRates1.CalculatePostage()

In response to this request, the USPS Server will return a list of services available for mailing your package. You can access these services through the array properties listed below. Indices for the services start at 0, and the total number of services returned is indicated by the ServiceCount property.

Please note that in most cases international packages may need a Customs Declaration form, and packages may also be subject to mailing restrictions unique to the destination country. To assist you with this important information, the International Rates component will return all the necessary mailing Restrictions, Prohibitions, and Observations, names of required CustomsForms, as well as delivery AreasServed.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

AreasServed Areas where the MailType service is available when shipped to DestinationCountry.
CustomsForms Customs forms required to mail to DestinationCountry.
DestinationCountry Country the package is to be shipped to.
ExpressMail Express Mail information when shipping to DestinationCountry.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
IndemnityCoverage Indicates the indemnity coverage available for this service.
InsuranceComment Explains why no InsuranceCost was returned in the response.
InsuranceCost Insurance fee.
MailType The mail type for international shipments.
MaxDimensions Maximum dimensions of a package allowed when sending to the DestinationCountry.
MaxWeight Maximum weight of package allowed when sending to the DestinationCountry.
Observations Additional mailing information based on country of destination.
PackageOunces Estimated weight of the package to be mailed - ounce portion.
PackagePounds Estimated weight of the package to be mailed - pounds portion.
Password Password to use for logging in to the USPS Server.
Postage Postage rate charged by USPS for a ServiceMailType when shipping to DestinationCountry.
Prohibitions List of items prohibited from mailing to the destination country.
Restrictions Restrictions on items being shipped based on country of destination
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
Server URL for the USPS server where the requests are sent.
ServiceCommitments Service commitments for the ServiceMailType when shipping to DestinationCountry.
ServiceCount Number of all mail services available, as returned by USPS Server
ServiceDescription Description of the service available when shipping to DestinationCountry.
ServiceId Integer representation of the service available when shipping to DestinationCountry.
ServiceMailType The mail service type when shipping to DestinationCountry.
Timeout A timeout for the component.
UserId User ID for logging in to the USPS Server.
ValueOfContents Total value of the items inside the package.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

CalculatePostage Calculates postage rates to ship a package to a given DestinationCountry.
Config Sets or retrieves a component configuration setting.
Reset Reset the internal state of the component and all properties to their default values.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error Information about errors during data delivery.
SSLServerAuthentication Fired after the server presents its certificate to the client.
SSLStatus Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
FullResponse Contains the full response returned by the USPS server.
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
OpenSSLCADir The path to a directory containing CA certificates.
OpenSSLCAFile Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData The data to seed the pseudo random number generator(PRNG).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if Basic authentication is to be used for the proxy.
SSLCipherStrength The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols Used to enable/disable the supported security protocols.
SSLProvider The name of the security provider to use.
SSLSecurityFlags Flags that control certificate verification
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)
XPath Used to retrieve data at any place within the response.

| About | Privacy Policy | Terms of Use |
© Copyright 2011 /n software inc.