4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

FedExShipIntl Configuration

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.

FedExShipIntl Configuration Settings

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.

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

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.

XParent:   The parent of the current element.

The current element is specified via the XPath.

XElement:   The name of the current element.

The current element is specified via the XPath.

XText:   The text of the current element.

The current element is specified via the XPath.

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.

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.

Warning:   Warning message returned by the server.

This might be returned by the server even upon successful response. These warnings are usually informational.

CSPUserKey:   CSP end user key.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively).

CSPUserPassword:   CSP end user password.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique CSPUserKey and CSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (DeveloperKey and Password respectively).

CSPProductId:   Identifies the CSP product.

This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the AccountNumber, MeterNumber and CSPProductVersion.

CSPProductVersion:   Identifies the CSP product version.

This is applicable to CSP developers only. This is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the AccountNumber, MeterNumber and CSPProductId.

UseSOAP:   Determines if the FedEx SOAP web services are used instead of the FedEx XML web services.

If True (default), the component will use the FedEx SOAP based web services. When using the SOAP based web services the Server should end in "web-services". For instance: "https://gatewaybeta.fedex.com:443/web-services".

If False, the component will use the FedEx XML based web services. When using the XML based web services the Server should end in "xml". For instance: "https://gatewaybeta.fedex.com:443/xml".

CustomContent:   Defines any custom content to print on the label.

FedEx allows you to add customizable content on select label types. FedEx requires that the customizable graphic or text must not exceed 1-1/2 inches high and 4-1/2 inches wide. You must insert the XML necessary to display your graphic or text. For example if you wanted to add some custom text to the label you would do something like this:

string customContent = "CustomContent=<CustomContent><TextEntries><Position><X>150</X><Y>70</Y></Position><Format>My text here</Format><ThermalFontId>2</ThermalFontId></TextEntries></CustomContent>"

When using the CustomContent, the LabelStockType must be either 4 (Stock 4x8) or 5 (Stock 4x9 Leading Doc Tab). Also LabelFormatType must be 0 (Common2D) and LabelImageType must 2 (fitEltron), 3 (fitZebra) or 4 (fitUniMark).

EstimateDelivery:   Determines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.

If True (default), the component will attempt to estimate Transit Time, Delivery Date, and/or Delivery Day based on what information came back in the response. This does not account for non-business days, holidays, or weekend delivery and should be treated accordingly.

If False, the component will not estimate Transit Time, Delivery Date, and/or Delivery Day. Instead it will ONLY use the values returned in the response from FedEx. If a property is empty, it means that FedEx did not return this information.

CODReferenceIndicator:   The reference information to be added to the COD return label.

The reference information to be added to the COD return label.

Possible values are:

0None (default)
1INVOICE
2PO
3REFERENCE
4TRACKING

DryIceCount:   The number of packages which contain dry ice.

This specifies the number of packages in the shipment which contain dry ice. This is used in conjunction with PackageDryIceWeight when DryIce is present (requested) in the ShipmentSpecialServices.

PackageDryIceWeight[i]:   The weight of the dry ice for each package.

This is required to be provided in a ship request when shipping Dry Ice (i.e., when the corresponding flag for DryIce is present (requested) in the ShipmentSpecialServices). Dry ice shipping is allowed for FedEx Express services only (U.S. domestic, intra-Canadian, and FedEx Express International shipments). FedEx assesses a surcharge on each package containing dry ice. Dry ice weight cannot be greater than the package weight. The dry ice weight type is KGS only. There is a limit of 2.5 KG dry ice for destination.

NOTE: The weight will always be specified in KG.

SizeUnit:   The dimension unit.

Declares the type of size units to be used in calculating the size of the shipment and each package contained in it. This is required if package dimensions are passed in the request.

Valid dimension unit of measure codes: IN and CM. Defaults to IN if a value is not passed in the transaction.

WeightUnit:   Weight unit.

This is required when submitting a rate or ship request. It declares the type of weight unit to be used in calculating the weight of the shipment and each package contained in it.

Valid weight types: LB and KG. Defaults to LB if a value is not passed in the transaction. It must be LB for a U.S. Domestic rate quote or ship request.

BlockVisibility:   Whether the visibility of this shipment should be blocked from parties other than shipper/payor.

If True, only the shipper/payor will have visibility of this shipment.

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.

CODRecipientCountryCode:   The country code of the COD recipient.

This specifies the country code 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.

CODRecipientPhone:   The phone number of the COD recipient.

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

CODRecipientState:   The state of the COD recipient.

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

CODRecipientZipCode:   The zip code of the COD recipient.

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

CODRecipientResidential:   The residential status of the COD recipient.

This indicates whether the COD recipient is a residential address.

CSPOriginLocationId:   Origin location Id for the CSP developer sending the version capture request.

This is applicable to CSP developers only.

This element is required to be provided in a Version Capture request (i.e., when the CSPVersionCapture method is called at the end of the shipping day).

