FedExShipIntl Class
Properties Methods Events Configuration Settings Errors
Allows you to generate a FedEx shipping label for any of FedEx international services complete with addresses and barcode, cancel a shipment, or close out the FedEx Ground shipments.
Syntax
inship.fedexshipintl()
Remarks
Generating a shipping label can be done by calling either the GetPackageLabel or the GetShipmentLabels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).
This class also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the CancelShipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the FedExDeveloperKey, FedExPassword, FedExAccountNumber, and FedExMeterNumber.
When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling the CloseGroundShipments method.
To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a FedExDeveloperKey, FedExPassword and a FedExMeterNumber uniquely assigned to your account by FedEx after registration for Web Services.
NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.
Please note that our components support the non-SOAP version of FedEx Web Services. You might have to specify this detail while submitting the certification package. Upon successful certification, FedEx will provide you with new credentials and URL to be used in the production environment (while the credentials work for both SOAP and non-SOAP FedEx Web Services, the URL is SOAP/non-SOAP specific).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| BrokerAddress1 | Street name. |
| BrokerAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| BrokerAddressFlags | Various flags that denote information about the address. |
| BrokerCity | Name of city, town, etc. |
| BrokerCountryCode | Country code. |
| BrokerState | State or province code. |
| BrokerZipCode | Postal code. |
| BrokerCompany | Identifies the contact person's company name. |
| BrokerEmail | Identifies the contact person's email address. |
| BrokerFax | Recipient's fax number. |
| BrokerFirstName | Sender's first name. |
| BrokerLastName | Person's last name. |
| BrokerMiddleInitial | Middle initial. |
| BrokerPhone | Identifies the contact person's phone number. |
| BrokerType | Identifies the type of brokerage. |
| CloseDate | Identifies the date up to which the unclosed FedEx Ground shipments are to be closed. |
| CloseReportFile | File name of the report to be saved and/or printed by customer. |
| CloseReportType | Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request. |
| CloseTime | Identifies the time up to which the unclosed FedEx Ground shipments are to be closed. |
| CloseTrackingNumber | Shipment Ground tracking number. |
| CommercialInvoiceComments | Commercial Invoice comments to be uploaded to customs. |
| CommercialInvoiceFreightCharge | Cost to transport the shipment. |
| CommercialInvoiceInsurance | The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. |
| CommercialInvoiceNumber | Customer's assigned invoice number. |
| CommercialInvoicePurpose | Reason to export the current international shipment Required for dutiable international express or ground shipment. |
| CommercialInvoiceTerms | Indicates the rights to the seller from the buyer. |
| CommodityCount | The number of records in the Commodity arrays. |
| CommodityDescription | Complete and accurate description of this commodity line item. |
| CommodityHarmonizedCode | Unique code representing this commodity line item (for imports only). |
| CommodityManufacturer | Country code where the contents of this commodity line were produced, manufactured or grown in their final form. |
| CommodityNumberOfPieces | The total number of packages, cartons, or containers for the commodity line item. |
| CommodityQuantity | Number of units contained in this commodity line item measured in units specified by the QuantityUnit . |
| CommodityQuantityUnit | Unit of measure used to express the Quantity of this commodity line item. |
| CommodityUnitPrice | Value of each QuantityUnit in Quantity of this commodity line item. |
| CommodityValue | The value of an individual item being shipped. |
| CommodityWeight | The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. |
| DeliveryDate | Date on which shipment is expected to be delivered. |
| DropoffType | Identifies the method by which the package is to be tendered to FedEx. |
| DutiesPayorAccountNumber | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
| DutiesPayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
| DutiesPayorType | Method of payment for shipment, or duties and taxes. |
| FedExAccountNumber | Account number for logging in to the FedEx Server . |
| FedExCSPProductId | Identifies the CSP product. |
| FedExCSPProductVersion | Identifies the CSP product version. |
| FedExCSPUserKey | CSP end user key. |
| FedExCSPUserPassword | CSP end user password. |
| FedExDeveloperKey | Identifying part of the authentication key used for the sender's identity. |
| FedExMeterNumber | Meter number to use for submitting requests to the FedEx Server . |
| FedExPassword | Secret part of authentication key used for the sender's identity. |
| FedExServer | URL for the FedEx Server where the requests are sent. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| FreightGuaranteeDate | The date the freight shipment is guaranteed for. |
| FreightGuaranteeType | Specifies what type of freight guarantee is requested. |
| HoldAtLocationAddress1 | Street name. |
| HoldAtLocationAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| HoldAtLocationCity | Name of city, town, etc. |
| HoldAtLocationCountryCode | Country code. |
| HoldAtLocationState | State or province code. |
| HoldAtLocationZipCode | Postal code. |
| HoldAtLocationContactCompany | Identifies the contact person's company name. |
| HoldAtLocationContactEmail | Identifies the contact person's email address. |
| HoldAtLocationContactFax | Recipient's fax number. |
| HoldAtLocationContactFirstName | Sender's first name. |
| HoldAtLocationContactLastName | Person's last name. |
| HoldAtLocationContactMiddleInitial | Middle initial. |
| HoldAtLocationContactPhone | Identifies the contact person's phone number. |
| HoldAtLocationPhone | Phone number of the FedEx location where the shipment will be hold at. |
| InsuredValue | Total insured amount. |
| IntlExportControlledExportType | The controlled export type. |
| IntlExportEntryNumber | The entry number for the controlled export. |
| IntlExportForeignTradeZoneCode | The foreign trade zone code. |
| IntlExportLicenseNumberExpiration | The license or permit number expiration date. |
| LabelImageType | Type of image or printer commands the label is to be formatted in. |
| MasterTrackingNumber | Tracking number assigned to the whole MPS shipment. |
| PackageCount | The number of records in the Package arrays. |
| PackageBaseCharge | Base charge applicable to this package. |
| PackageCODAmount | The COD monetary value for the package. |
| PackageCODFile | Filename and location to save the CODLabel of this package to. |
| PackageCODLabel | Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request. |
| PackageCODType | The code that indicates the type of funds that will be used for the COD payment for this package. |
| PackageDangerousGoodsAccessible | Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery. |
| PackageDescription | For FedEx, this is the description that appears in the email to identify this package. |
| PackageHeight | The height of the package to be shipped. |
| PackageInsuredValue | Amount of insurance requested for this package. |
| PackageLength | The length of the package to be shipped. |
| PackageNetCharge | Net charge applicable to this package. |
| PackageType | The packaging type of the package being rated and/or shipped. |
| PackageReference | Indicates the package reference type and value, that associates this package (assigned by the customer). |
| PackageShippingLabel | Image of the shipping label for this package return by the Server upon a successful ship response. |
| PackageShippingLabelFile | Filename and location to save the ShippingLabel of this package to. |
| PackageSignatureType | Specifies one of the Delivery Signature Options requested for this package. |
| PackageSpecialServices | Contains the collection of special services offered on the package level. |
| PackageTotalDiscount | Total discount applicable to this package. |
| PackageTotalSurcharges | Total surcharges applicable to this package. |
| PackageTrackingNumber | Tracking number assigned to this package. |
| PackageWeight | Weight of this package. |
| PackageWidth | The width of the package to be shipped. |
| PayorAccountNumber | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
| PayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
| PayorType | Method of payment for shipment, or duties and taxes. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RecipientAddress1 | Street name. |
| RecipientAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| RecipientAddressFlags | Various flags that denote information about the address. |
| RecipientCity | Name of city, town, etc. |
| RecipientCountryCode | Country code. |
| RecipientState | State or province code. |
| RecipientZipCode | Postal code. |
| RecipientCompany | Identifies the contact person's company name. |
| RecipientEmail | Identifies the contact person's email address. |
| RecipientFax | Recipient's fax number. |
| RecipientFirstName | Sender's first name. |
| RecipientLastName | Person's last name. |
| RecipientMiddleInitial | Middle initial. |
| RecipientPhone | Identifies the contact person's phone number. |
| RequestedETDDocuments | Specifies which document type to request from FedEx as an Electronic Trade Document. |
| ReturnAddress1 | Street name. |
| ReturnAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| ReturnAddressFlags | Various flags that denote information about the address. |
| ReturnCity | Name of city, town, etc. |
| ReturnCountryCode | Country code. |
| ReturnState | State or province code. |
| ReturnZipCode | Postal code. |
| ReturnCompany | Identifies the contact person's company name. |
| ReturnEmail | Identifies the contact person's email address. |
| ReturnFax | Recipient's fax number. |
| ReturnFirstName | Sender's first name. |
| ReturnLastName | Person's last name. |
| ReturnMiddleInitial | Middle initial. |
| ReturnPhone | Identifies the contact person's phone number. |
| SenderAddress1 | Street name. |
| SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| SenderAddressFlags | Various flags that denote information about the address. |
| SenderCity | Name of city, town, etc. |
| SenderCountryCode | Country code. |
| SenderState | State or province code. |
| SenderZipCode | Postal code. |
| SenderCompany | Identifies the contact person's company name. |
| SenderEmail | Identifies the contact person's email address. |
| SenderFax | Recipient's fax number. |
| SenderFirstName | Sender's first name. |
| SenderLastName | Person's last name. |
| SenderMiddleInitial | Middle initial. |
| SenderPhone | Identifies the contact person's phone number. |
| ServiceType | Identifies the FedEx international service to use in a ship request. |
| ShipDate | The date on which the package will be tendered to FedEx. |
| ShipmentSpecialServices | Contains the collection of special services offered by FedEx. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| TotalCustomsValue | Total customs value for the shipment. |
| TotalNetCharge | The total net charge applied to the whole shipment (specific to the AccountNumber ). |
| TotalWeight | Total shipment weight. |
| TransitTime | Expected number of days in transit from pickup to delivery. |
| UploadDocumentDetailCount | The number of records in the UploadDocumentDetail arrays. |
| UploadDocumentDetailDocNumber | This is an optional property to specify the sequence number of document to upload. |
| UploadDocumentDetailDocType | This is specifies the document type of the document being uploaded. |
| UploadDocumentDetailFileContent | If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded. |
| UploadDocumentDetailLocalFileName | This contains the path to the file on the local system. |
| UploadDocumentDetailReference | This is an optional property to specify the customer reference for the document. |
| UploadDocumentDetailShipDocument | This indicates if the document will be sent in a subsequent call to GetShipmentLabels or GetPackageLabel . |
| UploadDocumentDetailUploadFileName | This contains the name of file to be uploaded to FedEx. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| CancelPackage | Cancels a single package shipment by deleting it from the shipping log. |
| CancelShipment | Cancels a multi-package (MPS) shipment by deleting it from the shipping log. |
| CloseGroundShipments | Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests. |
| Config | Sets or retrieves a configuration setting . |
| CSPVersionCapture | Uploads your CSP software version information to FedEx when you close your ship day. |
| GetPackageLabel | Generates a shipping label for the specified package. |
| GetShipmentLabels | Generates a shipping label for all packages in the shipment. |
| ReprintDocuments | Reprints the requested document. |
| Reset | Resets the internal state of the component and all properties to their default values. |
| UploadDocuments | Uploads documents to FedEx. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| XPath | Used to retrieve data at any place within the response. |
| Warning | Warning message returned by the server. |
| CSPUserKey | CSP end user key. |
| CSPUserPassword | CSP end user password. |
| CSPProductId | Identifies the CSP product. |
| CSPProductVersion | Identifies the CSP product version. |
| UseSOAP | Determines if the FedEx SOAP web services are used instead of the FedEx XML web services. |
| CustomContent | Defines any custom content to print on the label. |
| CODReferenceIndicator | The reference information to be added to the COD return label. |
| DryIceCount | The number of packages which contain dry ice. |
| PackageDryIceWeight[i] | The weight of the dry ice for each package. |
| SizeUnit | The dimension unit. |
| WeightUnit | Weight unit. |
| BlockVisibility | Whether the visibility of this shipment should be blocked from parties other than shipper/payor. |
| CODRecipientAddress1 | The primary street address of the COD recipient. |
| CODRecipientAddress2 | The secondary street address of the COD recipient. |
| CODRecipientCity | The city of the COD recipient. |
| CODRecipientCompany | The company of the COD recipient. |
| CODRecipientCountryCode | The country code of the COD recipient. |
| CODRecipientName | The name of the COD recipient. |
| CODRecipientPhone | The phone number of the COD recipient. |
| CODRecipientState | The state of the COD recipient. |
| CODRecipientZipCode | The zip code of the COD recipient. |
| CODRecipientResidential | The residential status of the COD recipient. |
| CSPOriginLocationId | Origin location Id for the CSP developer sending the version capture request. |
| CSPProductPlatform | Vendor product platform name. |
| CustomerTransactionId | Customer transaction id. |
| DocTabContent | Custom DocTab content set by the user when preparing a shipping label. |
| DeliveryDay | Day of the week on which shipment is expected to be delivered. |
| LabelFormatType | Indicates the type of label to be returned. |
| LabelOrientationType | Indicates if the top or bottom of the label comes out of the printer. |
| LabelStockType | Indicates the size of the label and the location of the doc tab if present. |
| MaskAccountNumber | Whether the shipper account number is masked on the shipping label. |
| Overwrite | Determines whether label files will be overwritten. |
| PackageDocumentFile | The file path for the additional package documents. |
| ShipmentRatingAggregate | String representing the rating detail on shipment level. |
| ShipTime | Local Time of shipment based on shipper's time zone. |
| AdmissibilityPackageType | Identifies the admissibility package type. |
| B13AFiling | Specifies which option is being exercised by the customer to file the B13A. |
| BookingNumber | Booking confirmation number. |
| CurrencyCode | The currency code associated with the monetary values present in the request. |
| CODType | COD type. |
| CommodityPreferenceCriterion[i] | Preference Criteria for NAFTA Certificate of Origin documents for the commodity at index i. |
| CommodityNaftaProducerDetermination[i] | The Producer determination for NAFTA Certificate of Origin documents for the commodity at index i. |
| CommodityNaftaNetCostMethod[i] | Specifies how the net cost is calculated for the commodity at index i. |
| CommodityNetCostNaftaBeginDate[i] | Beginning date if the net cost is calculated over a period of time for the commodity at index i. |
| CommodityNetCostNaftaEndDate[i] | Ending date if the net cost is calculated over a period of time for the commodity at index i. |
| DeliveryInstructions | Delivery instructions. |
| Documents | Whether an international shipment contains only documents or no documents. |
| ExportCompliance | This is an export compliance statement. |
| InvoiceSpecialInstructions | Special instructions for commercial invoices. |
| LoadAndCount | Shipper's Load and Count (SLAC) = total shipment pieces. |
| NaftaAuthorizedSignatureName | The name of the Signature Contact. |
| NaftaAuthorizedSignatureCompany | The Company associated with the Signature Contact. |
| NaftaAuthorizedSignaturePhone | The Phone number associated with the Signature Contact. |
| NaftaBlanketPeriodBeginDate | The beginning date for the blanket period. |
| NaftaBlanketPeriodEndDate | The ending date for the blanket period. |
| NaftaImporterSpecification | The importer specification for the NAFTA Certificate of Origin. |
| NotifyAggregate[i] | The aggregate xml for the recipient to be notified. |
| NotifyCount | The number of recipients to be notified. |
| NotifyEmail[i] | Email address of the recipient to be notified. |
| NotifyMessage[i] | User defined text that will be included in the email. |
| NotifyNotificationFlags[i] | Identifies the type of notification requested. |
| NotifyRecipientType[i] | Identifies the set of valid email notification recipient types. |
| PackageAlcoholRecipientType[i] | The type of recipient for an Alcohol Special Service package. |
| RecipientTinType | Indicates the type of the recipient tax identification number (TIN). |
| RecipientTinNumber | Indicates the corresponding Id number for recipient TIN type. |
| RegulatoryControlType | Identifies the type of regulatory control. |
| ReturnType | Identifies the reason for return. |
| ReturnDescription | Description for the return. |
| SenderTinType | Indicates the type of the shipper tax identification number (TIN). |
| SenderTinNumber | Indicates the corresponding Id number for shipper TIN type. |
| ShippingDocumentTypes | Specifies which document type to get. |
| ShippingDocumentFile | Identifies the location of the document file. |
| FreightAccountNumber | Account number used with the FedEx Freight service. |
| FreightBillingPersonName | The name of the person to be billed. |
| FreightBillingCompanyName | The name of the company to be billed. |
| FreightBillingPhone | The phone number of the party to be billed. |
| FreightBillingFax | The fax number of the party to be billed. |
| FreightBillingEmail | The email of the party to be billed. |
| FreightBillingAddress1 | The first address line of the party to be billed. |
| FreightBillingAddress2 | The second address line of the party to be billed. |
| FreightBillingCity | The city of the party to be billed. |
| FreightBillingState | The state of the party to be billed. |
| FreightBillingCountryCode | The country code of the party to be billed. |
| FreightBillingZipCode | The zip code of the party to be billed. |
| FreightAlternateBillingAccountNumber | The alternate account number to be billed. |
| FreightAlternateBillingPersonName | The name of the person to be billed. |
| FreightAlternateBillingCompanyName | The name of the company to be billed. |
| FreightAlternateBillingStreetAddress | The street address line of the party to be billed. |
| FreightAlternateBillingCity | The city of the party to be billed. |
| FreightAlternateBillingState | The state of the party to be billed. |
| FreightAlternateBillingCountryCode | The country code of the party to be billed. |
| FreightAlternateBillingZipCode | The zip code of the party to be billed. |
| FreightClientDiscountPercent | Estimated discount rate provided by client for unsecured rate quote. |
| FreightCollectTermsType | The terms of the collect payment for a Freight Shipment. |
| FreightComment | Description for the shipment. |
| FreightDeclaredValue | The declared value for the shipment. |
| FreightDeclaredValueUnits | The declared value units. |
| FreightHazardousMaterialsOfferor | The offeror of the hazardous materials. |
| FreightLiabilityCoverageAmount | The total amount of liability coverage. |
| FreightLiabilityCoverageType | The type of liability coverage offered. |
| FreightPalletWeight | Total weight of pallets used in shipment. |
| FreightRole | Indicates the role of the party submitting the transaction. |
| FreightShipmentLength | The overall length of the shipment. |
| FreightShipmentWidth | The overall width of the shipment. |
| FreightShipmentHeight | The overall height of the shipment. |
| FreightTotalHandlingUnits | The total handling units for the shipment. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |