USPSShipIntl Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode. Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.

Syntax

TibxUSPSShipIntl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Return Shipment, etc.), and any other specific information on international shipments.

Postage Provider Notes

ppNone

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

• Set PostageProvider to ppNone (default).
• Set UserId to the UserId provided by USPS.
• Set Password to the password provided by USPS.
• Set Server to either the test or production server.

ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set AccountNumber to your production account number (provided by Endicia).
• Set Password to your production password (provided by Endicia).

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

In all cases the component will send requests to the correct server without setting Server.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

• Set PostageProvider to ppStamps.
• Set UserId to the sandbox or production user provided by Stamps.com.
• Set AccountNumber to the sandbox or production account number provided by Stamps.com.
• Set Password to the sandbox or production password provided by Stamps.com.
• Set Server to either the test or production server.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

BarcodeNumber Property (USPSShipIntl Component)

Barcode number associated with label's barcode.

Syntax

property BarcodeNumber: String read get_BarcodeNumber;

Default Value

''

Remarks

The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).

This property is read-only.

CertificateNumber Property (USPSShipIntl Component)

Certificate number (if known or included in the package).

Syntax

property CertificateNumber: String read get_CertificateNumber write set_CertificateNumber;

Default Value

''

Remarks

Some countries require a Certificate of Origin in order for certain items to be imported. (for example, fruits and vegetables). Restrictions as to what items require a Certificate Of Origin are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Comments Property (USPSShipIntl Component)

Comments on the package being shipped.

Syntax

property Comments: String read get_Comments write set_Comments;

Default Value

''

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Commodities Property (USPSShipIntl Component)

Items being shipped inside this package.

Syntax

property Commodities: TibxCommodityDetailList read get_Commodities write set_Commodities;

Remarks

This property should be set to the commodity types that are inside the package. Each commodity has a Description, HarmonizedCode, Manufacturer, Quantity, UnitPrice, and Weight.

For instance, to send a package containing 20 wheel bearings and 15 fork seals: component.CommodityCount = 2; component.CommodityDescription(0) = "Wheel bearings"; component.CommodityQuantity(0) = 20; component.CommodityValue(0) = "100.00"; // 20 bearings at $5 each component.CommodityWeight(0) = "10 lbs 0 oz"; // each wheel bearing is .5 lbs component.CommodityDescription(1) = "Fork seals"; component.CommodityQuantity(1) = 15; component.CommodityValue(1) = "375.00"; // 15 seals at $25 each component.CommodityWeight(1) = "3 lbs 8 oz"; // Total weight of all fork seals in the package.

Please note that Manufacturer and HarmonizedCode are only valid for commercial shippers, and may be left out. The remaining properties are all required.

This property is not available at design time.

Please refer to the CommodityDetail type for a complete list of fields.

Contents Property (USPSShipIntl Component)

Type of the contents in the package.

Syntax

property Contents: TibxContents read get_Contents write set_Contents;

TibxContents = (
  ctSample,
  ctGift,
  ctDocuments,
  ctReturn,
  ctOther,
  ctMerchandise,
  ctHumanitarianDonation,
  ctDangerousGoods,
  ctCrematedRemains,
  ctNonNegotiableDocument,
  ctPharmaceuticals,
  ctMedicalSupplies,
  ctHAZMAT,
  ctLives,
  ctPerishable
);

Default Value

ctSample

Remarks

You can set this property when generating labels to indicate the content type in the package.

Possible values are as follows:

Note that if Contents is set to ctOther, you may be required to set the OtherContents configuration setting with a description of the contents. For example:

component.Contents = ctOther component.Config("OtherContents=Livestock")

CustomerId Property (USPSShipIntl Component)

User-assigned number for internal use.

Syntax

property CustomerId: String read get_CustomerId write set_CustomerId;

Default Value

''

Remarks

You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.

For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.

ExtraServices Property (USPSShipIntl Component)

Contains the collection of extra services offered by USPS on shipment level.

Syntax

property ExtraServices: Int64 read get_ExtraServices write set_ExtraServices;

Default Value

0

Remarks

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

Firewall Property (USPSShipIntl Component)

A set of properties related to firewall access.

Syntax

property Firewall: TibxFirewall read get_Firewall write set_Firewall;