CSPProductPlatform:   Vendor product platform name.

This is applicable to CSP developers only.

This element is required to be provided in a Version Capture request (i.e., when the CSPVersionCapture method is called at the end of the shipping day).

CustomerTransactionId:   Customer transaction id.

This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies. Maximum of 40 characters.

DocTabContent:   Custom DocTab content set by the user when preparing a shipping label.

This is applicable to thermal labels with DocTab only.

If provided, thermal labels will include specified doc tab content. If omitted, label will be produced without the doc tab content.

DeliveryDay:   Day of the week on which shipment is expected to be delivered.

When either the GetPackageLabel or GetShipmentLabels method is called, the DeliveryDay will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

LabelFormatType:   Indicates the type of label to be returned.

This element is required when either the GetPackageLabel or GetShipmentLabels method is called.

Valid values are:

Value Description
0 Common 2D
1 Label Data Only
2 Freight Straight Bill of Lading
3 VICS Bill of Lading

LabelOrientationType:   Indicates if the top or bottom of the label comes out of the printer.

Valid printing orientation types are:

Value Description
0 Top Edge of Text First
1 Bottom Edge of Text First

LabelStockType:   Indicates the size of the label and the location of the doc tab if present.

All 'Paper *' items should be used when a laser printer is being used to print he generated label file (ie. LabelImageType is set to fitPDF or fitPNG).

All 'Stock *' items should be used when a thermal printer is being used to print he generated label file (ie. LabelImageType is set to fitEltron, fitZebra or fitUniMark).

By Default, 0 (Paper 4x6) will be used when LabelImageType is set to fitPDF or fitPNG. However if LabelImageType is set to fitEltron, fitZebra or fitUniMark, the default is 2 (Stock 4x6). If an invalid value is passed, the default value for the LabelImageType you are using will be used.

Valid label stock types are:

Value Description
0 Paper 4x6
1 Paper 7x4.75
2 Stock 4x6
3 Stock 4x6.75 Leading Doc Tab
4 Stock 4x8
5 Stock 4x9 Leading Doc Tab
6 Paper 4x8
7 Paper 4x9
8 Paper 8.5x11 Bottom Half Label
9 Paper 8.5x11 Top Half Label
10 Stock 4x6.75 Trailing Doc Tab
11 Stock 4x9 Trailing Doc Tab
12 Paper Letter

MaskAccountNumber:   Whether the shipper account number is masked on the shipping label.

If True (default value), the AccountNumber will be excluded from printing on the label. Otherwise, it will show on the label.

Overwrite:   Determines whether label files will be overwritten.

If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist.

PackageDocumentFile:   The file path for the additional package documents.

When package documents are received from FedEx, they will be put in the filepath specified in the following format:

<Base Filename>_<Document Type><Document Number>.<extension>

So if the path "C:\packageDoc.png" is specified and you receive an auxiliary label, the file "C:\packageDoc_AUXILIARY_LABEL1.png" will be created.

ShipmentRatingAggregate:   String representing the rating detail on shipment level.

Upon a successful ship request, the shipment rating is returned in the server response only if the PayorType is set to 0 (SENDER). This will be stored as a string in the ShipmentRatingAggregate, formatted as XML. This setting is read-only.

ShipTime:   Local Time of shipment based on shipper's time zone.

This is used in combination with ShipDate. Together, these identify the date and time the package is tendered to FedEx. This is optional to be entered in the ship request. If not provided, defaults to the current U.S. Central Standard Time. Format: HH:MM:SS using a 24 hour clock (e.g. 11:00 a.m. is 11:00:00, whereas 5:00 p.m. is 17:00:00).

AdmissibilityPackageType:   Identifies the admissibility package type.

If you set the PackagingType to YOUR_PACKAGING, the AdmissibilityPackageType is required for packages traveling to and from the U.S., Canada, and Puerto Rico, in order to designate the package description.

Possible values are:

BAG
BBL
BDL
BOX
BSK
BXT
CAG
CAS
CHS
CNT
CRT
CTN
CYL
DRM
ENV
PAL
PCL
PCS
PKG
PLT
REL
ROL
SAK
SHW
SKD
TBE
TBN
TNK
UNT

B13AFiling:   Specifies which option is being exercised by the customer to file the B13A.

The B13A is an export declaration form filed with Canada Customs by the Canadian exporter. Canadian shippers are required to submit a B13A Canada Export Declaration for shipments of commodities or documents (which value exceeds $1,999.99 CAD, $999.00 USD, or $0.00 for any other currency type), or for shipments of controlled commodities, as defined by Revenue Canada Customs and related agencies, regardless of the value of the shipment. This is not needed for outbound shipments consigned to countries other than the United States (US), U.S. Virgin Islands (VI), or Puerto Rico (PR).

