Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

FedExShip Configuration

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

FedExShip 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 retrieve data at any place within the response.

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:

'name'A particular element name.
[i]The i-th subelement of the current element.
..the parent of the current element.

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.

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 (FedExDeveloperKey and FedExPassword 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 (FedExDeveloperKey and FedExPassword 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 FedExAccountNumber, FedExMeterNumber 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 FedExAccountNumber, FedExMeterNumber and CSPProductId.

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

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

If False, the class will use the FedEx XML based web services. When using the XML based web services the FedExServer 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).

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

AccessTime:   Time window for FedEx to pickup up the package.

This is returned after a call to PickupAvailability, and contains the window of time in which FedEx requires for pickup. The difference between the package ready time (ShipTime) and the CompanyCloseTime must be equal to or greater than this amount of time. This value may vary depending on location.

BookingNumber:   Booking confirmation number.

This is applicable when using any of the FedEx Express domestic (U.S.) freight services: FedEx 1Day Freight, FedEx 2Day Freight and FedEx 3Day Freight. (i.e., when the ServiceType is set to ST_FEDEX1DAYFREIGHT, ST_FEDEX2DAYFREIGHT or ST_FEDEX3DAYFREIGHT).

An advance booking number is required for FedEx Express 1Day Freight. When you call 1.800.332.0807 to book your freight shipment, you will receive a booking number. This booking number must be included in the ship request, and prints on the shipping label.

Values must be 8-12 characters in length.

CloseSmartPostShipments:   Sends a request to close SmartPost Shipments.

This configuration setting is used for closing SmartPost Shipments. When set, CloseSmartPostShipments immediately sends a request to FedEx. CarrierType must be set to either FedEx Ground or FedEx Smart Post depending on which driver picks up your FedEx SmartPost packages.

For Example:

ship.CarrierType = FedexshipCarrierTypes.ctFXSP;

ship.Config("CloseSmartPostShipments");

CODRecipientAddress1:   Street name of the COD recipient.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientAddress2:   A specific detail on the COD recipient's address (such as building, suite, apartment, floor number etc.).

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

Combination of CODRecipientAddress1 and CODRecipientAddress2 should not exceed 35 characters.

CODRecipientCity:   Name of city, town, etc. of the COD recipient.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: for Express is 35, for Ground is 20.

CODRecipientCompany:   Company name of the COD recipient.

Either CODRecipientName or CODRecipientCompany is required to be provided in a COD shipping request. The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientCountryCode:   Country code of the COD recipient.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 2.

CODRecipientName:   Name of the COD recipient.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientPhone:   Phone number of the COD recipient.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientResidential:   Indicates whether the COD recipient address is residential (as opposed to commercial).

If False, the address will be considered as commercial by FedEx server. The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

CODRecipientState:   State or province code of the COD recipient.

This is the identifying abbreviation for US state, Canada province, etc. The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

Maximum length: 14.

CODRecipientZipCode:   Postal code of the COD recipient.

This is identification of a region (usually small) for mail/package delivery. Format and presence of this configuration will vary, depending on country.

The COD return label uses your sender information (SenderContact and SenderAddress as the recipient for the COD payment. Use this configuration to override the behavior.

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

CODTrackingNumber:   The COD Tracking Number.

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package. It is read-only.

CutoffTime:   Latest pickup time.

This is returned after a call to PickupAvailability, and will contain the latest time the package can be picked up at the given address.

DeliveryInstructions:   Delivery instructions.

Used with Ground Home Delivery and Freight services.

EmailLabelExpirationDate:   Email label's expiration date.

This must be set if Pending Shipments is set in ShipmentSpecialServices. The maximum expiration date must be greater or equal to the day of the label request and not greater than 30 days in the future. The date's format should be YYYY-MM-DD.

ListTotalNetCharge[i]:   Total net charge for list rates applied at package level at index i (if applicable).

This returns the list-based rates.

Valid array indices are from 0 to Packages.Count - 1. This setting is read-only.

MerchantPhoneNumber:   The merchant's phone number.

This must be set if Pending Shipments is set in ShipmentSpecialServices. Include the phone number for the merchant, such as a general customer service phone number.

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.

PackageCount:   The number of packages to be picked up.

If set this will be used to specify the number of packages to be picked up during a SchedulePickup request.

PackageRatingAggregate[i]:   String representing the rating detail on package level (at index i).

Valid array indices are from 0 to Packages.Count - 1. This setting is read-only.

PayorPhone:   Payor's phone number.

This setting represents the PhoneNumber of the Payor when using the following PayorType values:

  • ptCollect
  • ptConsignee
  • ptThirdParty

Note: If the PayorType is ptSender or ptRecipient, the component will use SenderContact.Phone or RecipientContact.Phone, respectively.

RMANumber:   The RMA number.

The RMA number associated with the return shipment. This is an alpha-numeric value up to 20 characters in length.

RMAReason:   The RMA reason description.

This is optional to be provided when the ReturnShipment special service is requested and applicable only if the RMANumber was provided. This element allows you to enter up to 60 alpha-numeric characters.

SpecialInstructions:   Special instructions for the courier.

Set this when calling SchedulePickup to add any additional remarks that the courier may need when picking up the packages. This is required when canceling a pickup with FedEx Ground.

UseAccountAddress:   Whether or not the pickup should be sent to the address associated with the account.

Set this to true to tell FedEx to use the address associated with the sender account to pickup the packages when calling SchedulePickup. By default, this value is false, and the address for pickup will be specified by the SenderAddress.

SmartPostAncillaryEndorsement:   The endorsement type used for a FedEx SmartPost shipment.

Set this config to specify the endorsement type used for a FedEx SmartPost shipment. This is optional when using FedEx SmartPost service.

The applicable values include the following:

0None (default setting)
1Address Correction
2Carrier Leave If No Response
3Change Service
4Forwarding Service
5Return Service

SmartPostCustomerManifestId:   The Customer Manifest Id used to group FedEx SmartPost packages.

Set this config to specify the Customer Manifest Id which is used to group FedEx SmartPost packages onto a manifest for each trailer that is being prepared. You must assign a unique Manifest Id to each FedEx SmartPost package, when you have multiple trailers. If you have a single trailer, then this config is optional. The Manifest Id must be unique to your account number for a minimum of six months and cannot exceed eight characters in length.

SmartPostHubId:   The HubId used to send FedEx SmartPost shipments.

When you want to ship packages via FedEx SmartPost, you will have to specify the SmartPostHubId. By setting this, the server will consider your shipment as a SmartPost one. ServiceType will automatically be set to the correct value when this is specified.

SmartPost cannot be enabled via Web Support. You will need to contact your local Account Executive to enable SmartPost for your account. Depending on the zip code associated with your account, they can also provide you with the correct Hub Id for production. This config should only be set using the numeric Hub Id value. For example, to set the Hub Id for Charlotte area: ship.Config("SmartPostHubId=5281"). In regards to test, you should be able to test your transactions by supplying a dummy Hub Id of 5531.

Note: SmartPost ships via FedEx using FedEx Ground. The only available packaging type for Ground is 'Your Packaging', so SmartPost can only use this as packaging type, and the package dimensions are required to be entered in the request as well. The package weight limitations depend on the value of SmartPostIndicia which is also required to be provided in the request.

SmartPostIndicia:   The Indicia type used for a FedEx SmartPost shipment.

Set this config to specify the Indicia type used for a FedEx SmartPost shipment. This is required when using FedEx SmartPost service.

The applicable values include the following:

0Media Mail (default setting) - to be used for Books, DVDs, CDs, videotapes, weight: 1 lb to 70 lbs
1Parcel Select - to be used for general packages greater than 1 lb, weight: 1 lb to 70 lbs
2Presorted Bound Printed Matter - to be used for Catalogs, phone books or anything permanently bound, weight: 0.1 lb to 15 lbs
3Presorted Standard - to be used for general packages up to 1 lb

SmartPostPhysicalPackaging:   Additional details about the physical packaging of the item in a FedEx SmartPost shipment.

Set this config to specify additional details about how the item has been physically packaged for a FedEx SmartPost shipment. This is required when using FedEx SmartPost.

The applicable values include the following:

0Other (default setting)
1Bag
2Barrel
3Basket
4Box
5Bucket
6Bundle
7Carton
8Case
9Container
10Crate
11Cylinder
12Drum
13Envelope
14Hamper
15Pail
16Pallet
17Piece
18Reel
19Roll
20Skid
21Tank
22Tube

SmartPostTrackingNumbers:   Contains the tracking numbers for a FedEx SmartPost shipment.

This config contains all the available tracking numbers for a FedEx SmartPost shipment. This will return the tracking numbers as a comma separated string in the form: [TrackingIdType]=[TrackingNumber]

An example of a possible value is: USPS=12345,GROUND=67890

HTTP Configuration Settings

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

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

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

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

AllowIdenticalRedirectURL:   Allow redirects to the same URL.

By default the class 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.

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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

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

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

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

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

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

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

Valid options are:

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

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

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

HTTPVersion:   The version of HTTP used by the class.

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

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

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

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.

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

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

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 class 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 ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

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

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

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

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

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

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

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

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

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

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

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

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

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

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to true, the class will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the class will not use HTTP chunked encoding. The default value is false.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

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

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

UserAgent:   Information about the user agent (browser).

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.

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

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

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

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

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

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

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

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

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

NOTE: This is the same as FirewallPassword. This setting is provided for use by classs 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 FirewallPort. This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

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

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

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

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

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

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 number of times that the keep-alive packets will be re-sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform, and isn't supported in Mac OS or FreeBSD.

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 class 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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 TCP port in the local host where the class binds.

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

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by 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.

RecordLength:   The length of received data records.

If set to a positive value, this setting defines the length of data records to be received. The class 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.

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 class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

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

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

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

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.

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

SSLSecurityFlags:   Flags that control certificate verification.

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

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

Base Configuration Settings

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

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

Base Configuration Settings

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

The default code page is the Active Code Page (0).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multlingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangeul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0