Remarks

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

Please refer to the Firewall type for a complete list of fields.

ImageLayout Property (USPSShipIntl Component)

Determines how the labels will be formatted for printing.

Syntax

property ImageLayout: TibxTImageLayouts read get_ImageLayout write set_ImageLayout;

TibxTImageLayouts = (
  ilOnePerFile,
  ilAllInOneFile,
  ilTrimOnePerFile,
  ilTrimAllInOneFile
);

Default Value

ilOnePerFile

Remarks

The LabelImageType property indicates the file type of the label that USPS returns. ImageLayout dictates how the label looks in that file. The labels returned by USPS measure 8.5" x 5.5", or exactly one half of a sheet of regular 8.5" x 11" paper. The layouts available are listed below:

For the ilAllInOneFile and ilTrimAllInOneFile ImageLayouts, only one file will be written. However, for the ilOnePerFile and ilTrimOnePerFile ImageLayouts, more than one shipping label may be returned, up to a maximum of 6 total pages. If ShippingLabelFile is specified, these additional pages will be saved with the page number appended to the ShippingLabelFile you supplied.

For instance, if the ShippingLabelFile is "c:\expresslabel.pdf", the following files will be created: "expresslabel.pdf", "expresslabel.page2.pdf", "expresslabel.page3.pdf", etcetera.

Note that for the stUSPSFirstClass ServiceType, only ilOnePerFile and ilAllInOneFile are supported. Using any of the Trim-values will result in an error from USPS.

ImportersContact Property (USPSShipIntl Component)

Identifies the importer's contact info.

Syntax

property ImportersContact: TibxContactDetail read get_ImportersContact write set_ImportersContact;

Remarks

The ImportersContact represents contact data identifying the importer. It can be provided in an international ship request only when the ServiceType is stUSPSExpressMailInternational (82) or stUSPSPriorityMailInternational (84).

The only necessary fields to be set for this type are the Email, Fax, and Phone.

This must be set to an instance of the ContactDetail type. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

IndemnityCoverage Property (USPSShipIntl Component)

Indicates the indemnity coverage for the package.

Syntax

property IndemnityCoverage: String read get_IndemnityCoverage;

Default Value

''

Remarks

This property is returned only for International Priority Mail packages, and only when the InsuredValue property was set to an amount greater than "0.00".

This property is read-only.

InsurancePolicy Property (USPSShipIntl Component)

Insurance number, if known.

Syntax

property InsurancePolicy: String read get_InsurancePolicy write set_InsurancePolicy;

Default Value

''

Remarks

If insurance has been purchased, this property should be set to the policy number.

This property is not applicable for International First Class mail.

InvoiceNumber Property (USPSShipIntl Component)

Invoice number if known or included in the package.

Syntax

property InvoiceNumber: String read get_InvoiceNumber write set_InvoiceNumber;

Default Value

''

Remarks

This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when PackagingType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

LabelImageType Property (USPSShipIntl Component)

Type of label image.

Syntax

property LabelImageType: TibxUSPSImageTypes read get_LabelImageType write set_LabelImageType;

TibxUSPSImageTypes = (
  sitNone,
  sitTIF,
  sitJPG,
  sitPDF,
  sitGIF,
  sitEPL,
  sitPNG,
  sitZPL,
  sitPDFVector,
  sitPDFVectorWithFonts,
  sitAZPL
);

Default Value

sitNone

Remarks

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitPDFVector (8)
• sitPDFVectorWithFonts (9)

Valid values for Stamps.com:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitAZPL (10)

LicenseNumber Property (USPSShipIntl Component)

Import License number if known, or included in package.

Syntax

property LicenseNumber: String read get_LicenseNumber write set_LicenseNumber;

Default Value

''

Remarks

Many countries require the sender to obtain a license in order to import certain items (for example, drugs or medical equipment). Restrictions as to what items require a license are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Machinable Property (USPSShipIntl Component)

Indicates if shipment is machinable or not.

Syntax

property Machinable: TibxUSPSMachinables read get_Machinable write set_Machinable;

TibxUSPSMachinables = (
  moTrue,
  moFalse,
  moIrregular
);

Default Value

moTrue

Remarks

The default value for this property is moTrue (0).

Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).