The B13AFiling is required to be provided in the ship request for all FedEx Express International non-document shipments outbound from Canada that are not destined to above listed countries, and :

Possible values are: 'NOT_REQUIRED', 'MANUALLY_ATTACHED', 'FILED_ELECTRONICALLY', and 'SUMMARY_REPORTING'.

If 'NOT_REQUIRED' is specified, the B13A Exemption Number should be provided in the request (via the ExportCompliance).

If 'MANUALLY_ATTACHED' is specified, your manually filed B13A must be time/date stamped at a Canada Customs office before you ship. The shipment tracking number must be indicated on the stamped B13A. One original copy of the stamped B13A must be attached to the shipping documentation. You are not required to enter the 21-character B13A transaction number at the time of shipping.

If 'FILED_ELECTRONICALLY' is specified, your B13A authorization code must be obtained by submitting your B13A information using the CAED software (and be provided in the ship request via the ExportCompliance). To add the required shipment tracking number to your B13A declaration, return to the CAED software after you create your shipping label and update your original B13A declaration with this information.

If 'SUMMARY_REPORTING' is specified, a prior written authorization from Canada Customs is required.

Note: If you have questions regarding B13A shipping requirements, see fedex.com/ca_english/international/regulatorynews/b13afaqs.html for more information.

BookingNumber:   Booking confirmation number.

It is required and applicable only for the following international freight services: International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the ServiceType is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).

Values must be 8-12 characters in length.

CurrencyCode:   The currency code associated with the monetary values present in the request.

This optional field identifies the preferred currency of the requestor.

CODType:   COD type.

This identifies the type of funds FedEx driver should collect upon package delivery. It is available for FedEx Ground services only. It is required to be provided in a ship request only if the COD is present (requested) in the ShipmentSpecialServices.

Possible values are: ANY (Unsecured form of payment: personal check, certified check, cashier's check, official check, money order, or company check), GUARANTEED_FUNDS (Secured form of payment: cashier's check, official check, or money order), or CASH.

The amount to be collected has to be specified on package level by setting the CODAmount per each package where COD is requested.

CommodityPreferenceCriterion[i]:   Preference Criteria for NAFTA Certificate of Origin documents for the commodity at index i.

This property is required when ShippingDocumentTypes includes the NAFTA flag. Valid indices are from 0 to CommoditiesCount - 1. Valid values and their descriptions are listed from the FedEx documentation:

ValueDescription
0"A": The good is "wholly obtained or produced entirely" in the territory of one or more of the NAFTA countries as referenced in Article 415. Note: The purchase of a good in the territory does not necessarily render it "wholly obtained or produced." If the good is an agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(a) and 415)
1"B": The good is produced entirely in the territory of one or more of the NAFTA countries and satisfies the specific rule of origin, set out in Annex 401, that applies to its tariff classification. The rule may include a tariff classification change, regional value-content requirement, or a combination there-of. The good must also satisfy all other applicable requirements of Chapter Four. If the good is an agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(b))
2"C": The good is produced entirely in the territory of one or more of the NAFTA countries exclusively from originating materials. Under this criterion, one or more of the materials may not fall within the definition of "wholly produced or obtained," as set out in Article 415. All materials used in the production of the good must qualify as "originating" by meeting the rules of Article 401(a) through (d). If the good is an agricultural good, see also criterion F and Annex 703.2. Reference: Article 401(c).
3"D": Goods are produced in the territory of one or more of the NAFTA countries but do not meet the applicable rule of origin, set out in Annex 401, because certain non-originating materials do not undergo the required change in tariff classification. The goods do nonetheless meet the regional value-content requirement specified in Article 401 (d). This criterion is limited to the following two circumstances: (1) The good was imported into the territory of a NAFTA country in an unassembled or disassembled form but was classified as an assembled good, pursuant to H.S. General Rule of Interpretation 2(a). or (2). The good incorporated one or more non-originating materials, provided for as parts under the H.S., which could not undergo a change in tariff classification because the heading provided for both the good and its parts and was not further subdivided into subheadings, or the subheading provided for both the good and its parts and was not further subdivided. Note: This criterion does not apply to Chapters 61 through 63 of the H.S. (Reference: Article 401(d))
4"E": Certain automatic data processing goods and their parts, specified in Annex 308.1, that do not originate in the territory are considered originating upon importation into the territory of a NAFTA country from the territory of another NAFTA country when the most-favored-nation tariff rate of the good conforms to the rate established in Annex 308.1 and is common to all NAFTA countries. (Reference: Annex 308.1)
5"F": The good is an originating agricultural good under preference criterion A, B, or C above and is not subject to a quantitative restriction in the importing NAFTA country because it is a "qualifying good" as defined in Annex 703.2, Section A or B (please specify). A good listed in Appendix 703.2B.7 is also exempt from quantitative restrictions and is eligible for NAFTA preferential tariff treatment if it meets the definition of "qualifying good" in Section A of Annex 703.2.

