FedExFreightShip Configuration

This returns the complete request as sent to the server. Used for debugging purposes.

This returns the complete response as received from the server. Used for debugging purposes.

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML-formatted RawResponse.

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:

When XPath is set to a valid path, the text contained at that element (if any) is returned. If there is no value present, or the xpath is invalid, and empty string ("") will be returned.

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

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

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

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.

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.

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

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

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

Possible values are:

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.

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.

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.

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.

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

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

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

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

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

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

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

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

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

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

This indicates whether the COD recipient is a residential address.

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

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

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.

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.

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.

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

Valid values are:

Valid printing orientation types are:

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:

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

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

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.

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.

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

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:

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.

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.

This optional field identifies the preferred currency of the requestor.

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.

Used with Freight services only.

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.

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

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

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.

Shipper's Bill of Lading number to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

Shipper Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

Consignee Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

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:

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.

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.

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:

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.

This element indicates the format in which the shipping document should be printed.

Possible values are:

All 'Paper *' items should be used when a laser printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to PDF or PNG).

All 'Stock *' items should be used when a thermal printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to ELP2, ZPLII or DPL).

By Default, 7 (PAPER_LETTER) will be used. Valid label stock types are:

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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

Valid values are as follows:

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

Valid values are as follows:

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

Valid values are as follows:

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

This should contain the length of the freight item.

Valid array indices are from 0 to CommodityCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

This should contain the height of the freight item.

Valid array indices are from 0 to CommodityCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

This should contain the width of the freight item.

Valid array indices are from 0 to CommodityCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.

Valid array indices are from 0 to CommodityCount - 1.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

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.

This is the same as the AllowHTTPCompression property. This setting is exposed here for use by components that inherit from HTTP.

By default the component does not allow redirects to the same URL to avoid redirect loops. In some cases the server may intentionally redirect the client back to the same URL. In that case this setting may be set to True to allow the redirect to be followed. The default value is False.

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.

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

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.

The default value is false. If set to true the URL passed to the component will be URL encoded.

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

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.

Possible values include "1.0", and "1.1". The default is "1.1".

This is the same as the IfModifiedSince property. This setting is exposed here for use by components that inherit from HTTP.

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.

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 .

NOTE: This functionality is only available in Java and .NET.

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 .

NOTE: This functionality is only available in Java and .NET.

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.

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.

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.

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

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

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

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

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

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.

This configuration setting returns the complete set of raw headers as received from the server.

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.

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.

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

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

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

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.

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.

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

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.

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.

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.

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.

The appropriate values are as follows:

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

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.

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.

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.

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

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

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

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.

If set to a positive value, this setting defines the length of data records to be received. The component will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

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.

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:

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.

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.

This setting specifies the allowed server certificate signature algorithms when UseManagedSecurityAPI 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("UseManagedSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-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.

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.

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.

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:

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

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

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.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

This functionality is currently not available in Java or when the provider is OpenSSL.

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

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

• 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

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");

• TLS_DH_ANON_EXPORT_WITH_DES40_CBC_SHA
• TLS_DH_ANON_WITH_3DES_EDE_CBC_SHA
• TLS_DH_ANON_WITH_AES_128_CBC_SHA
• TLS_DH_ANON_WITH_AES_128_CBC_SHA256
• TLS_DH_ANON_WITH_AES_256_CBC_SHA
• TLS_DH_ANON_WITH_AES_256_CBC_SHA256
• TLS_DH_ANON_WITH_DES_CBC_SHA
• TLS_DH_ANON_WITH_RC4_128_MD5
• TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
• 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_EXPORT_WITH_DES40_CBC_SHA
• 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_EXPORT_WITH_DES40_CBC_SHA
• 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

SSLEnabledCipherSuites is used together with SSLCipherStrength.

Note: This configuration setting is available only in .NET and Java.

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.

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

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.

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.

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.

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.

By default the component will use the system security libraries to perform cryptographic functions. This means 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 managed implementation instead of using the system's security API.

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