Possible values are as follows:

MailingLocation Property (USPSShipIntl Component)

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

property MailingLocation: String read get_MailingLocation write set_MailingLocation;

Default Value

''

Remarks

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (ZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

This way, you convey this difference to the USPS Server.

This property is not applicable for International First Class mail.

NonDeliveryOption Property (USPSShipIntl Component)

Indicates what to do with the package in case it is undeliverable.

Syntax

property NonDeliveryOption: TibxNonDeliveryOptions read get_NonDeliveryOption write set_NonDeliveryOption;

TibxNonDeliveryOptions = (
  ndoReturn,
  ndoRedirect,
  ndoAbandon
);

Default Value

ndoReturn

Remarks

In case the package is undeliverable, the package may be Returned, Redirected, or Abandoned.

This property is not applicable for International First Class mail (stUSPSFirstClassMailInternational (83) ).

Notes Property (USPSShipIntl Component)

Additional information returned by the USPS Server .

Syntax

property Notes: String read get_Notes;

Default Value

''

Remarks

This property may contain additional notes pertaining to the shipment of goods to the destination country (CountryCode).

This property is read-only.

Observations Property (USPSShipIntl Component)

Additional mailing information based on country of destination.

Syntax

property Observations: String read get_Observations;

Default Value

''

Remarks

Additional information that may be important to the sender. Returned by the USPS Server

This property is read-only.

Packages Property (USPSShipIntl Component)

A collection of packages contained in the shipment.

Syntax

property Packages: TibxPackageDetailList read get_Packages write set_Packages;

Remarks

At least one package must be specified.

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

For USPS, the PackagingType, Size, and Weight properties are required. Length, Width, Height, and Girth are all conditionally required, and more information may be found in the individual property definitions.

Note: USPS only supports one package per shipment.

This property is not available at design time.

Please refer to the PackageDetail type for a complete list of fields.

PermitNumber Property (USPSShipIntl Component)

Permit number to print Postage Due labels.

Syntax

property PermitNumber: String read get_PermitNumber write set_PermitNumber;

Default Value

''

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.

PostageProvider Property (USPSShipIntl Component)

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Syntax

property PostageProvider: TibxPostageProviders read get_PostageProvider write set_PostageProvider;

TibxPostageProviders = (
  ppNone,
  ppEndicia,
  ppStamps
);

Default Value

ppNone

Remarks

When set to ppNone, the component will communicate with USPS servers. When set to this value the following properties should also be set.

• Set UserId
• Set Password
• Set Server

When set to ppEndicia, the component will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set AccountNumber
• Set Password

For Testing

• Set EndiciaTestMode

When set to ppStamps, the component will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set UserId
• Set AccountNumber
• Set Password
• Set Server

PriceOption Property (USPSShipIntl Component)

Indicates pricing that should be returned (i.e. Commercial Base).

Syntax

property PriceOption: TibxUSPSPriceOptions read get_PriceOption write set_PriceOption;

TibxUSPSPriceOptions = (
  poRetail,
  poCommercialPlus,
  poCommercialBase
);

Default Value

poCommercialBase

Remarks

The default value for this property is poCommercialBase (2).

Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).

Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).

Possible values are as follows:

Prohibitions Property (USPSShipIntl Component)

List of items prohibited from mailing to the destination country.

Syntax

property Prohibitions: String read get_Prohibitions;

Default Value

''

Remarks

Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service.

This property is read-only.

Proxy Property (USPSShipIntl Component)

A set of properties related to proxy access.

Syntax

property Proxy: TibxProxy read get_Proxy write set_Proxy;

Remarks

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

Please refer to the Proxy type for a complete list of fields.

RecipientAddress Property (USPSShipIntl Component)

Identifies the recipient's address.

Syntax

property RecipientAddress: TibxAddressDetail read get_RecipientAddress write set_RecipientAddress;

Remarks

The RecipientAddress is required to be provided in a ship request.

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

Please refer to the AddressDetail type for a complete list of fields.

RecipientContact Property (USPSShipIntl Component)

Identifies the recipient's contact info.

Syntax

property RecipientContact: TibxContactDetail read get_RecipientContact write set_RecipientContact;

Remarks

The RecipientContact is required to be provided in a ship request.