CommodityNaftaProducerDetermination[i]:   The Producer determination for NAFTA Certificate of Origin documents for the commodity at index i.

This property is required when ShippingDocumentTypes includes the NAFTA flag. Valid indices are from 0 to CommoditiesCount - 1.

From FedEx documentation, specify:

ValueDescription
0(Yes) Shipper is the producer of the good.
1(No1) - The certificate is based on knowledge of whether the good qualifies as an originating good.
2(No2) - The certificate is based on reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good.
3(No3) - The certificate is based on a completed and signed Certificate for the good voluntarily provided to the exporter by the producer.

CommodityNaftaNetCostMethod[i]:   Specifies how the net cost is calculated for the commodity at index i.

This property is optional for shipments where ShippingDocumentTypes includes the NAFTA flag. Valid indices are from 0 to CommoditiesCount - 1.

The Net cost (NC) method calculates regional value content (RVC) as a percentage of the net cost to produce the good. Net cost represents all costs incurred by the producer minus promotions, royalties, shipping, and nonallowable interest costs. Specify one of the following:

ValueDescription
0 No - Select No if the RVC is not calculated according to the net cost method.
1 NC - Select NC if the RVC is calculated according to the net cost method.

CommodityNetCostNaftaBeginDate[i]:   Beginning date if the net cost is calculated over a period of time for the commodity at index i.

This property is required when CommodityNaftaNetCostMethod[i]; is set to 1 (NC). Valid indices are from 0 to CommoditiesCount - 1. Beginning date for the date range if RVC is calculated according to the net cost method over a period of time. The date must be formatted as "yyyy-MM-dd".

CommodityNetCostNaftaEndDate[i]:   Ending date if the net cost is calculated over a period of time for the commodity at index i.

This property is required when CommodityNaftaNetCostMethod[i]; is set to 1 (NC). Valid indices are from 0 to CommoditiesCount - 1. Ending date for the date range if RVC is calculated according to the net cost method over a period of time. The date must be formatted as "yyyy-MM-dd".

DeliveryInstructions:   Delivery instructions.

Used with Freight services only.

Documents:   Whether an international shipment contains only documents or no documents.

This is applicable for international shipments only.

If False (default value), this means that this shipment contains NO documents. In this case, the data for commodity items (included in the shipment) have to be provided in the request. The Commercial Invoice is required to associate the shipment (see respective commodity elements defined by the Commodities for more details).

If True, it means that this shipment contains ONLY documents. An international shipment can either contain documents only, or no documents. Documents and other commodities cannot be mixed in a shipment.

ExportCompliance:   This is an export compliance statement.

General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).

For international shipments requiring an EEI/SED (Electronic Export information/Shipper's Export Declaration), the ExportCompliance should be set to: either a FTR (Foreign Trade Regulations) exemption number or an ITN number (Internal Transaction Number) received from filing your EEI/SED shipment data with AESDirect (go to www.aesdirect.gov to use this application) as proof of filing citation.

For shipments originating in Canada, the following rules apply:

  • if B13AFiling is set to 'NOT_REQUIRED', this field should contain a valid B13A Exemption Number;
  • if B13AFiling is set to 'MANUALLY_ATTACHED', you are not required to enter the 21-character B13A transaction number at the time of shipping;
  • if B13AFiling is set to 'FILED_ELECTRONICALLY', this field should contain a valid 17 or 23 alphanumeric authorization code for your B13A;
  • if B13AFiling is set to 'SUMMARY_REPORTING': this option requires a prior written authorization from Canada Customs;

This number will print on the international shipping label and it is used by customs office. Maximum length: 50.

Two most common exemptions are: 'NO EEI 30.36' (for shipments to Canada) and 'NO EEI 30.37(a)' (for commodity value less than $2,500). However, for the official list of FTR Exemption codes and definitions, please refer to Code of Federal Regulations (CFR) Title 15, Part 30, Subpart D (located at http://ecfr.gpoaccess.gov or http://www.census.gov/foreign-trade/regulations).

ImporterofRecordAggregate:   Used to set the importer if different than the recipient.

Set this to the XML aggregate for the importer of record for the shipment. This would be used when the importer is different than the final recipient of the shipment.

The below aggregate shows the possible fields that can be sent.

<ImporterOfRecord>
  <AccountNumber>XXXXXXXXX</AccountNumber>
  <Contact>
    <PersonName>JAN14 CL</PersonName>
    <CompanyName>SndrConnm</CompanyName>
    <PhoneNumber>XXXXXXXXXX</PhoneNumber>
    <EMailAddress/>
  </Contact>
  <Address>
    <StreetLines>Shipper Address Line 1</StreetLines>
    <StreetLines>Shipper Address Line 2</StreetLines>
    <City>Memphis</City>
    <StateOrProvinceCode>TN</StateOrProvinceCode>
    <PostalCode>XXXXX</PostalCode>
    <CountryCode>US</CountryCode>
  </Address>
</ImporterOfRecord>

InvoiceSpecialInstructions:   Special instructions for commercial invoices.

This will allow you to add special instructions to the commercial invoice.

LoadAndCount:   Shipper's Load and Count (SLAC) = total shipment pieces.

This is required for a single piece or on the first piece of an MPS for international freight shipping. It is applicable only for International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the ServiceType is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).

This indicates the total shipment pieces (e.g. 3 boxes and 3 pallets of 100 pieces each = SLAC of 303). Maximum length: 5. Values must be in the range of 1 - 99999.

NaftaAuthorizedSignatureName:   The name of the Signature Contact.

This property is required when ShippingDocumentTypes includes the NAFTA flag. The property represents the name of the contact for the "Authorized Signature" area of the form.

NaftaAuthorizedSignatureCompany:   The Company associated with the Signature Contact.

This property is required when ShippingDocumentTypes includes the NAFTA flag. The property represents the company of the contact for the "Authorized Signature" area of the form.

NaftaAuthorizedSignaturePhone:   The Phone number associated with the Signature Contact.

This property is required when ShippingDocumentTypes includes the NAFTA flag. The property represents the phone number of the contact for the "Authorized Signature" area of the form.

NaftaBlanketPeriodBeginDate:   The beginning date for the blanket period.

This property is optional for shipments where ShippingDocumentTypes includes the NAFTA flag. The format is "yyyy-MM-dd".

The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate).