The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

RecipientCustomsReference Property (USPSShipIntl Component)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

property RecipientCustomsReference: String read get_RecipientCustomsReference write set_RecipientCustomsReference;

Default Value

''

Remarks

This property may contain any reference number that the person wishes to use.

Regulations Property (USPSShipIntl Component)

Additional regulations for shipping to the destination country.

Syntax

property Regulations: String read get_Regulations;

Default Value

''

Remarks

Any additional regulations not covered under Restrictions, Observations, or Prohibitions will be listed here after a successful transaction. The returned data might include information such as: country code, required Customs Forms, special notes when shipping certain items, areas served, etc.

This property is read-only.

Restrictions Property (USPSShipIntl Component)

Restrictions on items being shipped based on country of destination.

Syntax

property Restrictions: String read get_Restrictions;

Default Value

''

Remarks

This property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.

This property is read-only.

SDRValue Property (USPSShipIntl Component)

Special Drawing Right calculated on TotalValue .

Syntax

property SDRValue: String read get_SDRValue;

Default Value

''

Remarks

The Special Drawing Right (SDR) is an artificial currency unit based on a collection of major world currencies. The SDRValue is the calculated TotalValue in this artificial currency.

This property is read-only.

SenderAddress Property (USPSShipIntl Component)

Identifies the sender's address.

Syntax

property SenderAddress: TibxAddressDetail read get_SenderAddress write set_SenderAddress;

Remarks

The SenderAddress is required to be provided in a ship request when the GetPackageLabel method is called.

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

Please refer to the AddressDetail type for a complete list of fields.

SenderContact Property (USPSShipIntl Component)

Identifies the sender's contact info.

Syntax

property SenderContact: TibxContactDetail read get_SenderContact write set_SenderContact;

Remarks

The SenderContact is required to be provided in a ship request, when the GetPackageLabel method is called.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

Please refer to the ContactDetail type for a complete list of fields.

SenderCustomsReference Property (USPSShipIntl Component)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

property SenderCustomsReference: String read get_SenderCustomsReference write set_SenderCustomsReference;

Default Value

''

Remarks

This property may contain any reference number that the person wishes to use.

ServiceType Property (USPSShipIntl Component)

The mail service type when shipping to the CountryCode .

Syntax

property ServiceType: TibxServiceTypes read get_ServiceType write set_ServiceType;