The property is required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

NaftaBlanketPeriodEndDate:   The ending date for the blanket period.

This property is optional for shipments where ShippingDocumentTypes includes the NAFTA flag. The format is "yyyy-MM-dd".

The end date is the date upon which the blanket period expires.

The property is required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

NaftaImporterSpecification:   The importer specification for the NAFTA Certificate of Origin.

The specification of the importer associated with a shipment with a NAFTA Certificate of Origin.

Value Description
0 IMPORTER_OF_RECORD
1 RECIPIENT
2 UNKNOWN
4 VARIOUS

NotifyAggregate[i]:   The aggregate xml for the recipient to be notified.

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

This aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows:

<EMailNotificationDetail>
  <PersonalMessage>personal_message</PersonalMessage>
  <Recipients> (this aggregate can be entered up to six times)
    <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType>
    <EMailAddress>recipient_email</EMailAddress>
    <NotifyOnShipment>true_or_false</NotifyOnShipment>
    <NotifyOnException>true_or_false</NotifyOnException>
    <NotifyOnDelivery>true_or_false</NotifyOnDelivery>
    <Format>format_type</Format>
    <Localization>
      <LanguageCode>language_code</LanguageCode>
    </Localization>
  </Recipients>
</EMailNotificationDetail>

In this aggregate, you can specify:

  • a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
  • the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
  • the recipient's email address (via the EMailAddress element). This is required.
  • whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
  • the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
  • the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).
The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients aggregate can be entered up to 6 times.

If the NotifyAggregate is not set, it will be automatically created by the component.

The index i has a range from 0 to NotifyCount - 1.

NotifyCount:   The number of recipients to be notified.

This sets the number of people to be notified and must be set before setting any of the other Notify configs.

NotifyEmail[i]:   Email address of the recipient to be notified.

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

The index i has a range from 0 to NotifyCount - 1.

NotifyMessage[i]:   User defined text that will be included in the email.

User defined text that will be included in the email to be sent to NotifyEmail[i];. This is optional.

When multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

The index i has a range from 0 to NotifyCount - 1.

NotifyNotificationFlags[i]:   Identifies the type of notification requested.

Identifies the type of notification requested. Valid values are:

Value Meaning
0x00000001 (On Shipment) An email notification is requested to be sent to the NotifyEmail[i]; when the package is shipped.
0x00000002 (On Exception) An email notification should be sent to the NotifyEmail[i]; when an exception occurs during package movement from origin to destination.
0x00000004 (On Delivery) An email notification is requested to be sent to the NotifyEmail[i]; when the package is delivered.
0x00000008 (On Tender) An email notification is requested to be sent to the NotifyEmail[i]; when the package is tendered.
0x00000010 (On Return) An email notification is requested to be sent to the NotifyEmail[i]; 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.

The index i has a range from 0 to NotifyCount - 1.

NotifyRecipientType[i]:   Identifies the set of valid email notification recipient types.

Identifies the set of valid email notification recipient types. Valid values are:

Value Meaning
0 (default) Unspecified
1 Recipient
2 Shipper
3 Broker
4 Other
5 Third Party

When Recipient (1), Shipper (2), or Broker(3) are set, the email address associated with their definitions will be used and the NotifyEmail[i]; specified for these types will be ignored.

The index i has a range from 0 to NotifyCount - 1.