TibxServiceTypes = (
  stUnspecified,
  stFedExPriorityOvernight,
  stFedExStandardOvernight,
  stFedExFirstOvernight,
  stFedEx2Day,
  stFedExExpressSaver,
  stFedExGround,
  stFedExGroundHomeDelivery,
  stFedEx1DayFreight,
  stFedEx2DayFreight,
  stFedEx3DayFreight,
  stFedExInternationalPriority,
  stFedExInternationalEconomy,
  stFedExInternationalFirst,
  stFedExInternationalPriorityFreight,
  stFedExInternationalEconomyFreight,
  stFedExEuropeFirstInternationalPriority,
  stFedExSmartPost,
  stFedEx2DayAM,
  stFedExFirstFreight,
  stFedExInternationalGround,
  stFedExFreightEconomy,
  stFedExFreightPriority,
  stFedExInternationalPriorityExpress,
  stFedExInternationalConnectPlus,
  stUPSFirstClass,
  stUPSPriorityMail,
  stUPSExpeditedMailInnovations,
  stUPSPriorityMailInnovations,
  stUPSEconomyMailInnovations,
  stUPSNextDayAir,
  stUPSExpress,
  stUPS2ndDayAir,
  stUPSGround,
  stUPSWorldwideExpress,
  stUPSWorldwideExpedited,
  stUPSExpedited,
  stUPSStandard,
  stUPS3DaySelect,
  stUPSNextDayAirSaver,
  stUPSSaver,
  stUPSNextDayAirEarlyAM,
  stUPSExpressEarlyAM,
  stUPSWorldwideExpressPlus,
  stUPSExpressPlus,
  stUPS2ndDayAirAM,
  stUPSTodayStandard,
  stUPSTodayCourrier,
  stUPSTodayInterCity,
  stUPSTodayExpress,
  stUPSTodayExpressSaver,
  stUPSWorldwideExpressFreight,
  stUPSSurePostLessThan1LB,
  stUPSSurePost1LBOrGreater,
  stUPSSurePostBPM,
  stUPSSurePostMedia,
  stUSPSExpress,
  stUSPSFirstClass,
  stUSPSPriority,
  stUSPSParcelPost,
  stUSPSBPM,
  stUSPSMedia,
  stUSPSLibrary,
  stUSPSOnline,
  stUSPSGlobalExpress,
  stUSPSParcelSelect,
  stUSPSCriticalMail,
  stUSPSStandardMail,
  stUSPSExpressMailInternational,
  stUSPSFirstClassMailInternational,
  stUSPSPriorityMailInternational,
  stUSPSPriorityExpress,
  stUSPSRetailGround,
  stUSPSFirstClassPackageInternationalService,
  stUSPSPriorityMailExpressInternational,
  stCanadaRegularParcel,
  stCanadaExpeditedParcel,
  stCanadaXpresspost,
  stCanadaLibrary,
  stCanadaPriority,
  stCanadaPriorityEnvelopeUSA,
  stCanadaPriorityPakUSA,
  stCanadaPriorityParcelUSA,
  stCanadaXpresspostUSA,
  stCanadaExpeditedParcelUSA,
  stCanadaSmallPacketAirUSA,
  stCanadaTrackedPacketUSA,
  stCanadaTrackedPacketLVMUSA,
  stCanadaPriorityEnvelopeInternational,
  stCanadaPriorityPakInternational,
  stCanadaPriorityParcelInternational,
  stCanadaXpresspostInternational,
  stCanadaSmallPacketAirInternational,
  stCanadaSmallPacketLandInternational,
  stCanadaParcelAirInternational,
  stCanadaParcelLandInternational,
  stCanadaTrackedPacketInternational,
  stFedExSameDay,
  stFedExSameDayCity,
  stFedExSameDayMetroAfternoon,
  stFedExSameDayMetroMorning,
  stFedExSameDayMetroRush,
  stUPSWorldwideEconomyDDU,
  stUPSWorldwideEconomyDDP,
  stUSPSParcelSelectGround,
  stUSPSPriorityMailCubic,
  stUSPSGroundAdvantage,
  stUSPSGroundAdvantageCubic,
  stFedExFirst,
  stFedExPriority,
  stFedExPriorityExpress,
  stFedExPriorityExpressFreight,
  stFedExPriorityFreight,
  stFedExEconomySelect
);

Default Value

stUnspecified

Remarks

This property is required to be provided in a ship request when the GetPackageLabel method is called.

Possible values are:

This property is not available at design time.

ShipDate Property (USPSShipIntl Component)

Date package will be mailed.

Syntax

property ShipDate: String read get_ShipDate write set_ShipDate;

Default Value

''

Remarks

You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.

This property is also returned after the following carrier pickup methods are called:

• PickupAvailability
• SchedulePickup
• ChangePickup
• PickupInquiry

This indicates the date on which the packages will be picked up from the specified location.

ShipmentSpecialServices Property (USPSShipIntl Component)

Contains the collection of special services offered by USPS on shipment level.

Syntax

property ShipmentSpecialServices: Int64 read get_ShipmentSpecialServices write set_ShipmentSpecialServices;

Default Value

0

Remarks

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