OriginAddressLine1:   The street address the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressLine2:   Specific detail about the address the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressCity:   The city the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressState:   The state or province the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressZip:   The zip or postal code the shipment originated from.

For US addresses, use the 5 or 9 digit zip code. For Canadian addresses use the 6 character postal code. In all cases, remove hyphens.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressCountry:   The country the shipment originated from.

This value should be one of the two letter country codes that FedEx accepts.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginAddressResidentialIndicator:   Indicates whether the address the shipment originated from is residential.

This indicates whether the origin address is residential. The default value is "false".

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginContactName:   The name of the person the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginContactCompany:   The company the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginContactEmail:   The email address for the contact the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginContactPhone:   The phone number for the contact the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

OriginContactFax:   The fax number for the contact the shipment originated from.

Origin Address and Contact indicate a different origin for the shipment than the address it was shipped from.

When using a Origin, OriginAddressLine1, OriginAddressCity, OriginAddressState, OriginAddressCountry, and OriginAddressZip must be set. In addition, either OriginContactName or OriginContactCompany must be set.

PackageAlcoholRecipientType[i]:   The type of recipient for an Alcohol Special Service package.

When setting a package's Special Service to Alcohol (0x00000100), this configuration setting should be used to specify the type of recipient for that package.

The applicable values are:

0Consumer (Default)
1Licensee

Valid array indices are from 0 to Packages.Count - 1.

RecipientTinType:   Indicates the type of the recipient tax identification number (TIN).

You can specify the recipient TIN type by setting the SenderTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.

This type must match the data entered in the RecipientTinNumber.

Valid values for the taxpayer identification number's (TIN) type are:

BUSINESS_NATIONAL
BUSINESS_STATE
BUSINESS_UNION
PERSONAL_NATIONAL
PERSONAL_STATE

RecipientTinNumber:   Indicates the corresponding Id number for recipient TIN type.

This element should be included in the request in order to produce a Commercial Invoice. You can specify the recipient TIN type by setting the RecipientTinType. When this is set, you must also specify the Taxpayer Identification Number (RecipientTinNumber) with the corresponding Id number for shipper TIN Type.

RegulatoryControlType:   Identifies the type of regulatory control.

Possible values are: 'EU_CIRCULATION', 'FOOD_OR_PERISHABLE', and 'NAFTA'. 'FOOD_OR_PERISHABLE' value is required by FDA/BTA for food/perishable items coming to US or PR from non-US/non-PR origin. 'EU_CIRCULATION' value is required for shipments between European Union countries. The EU indicator prints on the shipping label.

ReturnType:   Identifies the reason for return.

Identifies the reason for a global return, as recognized by Customs.

Valid values are:

ValueMeaning
0Exhibition Trade Show.
1Faulty Item.
2For Repair.
3Item For Loan.
4Other.
5Rejected.
6Trial.

ReturnDescription:   Description for the return.

If ReturnType is set to Other then ReturnDescription must be set, otherwise it is optional.

SenderTinType:   Indicates the type of the shipper tax identification number (TIN).

As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.

This type must match the data entered in the SenderTinNumber.

Valid values for the taxpayer identification number's (TIN) type are:

BUSINESS_NATIONAL
BUSINESS_STATE
BUSINESS_UNION
PERSONAL_NATIONAL
PERSONAL_STATE

SenderTinNumber:   Indicates the corresponding Id number for shipper TIN type.

As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also specify the Taxpayer Identification Number (SenderTinNumber) with the corresponding Id number for shipper TIN Type.

SendFIMSRequest:   Use this configuration setting to send a FedEx International Mailing Service (FIMS) request.

When set to a valid FIMSRequest XML structure (defined below), the component will build and send a request for a FIMS label. The XML should follow this format:

<FIMSRequest>
  <custCode>?</custCode>                 - required
  <serviceId>?</serviceId>               - required
  <labelSource>?</labelSource>           - optional
  <labelSize>?</labelSize>               - optional
  <airWaybill>?</airWaybill>             - required
  <shipperReference>?</shipperReference> - required
  <labelType>?</labelType>               - optional
  <declaration>?</declaration>           - optional
</FIMSRequest>
Please reference the FIMS documentation for possible values for elements.

Other parts of the request are built from the component's properties. Please reference the code example below.

Fedexshipintl ship = new Fedexshipintl();
ship.FedExAccount.Server = "http://shipfims.com/pkgFedex3/pkgFormService";
ship.FedExAccount.DeveloperKey = "DeveloperKey";
ship.FedExAccount.Password = "Password";
ship.FedExAccount.AccountNumber = "AccountNumber";
ship.FedExAccount.MeterNumber = "MeterNumber";
string req = @"
<FIMSRequest>
  <custCode>YourCustCode</custCode>
  <serviceId>YourServiceId</serviceId>
  <airWaybill>123456789111</airWaybill>
  <shipperReference>1234ABCD</shipperReference>
  <labelType>42</labelType>
</FIMSRequest>";
ship.LabelImageType = FedexshipintlLabelImageTypes.fitPNG;
ship.Packages.Add(new PackageDetail()
{
  Weight = "0.1",
  Width = 1,
  Length = 2,
  Height = 3,
  ShippingLabelFile = @"C:\temp\fims_label.png"
});
ship.SenderContact.Company = "/n software, inc.";
ship.SenderAddress.Address1 = "101 Europa Dr.";
ship.SenderAddress.Address2 = "Suite 110";
ship.SenderAddress.City = "Chapel Hill";
ship.SenderAddress.State = "NC";
ship.SenderAddress.ZipCode = "27516";
ship.SenderAddress.CountryCode = "US";
ship.RecipientContact.FirstName = "Bob";
ship.RecipientContact.LastName = "Villa";
ship.RecipientAddress.Address1 = "251 Victoria St";
ship.RecipientAddress.City = "Toronto";
ship.RecipientAddress.State = "ON";
ship.RecipientAddress.ZipCode = "M5B1T8";
ship.RecipientAddress.CountryCode = "CA";
ship.Commodities.Add(new CommodityDetail()
{
  Weight = "11",
  Value = "1.11"
});
ship.Config("SendFIMSRequest=" + req);
Console.WriteLine("Tracking Number: " + ship.Packages[0].TrackingNumber);
Console.WriteLine("Parcel Id: " + ship.Packages[0].Id);
Valid label types are:

LabelTypeReturned Label
fitPDF PDF Label (default)
fitPNG PNG Label
fitZebra ZPL Label

ShippingDocumentTypes:   Specifies which document type to get.

This specifies which documents you would like FedEx to generate and send back to you.

To request one or more documents be generated by FedEx you will need to set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

ValueDescription
0x0 None
0x1 Certificate of Origin
0x2 Commercial Invoice
0x4 NAFTA Certificate of Origin

ShippingDocumentFile:   Identifies the location of the document file.

When a document file is received, it will be put at the location specified with the following format:

>ShippingDocumentFile<_>type<>sequence number<.pdf

Note that there will not be a sequence number if the file is the only file of its type.

FreightAccountNumber:   Account number used with the FedEx Freight service.

This is the account number to be used with a freight shipment. This is required when submitting a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingPersonName:   The name of the person to be billed.

This should be set to the name of the person listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingCompanyName:   The name of the company to be billed.

This should be set to the name of the company listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingPhone:   The phone number of the party to be billed.

This should be set to the phone number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingFax:   The fax number of the party to be billed.

This should be set to the fax number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingEmail:   The email of the party to be billed.

This should be set to the email address listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingAddress1:   The first address line of the party to be billed.

This should be set to the first address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingAddress2:   The second address line of the party to be billed.

This should be set to the second address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingCity:   The city of the party to be billed.

This should be set to the city listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingState:   The state of the party to be billed.

This should be set to the state listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingCountryCode:   The country code of the party to be billed.

This should be set to the country code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightBillingZipCode:   The zip code of the party to be billed.

This should be set to the zip code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingAccountNumber:   The alternate account number to be billed.

This should be set to the alternate account number to be billed. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingPersonName:   The name of the person to be billed.

This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingCompanyName:   The name of the company to be billed.

This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingStreetAddress:   The street address line of the party to be billed.

This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingCity:   The city of the party to be billed.

This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingState:   The state of the party to be billed.

This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingCountryCode:   The country code of the party to be billed.

This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightAlternateBillingZipCode:   The zip code of the party to be billed.

This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightClientDiscountPercent:   Estimated discount rate provided by client for unsecured rate quote.

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightCollectTermsType:   The terms of the collect payment for a Freight Shipment.

This sets the terms for how to collect payment for this freight shipment. Default value is 0.

Valid values are as follows:

Value Meaning
0 Standard
1 Non-Recourse Shipper Signed

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightComment:   Description for the shipment.

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightDeclaredValue:   The declared value for the shipment.

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightDeclaredValueUnits:   The declared value units.

Identifies the declared value units corresponding to the above defined declared value.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightHazardousMaterialsOfferor:   The offeror of the hazardous materials.

If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightLiabilityCoverageAmount:   The total amount of liability coverage.

This should be set to the total value of the liability coverage.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightLiabilityCoverageType:   The type of liability coverage offered.

This should be set to the type of liability coverage offered.

Valid values are as follows:

Value Meaning
0 New
1 Used or Reconditioned

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightPalletWeight:   Total weight of pallets used in shipment.

This should contain the total weight of all pallets used in this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightRole:   Indicates the role of the party submitting the transaction.

This indicates which party is submitting the transaction for this freight shipment.

Valid values are as follows:

Value Meaning
0 Shipper
1 Consignee

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightShipmentLength:   The overall length of the shipment.