SSLAcceptServerCertEncoded Property (USPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded;
property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertEncoded Property (USPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded;
property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;

Default Value

''

Remarks

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

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

This property is not available at design time.

SSLCertStore Property (USPSShipIntl Component)

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

Syntax

property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore;
property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

SSLCertStorePassword Property (USPSShipIntl Component)

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

Syntax

property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;

Default Value

''

Remarks

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

SSLCertStoreType Property (USPSShipIntl Component)

This is the type of certificate store for this certificate.

Syntax

property SSLCertStoreType: TibxCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;

TibxCertStoreTypes = (
  cstUser,
  cstMachine,
  cstPFXFile,
  cstPFXBlob,
  cstJKSFile,
  cstJKSBlob,
  cstPEMKeyFile,
  cstPEMKeyBlob,
  cstPublicKeyFile,
  cstPublicKeyBlob,
  cstSSHPublicKeyBlob,
  cstP7BFile,
  cstP7BBlob,
  cstSSHPublicKeyFile,
  cstPPKFile,
  cstPPKBlob,
  cstXMLFile,
  cstXMLBlob,
  cstJWKFile,
  cstJWKBlob,
  cstSecurityKey,
  cstBCFKSFile,
  cstBCFKSBlob,
  cstPKCS11,
  cstAuto
);

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

SSLCertSubject Property (USPSShipIntl Component)

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

Syntax

property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;

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:

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

SSLProvider Property (USPSShipIntl Component)

This specifies the SSL/TLS implementation to use.

Syntax

property SSLProvider: TibxTSSLProviders read get_SSLProvider write set_SSLProvider;

TibxTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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

Additional Notes

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

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

SSLServerCertEncoded Property (USPSShipIntl Component)

This is the certificate (PEM/Base64 encoded).

Syntax

property SSLServerCertEncoded: String read get_SSLServerCertEncoded;
property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;

Default Value

''

Remarks

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

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

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

Timeout Property (USPSShipIntl Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write 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 component will wait for the operation to complete before returning control.

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

If Timeout expires, and the operation is not yet complete, the component raises an exception.

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.

TotalValue Property (USPSShipIntl Component)

Total value of all items being shipped.

Syntax

property TotalValue: String read get_TotalValue;

Default Value

''

Remarks

This is the total value of all items in the package. It should match the sum of all individual UnitPrices.

This property is read-only.

TransactionId Property (USPSShipIntl Component)

The transaction Id.

Syntax

property TransactionId: String read get_TransactionId write set_TransactionId;

Default Value

''

Remarks

This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.

USPSAccount Property (USPSShipIntl Component)

Login information for USPS.

Syntax

property USPSAccount: TibxUSPSAccount read get_USPSAccount write set_USPSAccount;

Remarks

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

Please refer to the USPSAccount type for a complete list of fields.

CancelPackage Method (USPSShipIntl Component)

Cancels a single package by deleting it from the eVS shipping log.

Syntax

function CancelPackage(BarcodeNumber: String): String;

Remarks

The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.

The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the TrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.

If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.

Config Method (USPSShipIntl Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

GetPackageLabel Method (USPSShipIntl Component)

Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.

Syntax

procedure GetPackageLabel();

Remarks

When this method is called, the following properties are used to construct the request:

• UserId (required for API authentication)
• FirstName (required unless Company is provided)
• MiddleInitial (optional)
• LastName (required unless Company is provided)
• Company (optional if FirstName and LastName are provided)
• Phone (required)
• Address1 (required)
• Address2 (optional)
• City (required)
• State (required)
• ZipCode (required)
• SenderUrbanization (optional)
• SenderCustomsReference (optional)
• FirstName (you must send either a name or Company (or both))
• LastName (you must send either a name or Company (or both))
• Company (optional if name is provided)
• Phone (optional)
• Fax (optional)
• Email (optional)
• Address1 (at least one address line is required)
• Address2
• RecipientAddress3
• City (required)
• State (Province, optional)
• CountryCode (required)
• ZipCode (Postal Code, required)
• AddressFlags (required)
• RecipientCustomsReference (optional)
• NonDeliveryOption (if this is set to "REDIRECT" provide the return address via Config)
• RedirectName (optional)
• RedirectEmail (optional)
• RedirectSMS (optional)
• RedirectAddress (optional)
• RedirectCity (optional)
• RedirectState (optional)
• RedirectZipCode (optional)
• RedirectZip4 (optional)
• PackagingType (optional)
• Description (required)
• Quantity (required)
• Value (required)
• Weight (required)
• HarmonizedCode (optional)
• Manufacturer (optional)
• UseInsurance (optional)
• InsurancePolicy (optional)
• InsuredValue (optional)
• NetCharge (optional - if left blank the server will return the postage cost here)
• Weight (required)
• Length (optional)
• Width (optional)
• Height (optional)
• Machinable (optional)
• Contents (required - if set to ctOther OtherContents must be set)
• Comments (optional)
• LicenseNumber (optional)
• CertificateNumber (optional)
• InvoiceNumber (optional)
• LabelImageType (required)
• ImageLayout (optional)
• CustomerId (optional)
• CustomerId2 (optional)
• MailingLocation (optional)
• ShipDate (optional. If specified must be within 3 days)
• HoldForManifest (optional)
• EELPFC (optional)
• PriceOption (optional)
• MeterPayment (optional)
• ExtraServices (optional)
• ActionCode (optional)
• OptOutOfSPE (optional)
• PermitNumber (optional)
• ImportersReferenceType (optional)
• ImportersContact (optional - Phone, Fax, Email)
• DestinationRateIndicator (optional)
• MID (optional)
• LogisticsManagerMID (optional)
• CRID (optional)
• VendorCode (optional)
• VendorProductVersionNumber (optional)
• ShippingLabelFile (optional if you wish to save the labels to disk)

Please be aware of the maximum character amounts allowed for certain properties. If you enter more than those amounts, an error will not be generated; the API will simply pass in the characters up to the maximum amount allowed, and disregard the rest. This is important since the resulting value could prevent delivery.

This method fills the following properties:

• TrackingNumber
• BarcodeNumber
• ShippingLabel
• NetCharge
• TotalValue
• SDRValue
• IndemnityCoverage (Priority Mail only)
• Prohibitions
• Observations
• Restrictions
• Regulations
• Notes

If ShippingLabelFile was specified with a path and filename, all of the returned label images will also be saved to disk.

Reset Method (USPSShipIntl Component)

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

Syntax

procedure Reset();

Remarks

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

Error Event (USPSShipIntl Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

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

Notification Event (USPSShipIntl Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

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

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

SSLServerAuthentication Event (USPSShipIntl Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  CertEncoded: String;
  CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

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

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

SSLStatus Event (USPSShipIntl Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

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

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

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

CommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item CommodityDetail commodity = new CommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

Note: The following fields are applicable to UPS Freight services.

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String; valNumberOfPieces: Integer; valExportType: Integer);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String; valNumberOfPieces: Integer);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valWeight: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valScheduleBCode: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valHarmonizedCode: String; valQuantity: Integer; valQuantityUnit: String; valUnitPrice: String);

constructor Create(valDescription: String; valManufacturer: String; valWeight: String);

ContactDetail Type

Represents the contact information.

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valFirstName: String; valLastName: String; valPhone: String);

constructor Create(valFirstName: String; valLastName: String; valPhone: String; valEmail: String);

constructor Create(valFirstName: String; valLastName: String; valPhone: String; valEmail: String; valCompany: String);

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

constructor Create();

PackageDetail Type

Represents a single package contained in shipment.

Remarks

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

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

The fields contained by this type are listed below.

Fields

Constructors

constructor Create();

constructor Create(valPackagingType: Integer; valWeight: String);

constructor Create(valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valCODType: Integer; valSignatureType: Integer);

constructor Create(valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valDangerousGoodsAccessible: Boolean; valSignatureType: Integer);

constructor Create(valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valDescription: String; valReference: String; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valDangerousGoodsAccessible: Boolean; valSignatureType: Integer; valShippingLabelFile: String; valCODFile: String);

constructor Create(valPackagingType: Integer; valWeight: String; valLength: Integer; valWidth: Integer; valHeight: Integer; valDescription: String; valReference: String; valSpecialServices: Integer; valInsuredValue: String; valCODAmount: String; valCODType: Integer; valSignatureType: Integer; valShippingLabelFile: String; valReturnReceiptFile: String);

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

USPSAccount Type

Represents the details of a USPS account.

Remarks

This type contains data describing the USPS server and login information.

Example: Setting the fields of an account USPSAccount account = new USPSAccount account.Server = "https://secure.shippingapis.com/ShippingAPI.dll"; account.Password = "my_password"; account.UserId = "my_username";

The properties contained by this type are listed below.

Fields

Constructors

constructor Create();

Config Settings (USPSShipIntl Component)

The component 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 component, access to these internal properties is provided through the Config method.

USPSShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (USPSShipIntl Component)

USPSShipIntl Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	529   Bad Label Format. (Possibly corrupt encoding)

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

SOAP Errors

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

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

HTTP Errors

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

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

TCPClient Errors

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

SSL Errors

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

TCP/IP Errors

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

XML Errors

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