This should be set to the total length of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightShipmentWidth:   The overall width of the shipment.

This should be set to the total width of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightShipmentHeight:   The overall height of the shipment.

This should be set to the total height of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

FreightTotalHandlingUnits:   The total handling units for the shipment.

Total number of individual handling units in the entire shipment (for unit pricing).

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

HTTP Configuration Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is true, the component adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This setting enables HTTP compression for receiving data. When set to true, the component will accept compressed data. It will then uncompress the data it has received. The component will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the component adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable when HTTPVersion is set to "2.0".

If set to True (default) the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback:   Whether to allow fallback from Negotiate to NTLM when authenticating.

This setting only applies when AuthScheme is set to Negotiate. If set to True the component will automatically use NTLM if the server does not support Negotiate authentication. Note that the server must indicate it supports NTLM authentication via the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append:   Whether to append data to LocalFile.

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

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

If the Authorization property contains a non-empty 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 component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

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

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

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.

EncodeURL:   If set to true the URL will be encoded by the component.

If set to True the URL passed to the component 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 component 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 component throws an exception.

Note that 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 could potentially change the conditions of the initial request and create security vulnerabilities.

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

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

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Valid options are:

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

GetOn302Redirect:   If set to true the component will perform a GET on the new location.

The default value is false. If set to true the component will perform a GET on the new location. Otherwise it will use the same HTTP method again.

HTTPVersion:   The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are:

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

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

HTTP/2 Notes

When using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2 the component will automatically use HTTP/1.1 instead. This is done in order 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/2 is supported on all versions of Windows. If the Windows version is prior to Windows 8.1/Windows Server 2012 R2 the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later the system security libraries will be used by default.

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 via incremental indexing. 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.

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

If this setting contains a non-empty 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. An example is:

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 that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

LogLevel:   The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:

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

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

The value 2 (Verbose) additionally logs the content of the request and response including the headers and body for both the request and response.

The value 3 (Debug) logs additional debug information (if any).

MaxHeaders:   Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This config should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

MaxHTTPCookies:   Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This config should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection .

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

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

When FollowRedirects is set to any value besides frNever the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" if the server does not support "2.0" the component will fallback to using "1.1" automatically. This setting will indicate which was used.

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

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

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

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

This configuration option is useful for extending the functionality of the component beyond what is provided.

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

Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

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

This is the same as AuthScheme. This setting is provided for use by components that do not directly expose Proxy properties.

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

This is the same as Password. This setting is provided for use by components that do not directly expose Proxy properties.

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

This is the same as Port. This setting is provided for use by components that do not directly expose Proxy properties.

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

This is the same as Server. This setting is provided for use by components that do not directly expose Proxy properties.

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

This is the same as User. This setting is provided for use by components that do not directly expose Proxy properties.

TransferredData:   The contents of the last response from the server.

This setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the component.

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

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.

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to true, the component 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 component 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.

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

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

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

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 where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

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.

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.

IPPort Configuration 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 component will use Timeout for establishing a connection and transmitting/receiving data.

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

This is the same as AutoDetect. This setting is provided for use by components 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 is the same as Host. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (IPPort only).

This entry is for IPPort only and does not work for other components that descend from IPPort.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

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 component throws an exception.

NOTE: This is the same as Password. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as Port. This setting is provided for use by components 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.

NOTE: This is the same as FirewallType. This setting is provided for use by components 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 component throws an exception.

NOTE: This is the same as User. This setting is provided for use by components that do not directly expose Firewall properties.

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

Note: This value is not applicable in Java.

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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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 Java or MAC.

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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 component returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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

UseNTLMv2:   Whether to use NTLM V2.

When authenticating with NTLM this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

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.

SSL Configuration Settings

CACertFilePaths:   The paths to CA certificate files when using Mono on Unix/Linux.

This setting specifies the paths on disk to CA certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component 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 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

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

When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

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

Enabling this setting has no effect if UseInternalSecurityAPI is False.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the component 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 component is the same.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

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

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

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

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)
SSL2 12 (Hex 0C)

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

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

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

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

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

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLProvider:   The name of the security provider to use.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

The special value "Internal" picks the internal SSL implementation. This does not rely on any system libraries. This is equivalent to setting UseInternalSecurityAPI to True.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed except to a value of "Internal".

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 in Java or when the provider is OpenSSL.

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

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 component 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 UseInternalSecurityAPI is False (default):

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when UseInternalSecurityAPI is False (default) 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 UseInternalSecurityAPI is True:
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 UseInternalSecurityAPI is True include:
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

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

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component 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 component throws an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance:

IPPort.Config("UseInternalSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa");
The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-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 UseInternalSecurityAPI is set to True, 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_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

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

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

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_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_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

  • "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. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

Socket Configuration 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 component 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 component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.

UseBackgroundThread:   Whether threads created by the component are background threads.

If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]