# AS3Sender Class The AS3Sender class implements an AS3 / EDI-INT client. ## Syntax **ipworksedi.as3sender()** ## Remarks The AS3Sender component may be used to send EDI or other messages over FTP/S, using the AS3 protocol. It may also be used to verify Message Disposition Notifications (MDNs) returned by the server. A typical AS3 transaction is as follows: (1) The sender sends an EDI document to the receiver using FTP. The document may be signed, encrypted, and/or compressed, and a signed or unsigned receipt may be requested. (2) The receiver decompresses and decrypts the message and verifies the signature. (3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message. **When sending an EDI message**, the client should specify, at a minimum, [AS3From](#as3senderas3from-property) and [AS3To](#as3senderas3to-property), EDIDataData, and EDIDataEDIType. You will also need to specify [User](#as3senderuser-property), [Password](#as3senderpassword-property), and [RemoteHost](#as3senderremotehost-property) to [Logon](#as3senderlogon-method) to the FTP server. After doing this you may send the data by calling [Send](#as3sendersend-method). **To secure the EDI transmission**, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data set [SigningCert](#as3sendersigningcert-property). To encrypt, set [RecipientCerts](#as3senderrecipientcerts-property). **TLS/SSL** may be enabled by setting the [SSLStartMode](#as3sendersslstartmode-property) property. In case your trading partner is using a self-signed certificate it will be necessary to set [SSLAcceptServerCert](#as3sendersslacceptservercert-property) or trap the [SSLServerAuthentication](#as3sendersslserverauthentication-event) event to accept the certificate. The message may also be **compressed** by setting [CompressionFormat](#as3sendercompressionformat-property). **To request a receipt**, or Message Disposition Notification (MDN), simply set the [MDNTo](#as3sendermdnto-property) property. The MDN will be returned to the FTP URL specified. The [MDNOptions](#as3sendermdnoptions-property) property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash. **Validating AS3 MDNs** AS3 MDNs will be returned asynchronously over a separate connection. You may verify MDNs by invoking [ReadReceipt](#as3senderreadreceipt-method). This will read the receipt from the FTP server (or from the [MDNReceipt](#as3sendermdnreceipt-property) property). It will determine the [MessageId](#as3sendermessageid-property) of the original message and determine the originator and recipient of the MDN. You should then look up your trading partner's certificates as well as the [OriginalContentMIC](#as3senderoriginalcontentmic-property) (which you *must* store externally to verify signed receipts), and invoke [VerifyReceipt](#as3senderverifyreceipt-method). ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AS3From](#as3senderas3from-property) | The identity of the sending system. | | [AS3To](#as3senderas3to-property) | The identity of the receiving system. | | [AS3Version](#as3senderas3version-property) | The version of AS3 being used. | | [Attachments](#as3senderattachments-property) | Collection of files attached to the current message. | | [CompressionFormat](#as3sendercompressionformat-property) | The compression format (if any) to use. | | [Connected](#as3senderconnected-property) | Whether the class is connected. | | [EDIData](#as3senderedidata-property) | The EDI or other data to be sent. | | [EncryptionAlgorithm](#as3senderencryptionalgorithm-property) | The algorithm used to encrypt the EDI data. | | [Firewall](#as3senderfirewall-property) | A set of properties related to firewall access. | | [FTPLastReply](#as3senderftplastreply-property) | The last reply from the FTP server. | | [LocalHost](#as3senderlocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LogDirectory](#as3senderlogdirectory-property) | The path to a directory for logging. | | [LogFile](#as3senderlogfile-property) | The log file written. | | [MDNOptions](#as3sendermdnoptions-property) | Used to indicate the options requested for the MDN receipt. | | [MDNReceipt](#as3sendermdnreceipt-property) | The MDN receipt returned from the server. | | [MDNTo](#as3sendermdnto-property) | The system to which an MDN should be directed. | | [MessageId](#as3sendermessageid-property) | The Id of the message. | | [OriginalContentMIC](#as3senderoriginalcontentmic-property) | The Message Integrity Check(s) (one-way hash) of the outgoing message. | | [Passive](#as3senderpassive-property) | This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall. | | [Password](#as3senderpassword-property) | This is the password used to log in. | | [ReceiptSignerCert](#as3senderreceiptsignercert-property) | The public key certificate for the MDN receipt signature. | | [RecipientCerts](#as3senderrecipientcerts-property) | The public key certificates of the recipients for this message. | | [RemoteHost](#as3senderremotehost-property) | This is the domain name or IP address of the FTP server. | | [RemotePort](#as3senderremoteport-property) | This is the port for the FTP service (default is 21). | | [SignatureAlgorithm](#as3sendersignaturealgorithm-property) | Signature algorithm to be used in outgoing messages. | | [SigningCert](#as3sendersigningcert-property) | Contains the certificate to use when signing messages. | | [SSLAcceptServerCert](#as3sendersslacceptservercert-property) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#as3sendersslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#as3sendersslprovider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#as3sendersslservercert-property) | The server certificate for the last established connection. | | [SSLStartMode](#as3sendersslstartmode-property) | Determines how the class starts the SSL negotiation. By default, SSL will not be used. | | [Subject](#as3sendersubject-property) | The subject of the message. | | [Timeout](#as3sendertimeout-property) | The timeout for the class. | | [User](#as3senderuser-property) | This property contains the user identifier to use to log in. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Abort](#as3senderabort-method) | The method aborts the current upload or download. | | [ChangeRemotePath](#as3senderchangeremotepath-method) | This method changes the current path on the FTP server. | | [Config](#as3senderconfig-method) | Sets or retrieves a configuration setting. | | [DeleteFile](#as3senderdeletefile-method) | This method removes a file specified by FileName from an FTP server. | | [GetFileSize](#as3sendergetfilesize-method) | Gets the size of a file on the FTP server. | | [GetFileTime](#as3sendergetfiletime-method) | Gets the last modification time of a file on the FTP server. | | [ListDirectory](#as3senderlistdirectory-method) | List the current directory on an FTP server. | | [ListDirectoryLong](#as3senderlistdirectorylong-method) | List the current directory on an FTP server. | | [Logoff](#as3senderlogoff-method) | This method is used to log off from the FTP server by posting a QUIT command. | | [Logon](#as3senderlogon-method) | Logon to the FTP RemoteHost using the current User and Password . | | [QueryRemotePath](#as3senderqueryremotepath-method) | This queries the server for the current path. | | [ReadReceipt](#as3senderreadreceipt-method) | Reads and parses (but does not verify) an MDN receipt. | | [Reset](#as3senderreset-method) | Resets the state of the control. | | [Send](#as3sendersend-method) | Prepares and sends the AS3 message. | | [SendFTPCommand](#as3sendersendftpcommand-method) | Sends the exact command directly to the server. | | [VerifyReceipt](#as3senderverifyreceipt-method) | Verifies an MDN receipt. | ## 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.* | | | | --- | --- | | [ConnectionStatus](#as3senderconnectionstatus-event) | Fired to indicate changes in the connection state. | | [DirList](#as3senderdirlist-event) | This event is fired when a directory entry is received. | | [EndTransfer](#as3senderendtransfer-event) | This event is fired when a file finishes downloading or uploading. | | [Error](#as3sendererror-event) | Fired when information is available about errors during data delivery. | | [Log](#as3senderlog-event) | Fired with log information while processing a message. | | [PITrail](#as3senderpitrail-event) | This event traces the commands sent to the server, and the respective replies. | | [SSLServerAuthentication](#as3sendersslserverauthentication-event) | Fired after the server presents its certificate to the client. | | [SSLStatus](#as3sendersslstatus-event) | Fired when secure connection progress messages are available. | | [StartTransfer](#as3senderstarttransfer-event) | This event fires when a file starts downloading or uploading. | | [Transfer](#as3sendertransfer-event) | This event is fired during the file download or upload. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CalculateProcessingPercentDone](#CalculateProcessingPercentDone) | Whether to show the progress of file processing. | | [LogFilename](#LogFilename) | The base name of the log file. | | [LogonAfterProcessing](#LogonAfterProcessing) | Whether to prepare the file before connecting to the FTP server. | | [ActiveModeIP](#ActiveModeIP) | Allows the specification of the IP address that the server will connect to for active mode connections. | | [ActiveModePORTAddress](#ActiveModePORTAddress) | Allows the specification of the PORT address value for active mode connections. | | [AppendToLocalFile](#AppendToLocalFile) | Append downloaded files to a local file. | | [ApplyFileMaskLocally](#ApplyFileMaskLocally) | Whether to filter the directory listing locally or on the server. | | [AutoSelectDataIP](#AutoSelectDataIP) | Automatically select the data connection IP. | | [CalculatePercentDone](#CalculatePercentDone) | Enables or Disables calculating the percent complete for downloads. | | [CheckTotalEntry](#CheckTotalEntry) | Whether to ignore directory listing total lines. | | [DILinger](#DILinger) | When set to True, DI connections are terminated gracefully. | | [DILingerTime](#DILingerTime) | Time in seconds to have the DI connection linger. | | [FileTimeFormat](#FileTimeFormat) | The format of file time reported by the server. | | [IgnoreEntries](#IgnoreEntries) | Directory entry data to ignore. | | [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. | | [ModeZCompressionLevel](#ModeZCompressionLevel) | Used to specify the level of compression used. | | [PortRange](#PortRange) | Allows the specification of a port range where the class listens for active mode connections. | | [PreserveFileTime](#PreserveFileTime) | Attempts to preserve timestamps when transferring files. | | [RealTimeUpload](#RealTimeUpload) | Enables real time uploading. | | [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) | The age limit in seconds when using RealTimeUpload. | | [ReusePISSLSessionInDI](#ReusePISSLSessionInDI) | Whether the PI SSL session will be reused for the DI connection. | | [ReuseSSLSessionInDI](#ReuseSSLSessionInDI) | Whether the SSL session will be reused for the DI connection. | | [UseClearChannel](#UseClearChannel) | Allows for the Clear Command Channel (CCC) command. | | [UseClearDataChannel](#UseClearDataChannel) | Allows for the PROT C command. | | [UseEPSV](#UseEPSV) | Allows extended passive mode. | | [UseMLSD](#UseMLSD) | Uses listings for machine processing. | | [UseMLST](#UseMLST) | Uses single file listing for machine processing. | | [UseModeZ](#UseModeZ) | Allows compression to be used when transferring data. | | [UseOldAUTHSSL](#UseOldAUTHSSL) | Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'. | | [UseProtWhenImplicit](#UseProtWhenImplicit) | Sends the PROT P command to the server. | | [UseRemoteHostAddressForPassive](#UseRemoteHostAddressForPassive) | Instructs the class to use the address specified by RemoteHost when establishing a data connection. | | [VirtualHostName](#VirtualHostName) | Sends the HOST command to the server. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # [AS3Sender](#as3sender-class).AS3From Property The identity of the sending system. ## Syntax ```text getAS3From(): string; setAS3From(AS3From: string): void; ``` ## Default Value "" ## Remarks May be company name, DUNS number, or anything agreed on by trading partners. Required. # [AS3Sender](#as3sender-class).AS3To Property The identity of the receiving system. ## Syntax ```text getAS3To(): string; setAS3To(AS3To: string): void; ``` ## Default Value "" ## Remarks May be company name, DUNS number, or anything agreed on by trading partners. Required. # [AS3Sender](#as3sender-class).AS3Version Property The version of AS3 being used. ## Syntax ```text getAS3Version(): string; setAS3Version(AS3Version: string): void; ``` ## Default Value "1.0" ## Remarks The version of AS3 being used. Should be "1.0". # [AS3Sender](#as3sender-class).Attachments Property Collection of files attached to the current message. ## Syntax ```text getAttachments(): EDIAttachmentList; ``` ## Default Value ## Remarks When a call to [Send](#as3sendersend-method) is made, the class will attach the files referenced by each [EDIAttachment](#ediattachment-type) in this collection to the [EDIData](#as3senderedidata-property). This property is not available at design time. Please refer to the [EDIAttachment](#ediattachment-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).CompressionFormat Property The compression format (if any) to use. ## Syntax ```text getCompressionFormat(): AS3SenderCompressionFormats; setCompressionFormat(compressionFormat: AS3SenderCompressionFormats): void; enum AS3SenderCompressionFormats { cfNone, cfZLIB } ``` ## Default Value 0 ## Remarks By default, outgoing data will not be compressed. Setting this property will instruct the class to compress the outgoing data using the indicated format. Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required. The compression algorithm used is **Zlib**, as required by RFC 3274 and defined in RFCs 1950 and 1951. # [AS3Sender](#as3sender-class).Connected Property Whether the class is connected. ## Syntax ```text isConnected(): boolean; ``` ## Default Value FALSE ## Remarks This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection. This property is read-only and not available at design time. # [AS3Sender](#as3sender-class).EDIData Property The EDI or other data to be sent. ## Syntax ```text getEDIData(): EDIData; setEDIData(EDIData: EDIData): void; ``` ## Default Value ## Remarks The EDI message to send. This property is not available at design time. Please refer to the [EDIData](#edidata-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).EncryptionAlgorithm Property The algorithm used to encrypt the EDI data. ## Syntax ```text getEncryptionAlgorithm(): string; setEncryptionAlgorithm(encryptionAlgorithm: string): void; ``` ## Default Value "AESCBC256" ## Remarks If [RecipientCerts](#as3senderrecipientcerts-property) contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted. The class supports **"AESCBC256"**, or industry-standard 256-bit AES-CBC encryption, by default. The class supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 (default) - AESGCM128 - AESGCM192 - AESGCM256 # [AS3Sender](#as3sender-class).Firewall Property A set of properties related to firewall access. ## Syntax ```text getFirewall(): Firewall; setFirewall(firewall: Firewall): void; ``` ## Default Value ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).FTPLastReply Property The last reply from the FTP server. ## Syntax ```text getFTPLastReply(): string; ``` ## Default Value "" ## Remarks The last reply from the FTP server. This property is read-only. # [AS3Sender](#as3sender-class).LocalHost Property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text getLocalHost(): string; setLocalHost(localHost: string): void; ``` ## Default Value "" ## Remarks This property 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property 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 multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # [AS3Sender](#as3sender-class).LogDirectory Property The path to a directory for logging. ## Syntax ```text getLogDirectory(): string; setLogDirectory(logDirectory: string): void; ``` ## Default Value "" ## Remarks Setting **LogDirectory** will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response. The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS3 messages created or downloaded by the class will be written with extension ".as3", and MDNs created or downloaded will be written with extension ".as3-mdn". The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed [LogFile](#as3senderlogfile-property) will contain the name of the files just written, minus the extension ".log" or ".err". If logs cannot be written an exception will be thrown. # [AS3Sender](#as3sender-class).LogFile Property The log file written. ## Syntax ```text getLogFile(): string; ``` ## Default Value "" ## Remarks In case [LogDirectory](#as3senderlogdirectory-property) is specified two log files will be written in the specified directory and LogFile will contain the path. LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS3 messages and MDNs will also be written with extensions ".as3" and ".as3-mdn". This property is read-only. # [AS3Sender](#as3sender-class).MDNOptions Property Used to indicate the options requested for the MDN receipt. ## Syntax ```text getMDNOptions(): string; setMDNOptions(MDNOptions: string): void; ``` ## Default Value "signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256" ## Remarks By default, the class will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard. Set MDNOptions to an empty string to request an unsigned receipt. This property will automatically be updated when [SignatureAlgorithm](#as3sendersignaturealgorithm-property) is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value. The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm. When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed in the requested MIC algorithms. SHA-256, SHA-384, or SHA-512 are recommended instead. # [AS3Sender](#as3sender-class).MDNReceipt Property The MDN receipt returned from the server. ## Syntax ```text getMDNReceipt(): MDNReceipt; setMDNReceipt(MDNReceipt: MDNReceipt): void; ``` ## Default Value ## Remarks This property will contain an instance of [MDNReceipt](#mdnreceipt-type) with the complete MDN receipt returned from the AS2 receiver. The receipt will be a signed or unsigned multipart/report in MIME format. For synchronous MDN requests, this property is populated automatically after the call to Post. If an asynchronous MDN is sent over HTTP, it may be read from the HTTP context by calling ReadAsyncReceipt, or it may be set manually. When MDNReceipt is set to a valid MDN receipt, the originator of the receipt will be stored in AS2To, the intended recipient (presumably your system) will be stored in AS2From, and the original message ID will be stored in [MessageId](#as3sendermessageid-property). If you are processing a MDN receipt asynchronously, you can use the values to look up the original message and validate the receipt. Set the [OriginalContentMIC](#as3senderoriginalcontentmic-property), [MDNOptions](#as3sendermdnoptions-property), and [ReceiptSignerCert](#as3senderreceiptsignercert-property) to the values originally computed when the message was sent (if you are requesting async MDNs you must save this information externally.). You can then validate the asynchronous receipt by invoking [VerifyReceipt](#as3senderverifyreceipt-method). Alternatively, AsyncMDNInfoDir may be set in place of [OriginalContentMIC](#as3senderoriginalcontentmic-property), [MessageId](#as3sendermessageid-property), and [MDNOptions](#as3sendermdnoptions-property) (provided it was set to the same value when the message was sent). If AsyncMDNInfoDir was specified when the message was sent, the class would have saved [OriginalContentMIC](#as3senderoriginalcontentmic-property) and [MDNOptions](#as3sendermdnoptions-property) to a file identified by the [MessageId](#as3sendermessageid-property) for the transmission. These properties are read from the file matching the [MessageId](#as3sendermessageid-property) in the MDNReceipt automatically if AsyncMDNInfoDir is specified. NOTE: MDNReceipt must be populated prior to calling [VerifyReceipt](#as3senderverifyreceipt-method). Please refer to the [MDNReceipt](#mdnreceipt-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).MDNTo Property The system to which an MDN should be directed. ## Syntax ```text getMDNTo(): string; setMDNTo(MDNTo: string): void; ``` ## Default Value "" ## Remarks If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. You should specify a valid FTP URL for the request, e.g., "ftp://123.0.0.1". By default, the class will request a PKCS#7 signature signed over SHA-1. You may set [MDNOptions](#as3sendermdnoptions-property) to customize this. # [AS3Sender](#as3sender-class).MessageId Property The Id of the message. ## Syntax ```text getMessageId(): string; setMessageId(messageId: string): void; ``` ## Default Value "" ## Remarks The Id format is as in RFC 2822: *id-left@id-right* . A unique Id will automatically be generated on startup. Sending a message will reset *id-left* if the **MessageId** has been used in the previous message. If you set MessageId to a string of the form "@(id-right)" a unique *id-left* will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same *id-right*. After an [MDNReceipt](#as3sendermdnreceipt-property) is returned or set, MessageId will contain the *Original-Message-ID* found in the MDN Receipt. This property is not available at design time. # [AS3Sender](#as3sender-class).OriginalContentMIC Property The Message Integrity Check(s) (one-way hash) of the outgoing message. ## Syntax ```text getOriginalContentMIC(): string; setOriginalContentMIC(originalContentMIC: string): void; ``` ## Default Value "" ## Remarks A MIC will be calculated over the outgoing message using the same algorithm in the [SignatureAlgorithm](#as3sendersignaturealgorithm-property) configuration used to sign the message. The property will be set when Post (in AS3, [Send](#as3sendersend-method)) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs. The format is in RFC 3335, i.e. ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` , with a newline at the end. If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use AsyncMDNInfoDir). # [AS3Sender](#as3sender-class).Passive Property This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall. ## Syntax ```text isPassive(): boolean; setPassive(passive: boolean): void; ``` ## Default Value TRUE ## Remarks This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to *TRUE*, the class will use the *PASV* command instead of the *PORT* command and thus will direct the server into a passive mode: connections are initiated only by the client. # [AS3Sender](#as3sender-class).Password Property This is the password used to log in. ## Syntax ```text getPassword(): string; setPassword(password: string): void; ``` ## Default Value "" ## Remarks This property contains the password used to log in. It must be set before the class connects to the FTP server. # [AS3Sender](#as3sender-class).ReceiptSignerCert Property The public key certificate for the MDN receipt signature. ## Syntax ```text getReceiptSignerCert(): Certificate; setReceiptSignerCert(receiptSignerCert: Certificate): void; ``` ## Default Value ## Remarks Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in RecipientCert is used for both encryption and verifying the receipt signature. If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking Post. After invoking Post or [VerifyReceipt](#as3senderverifyreceipt-method), this will contain the certificate used to sign the receipt, if the receipt is signed. If set, this property should be a public key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).RecipientCerts Property The public key certificates of the recipients for this message. ## Syntax ```text getRecipientCerts(): CertificateList; ``` ## Default Value ## Remarks The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by [EncryptionAlgorithm](#as3senderencryptionalgorithm-property). This property will also be used to verify signed receipts if [ReceiptSignerCert](#as3senderreceiptsignercert-property) is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and [ReceiptSignerCert](#as3senderreceiptsignercert-property) to the signing certificate. If the class is unable to verify a signature make sure RecipientCerts are set appropriately. If set, this property should could contain public key instances of [Certificate](#certificate-type). This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).RemoteHost Property This is the domain name or IP address of the FTP server. ## Syntax ```text getRemoteHost(): string; setRemoteHost(remoteHost: string): void; ``` ## Default Value "" ## Remarks This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress. If this property is set to a domain name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned. If the class is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. # [AS3Sender](#as3sender-class).RemotePort Property This is the port for the FTP service (default is 21). ## Syntax ```text getRemotePort(): number; setRemotePort(remotePort: number): void; ``` ## Default Value 21 ## Remarks This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. For an implicit Secure Sockets Layer (SSL), use port 990 (please see the [SSLStartMode](#as3sendersslstartmode-property) property for more information). This property is not available at design time. # [AS3Sender](#as3sender-class).SignatureAlgorithm Property Signature algorithm to be used in outgoing messages. ## Syntax ```text getSignatureAlgorithm(): string; setSignatureAlgorithm(signatureAlgorithm: string): void; ``` ## Default Value "sha-256" ## Remarks *Signature Algorithm* can be set to indicate the preferred signing algorithm. Possible values are: - sha1 - md5 - sha-256 (or sha256) (default) - sha-384 (or sha384) - sha-512 (or sha512) - sha-224 (or sha224) The default value is "sha-256". When this property is set the [MDNOptions](#as3sendermdnoptions-property) property is automatically updated to request the MDN receipt be signed with the same algorithm. When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed for generated messages. "sha-256", "sha-384", or "sha-512" are recommended instead. # [AS3Sender](#as3sender-class).SigningCert Property Contains the certificate to use when signing messages. ## Syntax ```text getSigningCert(): Certificate; setSigningCert(signingCert: Certificate): void; ``` ## Default Value ## Remarks This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by [SignatureAlgorithm](#as3sendersignaturealgorithm-property). If set, this property should be a private key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).SSLAcceptServerCert Property Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text getSSLAcceptServerCert(): Certificate; setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void; ``` ## Default Value ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).SSLCert Property The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text getSSLCert(): Certificate; setSSLCert(SSLCert: Certificate): void; ``` ## Default Value ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).SSLProvider Property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text getSSLProvider(): AS3SenderSSLProviders; setSSLProvider(SSLProvider: AS3SenderSSLProviders): void; enum AS3SenderSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal } ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation will be used by default in all cases in the JavaScript edition. NOTE: The internal provider is not support at this time. # [AS3Sender](#as3sender-class).SSLServerCert Property The server certificate for the last established connection. ## Syntax ```text getSSLServerCert(): Certificate; ``` ## Default Value ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AS3Sender](#as3sender-class).SSLStartMode Property Determines how the class starts the SSL negotiation. By default, SSL will not be used. ## Syntax ```text getSSLStartMode(): AS3SenderSSLStartModes; setSSLStartMode(SSLStartMode: AS3SenderSSLStartModes): void; enum AS3SenderSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone } ``` ## Default Value 3 ## Remarks The SSLStartMode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic - default) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone) | No SSL negotiation, no SSL security. All communication will be in plaintext mode. | # [AS3Sender](#as3sender-class).Subject Property The subject of the message. ## Syntax ```text getSubject(): string; setSubject(subject: string): void; ``` ## Default Value "" ## Remarks The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer. # [AS3Sender](#as3sender-class).Timeout Property The timeout for the class. ## Syntax ```text getTimeout(): number; setTimeout(timeout: number): void; ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class . NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # [AS3Sender](#as3sender-class).User Property This property contains the user identifier to use to log in. ## Syntax ```text getUser(): string; setUser(user: string): void; ``` ## Default Value "" ## Remarks This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server. # [AS3Sender](#as3sender-class).abort Method The method aborts the current upload or download. ## Syntax ```text async as3sender.abort(): Promise< void> ``` ## Remarks This method sends an *ABOR* command to the FTP server. It is used to interrupt file uploads and downloads. # [AS3Sender](#as3sender-class).changeRemotePath Method This method changes the current path on the FTP server. ## Syntax ```text async as3sender.changeRemotePath(remotePath : string): Promise< void> ``` ## Remarks This method changes the current path on the FTP server to the specified *RemotePath*. When called, the class will issue a command to the server to change the directory. The *RemotePath* parameter may hold an absolute or relative path. **Absolute Paths** If the path begins with a */*, it is considered an absolute path and must specify the entire path from the root of the server. For instance: ```csharp component.ChangeRemotePath("/home/testuser/myfolder"); ``` **Relative Paths** If the path does not begin with a */*, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of *myfolder* will indicate a subfolder of the current directory. The special value *..* refers to the parent directory of the current path. For instance: ```csharp //Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder"); ``` # [AS3Sender](#as3sender-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text async as3sender.config(configurationString : string): Promise< string> ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksedias3sender) for the class. These 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. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-class-ipworksedias3sender), you must call *Config("PROPERTY")*. The value will be returned as a string. # [AS3Sender](#as3sender-class).deleteFile Method This method removes a file specified by FileName from an FTP server. ## Syntax ```text async as3sender.deleteFile(fileName : string): Promise< void> ``` ## Remarks This method is used to remove a file specified by *FileName* from an FTP server. The remote file or directory specified by *FileName* is deleted. *FileName* is either an absolute path on the server, or a path relative to remote path set by [ChangeRemotePath](#as3senderchangeremotepath-method). If no FTP session is in place, one is automatically created by first calling the [Logon](#as3senderlogon-method) method. # [AS3Sender](#as3sender-class).getFileSize Method Gets the size of a file on the FTP server. ## Syntax ```text async as3sender.getFileSize(fileName : string): Promise< void> ``` ## Remarks Gets the size of the file specified by *FileName* and RemotePath on the FTP server. # [AS3Sender](#as3sender-class).getFileTime Method Gets the last modification time of a file on the FTP server. ## Syntax ```text async as3sender.getFileTime(fileName : string): Promise< void> ``` ## Remarks Gets the last modification time of the file specified by *FileName* and RemotePath on the FTP server. # [AS3Sender](#as3sender-class).listDirectory Method List the current directory on an FTP server. ## Syntax ```text async as3sender.listDirectory(filesToList : string): Promise< void> ``` ## Remarks A listing is requested for the directory or file mask specified in *FilesToList*. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the [DirList](#as3senderdirlist-event) event. Similar to [ListDirectoryLong](#as3senderlistdirectorylong-method), except only file names are returned. If no FTP session is in place, one is automatically created by first calling the [Logon](#as3senderlogon-method) method. # [AS3Sender](#as3sender-class).listDirectoryLong Method List the current directory on an FTP server. ## Syntax ```text async as3sender.listDirectoryLong(filesToList : string): Promise< void> ``` ## Remarks A listing is requested for the directory or file mask specified in *FilesToList*. This can be an absolute path on the server, a path relative to RemotePath, or a file mask. The file listing is received through the [DirList](#as3senderdirlist-event) event. Extended file information is returned. If no FTP session is in place, one is automatically created by first calling the [Logon](#as3senderlogon-method) method. # [AS3Sender](#as3sender-class).logoff Method This method is used to log off from the FTP server by posting a QUIT command. ## Syntax ```text async as3sender.logoff(): Promise< void> ``` ## Remarks This method is used to log off from the FTP server by posting a *QUIT* command. If that fails, the connection is terminated by the local host. # [AS3Sender](#as3sender-class).logon Method Logon to the FTP RemoteHost using the current User and Password . ## Syntax ```text async as3sender.logon(): Promise< void> ``` ## Remarks Logon to the FTP server using the current [User](#as3senderuser-property) and [Password](#as3senderpassword-property). If an SSL (TLS) connection is required, you should first set [SSLStartMode](#as3sendersslstartmode-property). **Example (Logging On)** ```text FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon() ``` # [AS3Sender](#as3sender-class).queryRemotePath Method This queries the server for the current path. ## Syntax ```text async as3sender.queryRemotePath(): Promise< string> ``` ## Remarks This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance: ```csharp string remotePath = component.QueryRemotePath(); ``` # [AS3Sender](#as3sender-class).readReceipt Method Reads and parses (but does not verify) an MDN receipt. ## Syntax ```text async as3sender.readReceipt(fileName : string): Promise< void> ``` ## Remarks ReadReceipt will retrieve the file specified by *FileName* from the FTP server, and attempt to parse it as an MDN receipt. If the file is a valid MDN receipt, the class will determine the originator of the receipt and the [MessageId](#as3sendermessageid-property) of the original message. The originator of the receipt will be stored in [AS3To](#as3senderas3to-property), the intended recipient (presumably your system) will be stored in [AS3From](#as3senderas3from-property), and the original message Id will be stored in [MessageId](#as3sendermessageid-property). Pass in an empty string to skip the FTP transfer, and process the receipt specified by the [MDNReceipt](#as3sendermdnreceipt-property) property instead. You should then look up the original message and set [OriginalContentMIC](#as3senderoriginalcontentmic-property) to the value of [OriginalContentMIC](#as3senderoriginalcontentmic-property) originally computed when the message was sent (you will need to save this information externally). You should also set RecipientCert based on the value of [AS3To](#as3senderas3to-property) if necessary. Also, set [MDNOptions](#as3sendermdnoptions-property) to the value used when making the original request. Finally, [VerifyReceipt](#as3senderverifyreceipt-method) should be used to verify the receipt. # [AS3Sender](#as3sender-class).reset Method Resets the state of the control. ## Syntax ```text async as3sender.reset(): Promise< void> ``` ## Remarks **Reset** resets the state of the class. All properties will be set to their default values. # [AS3Sender](#as3sender-class).send Method Prepares and sends the AS3 message. ## Syntax ```text async as3sender.send(fileName : string): Promise< void> ``` ## Remarks Invoking Send will prepare and send the AS3 message. It will be signed if [SigningCert](#as3sendersigningcert-property) is set, encrypted if RecipientCert is set, and compressed if [CompressionFormat](#as3sendercompressionformat-property) is set. A receipt will be requested if [MDNTo](#as3sendermdnto-property) is set. Prior to sending, you may [Logon](#as3senderlogon-method) to the FTP server and navigate to the desired RemotePath. If you have not created an FTP connection already then Send will attempt to establish one. *FileName* should contain the name of the file that will be written on the AS3/FTP server. You may leave *FileName* blank to allow the class to determine an appropriate name. # [AS3Sender](#as3sender-class).sendFTPCommand Method Sends the exact command directly to the server. ## Syntax ```text async as3sender.sendFTPCommand(command : string): Promise< void> ``` ## Remarks This method sends the command specified by *Command* to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server. After calling this method check the [FTPLastReply](#as3senderftplastreply-property) property and/or monitor the [PITrail](#as3senderpitrail-event) event to obtain the server's response. # [AS3Sender](#as3sender-class).verifyReceipt Method Verifies an MDN receipt. ## Syntax ```text async as3sender.verifyReceipt(): Promise< void> ``` ## Remarks **VerifyReceipt** verifies the receipt in [MDNReceipt](#as3sendermdnreceipt-property) against the values of [OriginalContentMIC](#as3senderoriginalcontentmic-property) and [MessageId](#as3sendermessageid-property) and the preferences specified in [MDNOptions](#as3sendermdnoptions-property). The method operates similarly to Post: After the method finishes, the [MDNReceipt](#as3sendermdnreceipt-property), [ReceiptSigningProtocol](#ReceiptSigningProtocol), and [ReceiptSignerCert](#as3senderreceiptsignercert-property) properties will be populated with the appropriate values. The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN. If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal. You should first invoke [ReadReceipt](#as3senderreadreceipt-method) when it is not known which message the receipt is in response to. This will allow you to determine the original [MessageId](#as3sendermessageid-property) and originator of the receipt before trying to verify it. # [AS3Sender](#as3sender-class).ConnectionStatus Event Fired to indicate changes in the connection state. ## Syntax ```text as3sender.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void ) ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # [AS3Sender](#as3sender-class).DirList Event This event is fired when a directory entry is received. ## Syntax ```text as3sender.on('DirList', listener: (e: {readonly dirEntry: string, readonly fileName: string, readonly isDir: boolean, readonly fileSize: number, readonly fileTime: string}) => void ) ``` ## Remarks The DirList events are fired when a directory listing is received as a response to a [ListDirectory](#as3senderlistdirectory-method) or [ListDirectoryLong](#as3senderlistdirectorylong-method) call. The [StartTransfer](#as3senderstarttransfer-event) and [EndTransfer](#as3senderendtransfer-event) events mark the beginning and end of the event stream. The *DirEntry* parameter contains the filename when [ListDirectory](#as3senderlistdirectory-method) is called and includes extended file information when [ListDirectoryLong](#as3senderlistdirectorylong-method) is called. The class tries to fill out the *FileName*, *IsDir*, *FileSize*, and *FileTime* parameters when calling the [ListDirectoryLong](#as3senderlistdirectorylong-method) method. Except for *FileName*, these parameters are empty when a short "List Directory" is performed. In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given. # [AS3Sender](#as3sender-class).EndTransfer Event This event is fired when a file finishes downloading or uploading. ## Syntax ```text as3sender.on('EndTransfer', listener: (e: {readonly direction: number}) => void ) ``` ## Remarks The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # [AS3Sender](#as3sender-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text as3sender.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void ) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworksedias3sender) section. # [AS3Sender](#as3sender-class).Log Event Fired with log information while processing a message. ## Syntax ```text as3sender.on('Log', listener: (e: {readonly logType: string, readonly logMessage: string, readonly logMessageB: Uint8Array}) => void ) ``` ## Remarks This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. Log messages available through this event correspond to log files written to [LogDirectory](#as3senderlogdirectory-property). This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of [LogDirectory](#as3senderlogdirectory-property) (i.e. when [LogDirectory](#as3senderlogdirectory-property) is empty the event will still fire). The *LogMessage* event parameter holds the raw log data. The *LogType* event parameter indicates the type of log. Possible values are: | | | | --- | --- | | "LOG" | Information about the status of the process. | | "ERR" | An error was encountered. | | "DAT" | The EDI payload. | | "REQ" | The raw request | | "MDN" | The MDN response. | | "DEBUG" | Debug information. | | "DAT.INPUT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.ENCRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.COMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.SIGN" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DECRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.VERIFY" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | | "DAT.DEBUG" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. | # [AS3Sender](#as3sender-class).PITrail Event This event traces the commands sent to the server, and the respective replies. ## Syntax ```text as3sender.on('PITrail', listener: (e: {readonly direction: number, readonly message: string}) => void ) ``` ## Remarks The PITrail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line. The *Message* parameter contains the full text of the message. The *Direction* parameter shows the originator of the message: | | | | --- | --- | | 0 (Client) | The Message originates from the client. | | 1 (Server) | The Message originates from the server. | | 2 (Info) | The Message is an informative message originating from the client software (the class code). | # [AS3Sender](#as3sender-class).SSLServerAuthentication Event Fired after the server presents its certificate to the client. ## Syntax ```text as3sender.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void ) ``` ## Remarks This event fires with information about the server certificate. The *Status* property shows why verification failed (otherwise, *Status* contains the string *OK*). To manually accept an untrusted certificate, the [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) setting must be set to True before initiating the connection. # [AS3Sender](#as3sender-class).SSLStatus Event Fired when secure connection progress messages are available. ## Syntax ```text as3sender.on('SSLStatus', listener: (e: {readonly message: string}) => void ) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # [AS3Sender](#as3sender-class).StartTransfer Event This event fires when a file starts downloading or uploading. ## Syntax ```text as3sender.on('StartTransfer', listener: (e: {readonly direction: number}) => void ) ``` ## Remarks The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # [AS3Sender](#as3sender-class).Transfer Event This event is fired during the file download or upload. ## Syntax ```text as3sender.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void ) ``` ## Remarks One or more Transfer events are fired during file transfer. The *BytesTransferred* parameter shows the number of bytes transferred since the beginning of the transfer. *Text* contains the portion of the file data being delivered. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *string (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *string (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *string (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *string (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *string (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *string* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys. NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling . **PrivateKey** *string (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *number (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *string (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *string* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *Uint8Array* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *string* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *string (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *string (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *string (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *number (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **EncodedB** *Uint8Array* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # EDIAttachment Type This describes the file being attached. ## Remarks Information about the file's location that is being attached to the message is contained here. The following fields are available: - [ContentType](#EDIAttachment_f_ContentType) - [Data](#EDIAttachment_f_Data) - [FileName](#EDIAttachment_f_FileName) - [Headers](#EDIAttachment_f_Headers) - [InputStream](#EDIAttachment_f_InputStream) - [Name](#EDIAttachment_f_Name) - [OutputStream](#EDIAttachment_f_OutputStream) ## Fields **ContentType** *string* *Default Value: ""* The MIME content-type of this [EDIAttachment](#ediattachment-type). **Data** *string* *Default Value: ""* This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. **DataB** *Uint8Array* *Default Value: ""* This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. **FileName** *string* *Default Value: ""* The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the . **Headers** *string* *Default Value: ""* The class fills out each time any of the other properties for that [EDIAttachment](#ediattachment-type) are changed. If additional headers are needed they should be appended after all the other properties for that [EDIAttachment](#ediattachment-type) are set. **InputStream** *ReadableStream* *Default Value: ""* If is specified, the data from the stream specified will be used for the EDI attachment. **Name** *string* *Default Value: ""* is the final name to be associated with the contents of either the or properties. This corresponds to the *filename* attribute of the *Content-Disposition* header for this attachment. **OutputStream** *WriteableStream (read-only)* *Default Value: ""* The class decodes the attachment of Message when This property's value is first set, and writes the decoded attachment to the stream. NOTE: It is recommended to use the SetAttachmentOutputStream method instead of setting this property. ## Constructors ```text public EDIAttachment(); ``` ```text public EDIAttachment(String fileName); ``` ```text public EDIAttachment(String fileName, String contentType); ``` ```text public EDIAttachment(String fileName, String contentType, String headers); ``` # EDIData Type The EDI payload of the AS2 message. ## Remarks The EDI payload of the AS2 message. The following fields are available: - [Data](#EDIData_f_Data) - [EDIType](#EDIData_f_EDIType) - [InputStream](#EDIData_f_InputStream) - [Name](#EDIData_f_Name) - [OutputStream](#EDIData_f_OutputStream) - [FileName](#EDIData_f_FileName) ## Fields **Data** *string* *Default Value: ""* This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **DataB** *Uint8Array* *Default Value: ""* This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **EDIType** *string* *Default Value: ""* The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml". **InputStream** *ReadableStream* *Default Value: ""* In a sender, if is specified, the data from the specified stream will be used for the EDI payload of the transmission. **Name** *string* *Default Value: "rfc1767.edi"* is the final name to be associated with the contents of either the or properties. This corresponds to the *filename* attribute of the *Content-Disposition* header for the EDI payload. When constructing EDI data to be sent, will be set to the same value as , but can be overridden after setting to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. **OutputStream** *WriteableStream* *Default Value: ""* In a receiver, if this property is set, the EDI payload will be written to this stream if ParseRequest finishes without an error, setting ScanResult to 0. If so, the specified stream will contain the full decrypted text of the EDI message. NOTE: When is used and the underlying data contains attachments, the attachments will not be decoded to the output stream. Attachments are accessible via the Attachments collection. **FileName** *string* *Default Value: ""* In a sender, if is specified, the file specified will be used for the EDI payload of the transmission. will be populated with the name of the file. In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents. Note: When is set, the data will be written to the stream and this property will not be populated. ## Constructors ```text public EDIData(); ``` ```text public EDIData(byte[] data, String EDIType); ``` ```text public EDIData(String fileName, String EDIType); ``` # Firewall Type The firewall the class will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the . The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *FirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. | **Host** *string* *Default Value: ""* The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class . **Password** *string* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . **Port** *number* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details. NOTE: This property is set automatically when is set to a valid value. See the description of the property for details. **User** *string* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class . ## Constructors ```text public Firewall(); ``` # MDNReceipt Type The complete MDN Receipt returned by the receiver. ## Remarks The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature. The following fields are available: - [Content](#MDNReceipt_f_Content) - [HeaderCount](#MDNReceipt_f_HeaderCount) - [HeaderField](#MDNReceipt_f_HeaderField) - [HeaderIndex](#MDNReceipt_f_HeaderIndex) - [Headers](#MDNReceipt_f_Headers) - [HeaderValue](#MDNReceipt_f_HeaderValue) - [MDN](#MDNReceipt_f_MDN) - [Message](#MDNReceipt_f_Message) - [MICValue](#MDNReceipt_f_MICValue) - [SigningProtocol](#MDNReceipt_f_SigningProtocol) ## Fields **Content** *string* *Default Value: ""* This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **ContentB** *Uint8Array* *Default Value: ""* This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **HeaderCount** *number (read-only)* *Default Value: 0* The number of headers in the MDN. **HeaderField** *string (read-only)* *Default Value: ""* The field name of the MDN header currently selected by . **HeaderIndex** *number* *Default Value: 0* Which MDN header is currently selected to populate and . Valid values are 0 to - 1. **Headers** *string* *Default Value: ""* **Headers** contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as *AS2-From*, *AS2-To*, *Date*, *Content-Type*, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option). You can also use , , , and to easily iterate through each individual header. **HeaderValue** *string (read-only)* *Default Value: ""* The value of the MDN header currently selected by . **MDN** *string (read-only)* *Default Value: ""* **MDN** will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant. **Message** *string (read-only)* *Default Value: ""* The human-readable portion of the MDN receipt. The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered. **MICValue** *string (read-only)* *Default Value: ""* The Message Integrity Check(s) (one-way hash) of the original EDI message. An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed. The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` . **SigningProtocol** *string (read-only)* *Default Value: ""* This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this [MDNReceipt](#mdnreceipt-type). It will contain an empty string if the receipt is unsigned. ## Constructors ```text public MDNReceipt(); ``` ```text public MDNReceipt(String headers, byte[] content); ``` # Config Settings (*class *ipworksedi.[as3sender](#as3sender-class)) 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](#as3senderconfig-method) method. ### AS3Sender Config Settings **CalculateProcessingPercentDone**: Whether to show the progress of file processing.When set to True the class will display the progress of file processing (encrypting and signing) through the [StartTransfer](#as3senderstarttransfer-event), [Transfer](#as3sendertransfer-event), and [EndTransfer](#as3senderendtransfer-event) events. The default value is False. **LogFilename**: The base name of the log file.If set, this will be used as for the filename of the log file. Note that only the base name should be specified as the component will append the appropriate file extension. **LogonAfterProcessing**: Whether to prepare the file before connecting to the FTP server.This setting controls whether the class connects to the FTP server before or after processing the file to be sent. When set to True the class will perform any signing and encrypting operations to prepare the file before connecting to the FTP server. When set to False the class will connect and then prepare the file immediately before upload. The default value is False. ### FTP Config Settings **ActiveModeIP**: Allows the specification of the IP address that the server will connect to for active mode connections.The [ActiveModeIP](#ActiveModeIP) configuration setting can be used to specify the IP address that the server will connect to when using an active mode configuration ([Passive](#as3senderpassive-property) = False). When this configuration setting is set, the port number where the component listens for active mode connections will still be managed by the component. The [PortRange](#PortRange) also can be used to ensure that the correct port is used by the client. NOTE: This configuration setting will be ignored if [ActiveModePORTAddress](#ActiveModePORTAddress) is also specified. **ActiveModePORTAddress**: Allows the specification of the PORT address value for active mode connections.When using an active mode configuration ([Passive](#as3senderpassive-property) = False) with a firewall, it may be necessary to specify the actual PORT value to be sent to the server. [ActiveModePORTAddress](#ActiveModePORTAddress) takes the protocol-level parameter in the form "a,b,c,d,e,f" where "a,b,c,d" is the external IP address separated by commas, and e and f represent, respectively, the high-byte (divide by 256) and the low-byte (mod 256) values of the external port where the FTP client is listening. This configuration setting must be used in conjunction with [PortRange](#PortRange) to ensure that the correct port is used by the client. **AppendToLocalFile**: Append downloaded files to a local file.If set to True, the downloaded files will be appended to the file specified in LocalFile. **ApplyFileMaskLocally**: Whether to filter the directory listing locally or on the server.If set to *true* any filemask provided to RemoteFile will be applied locally, after the server has returned the results. When set to *false* (default), the value in RemoteFile will be sent to the server as part of the relevant listing command. Because using filemasks with list commands is not standardized, some servers do not support them and will return an error. **AutoSelectDataIP**: Automatically select the data connection IP.This setting controls the selection logic of the data connection. By default, this value is True and the class will attempt to determine the best IP for the data connection based on the returned value from the server. It is recommended to leave this value set to True unless there is a reason to disable it. In many cases, FTP servers are not configured to return a valid public IP in the PASV response. When Secure Sockets Layer/Transport Layer Security (SSL/TLS) is used any network address translation (NAT) done by the firewall cannot occur. The result is the client may receive an IP that is not accessible. This setting is designed to allow the connection to succeed in as many cases as possible. When the IP for the data connection is received from the server, the class will inspect the value. If the received value is not within the known private IP ranges, the class will use it, assuming it is a valid public IP. If the received value is a private IP, the class will instead assume the data connection should be established to the same IP as the command connection (true in almost all cases). When this setting is False, the class will not perform any checks on the received value. When set to False, [UseRemoteHostAddressForPassive](#UseRemoteHostAddressForPassive) is applicable. **CalculatePercentDone**: Enables or Disables calculating the percent complete for downloads.When set to *true* (default), the class sends an FTP *SIZE* command to retrieve the file size before beginning a download. When downloading a large quantity of small files, performance may be increased by disabling this feature. **CheckTotalEntry**: Whether to ignore directory listing total lines.Some servers will include "total" information when returning a directory listing that contains non-entry data. When CheckTotalEntry is set to True (default), the component will ignore lines beginning with "total" to account for this. In some cases, it may be desirable to include these lines in the resulting DirList data; this can be done by setting this configuration setting to False. **DILinger**: When set to True, DI connections are terminated gracefully. This property controls how the DI connection is closed. The default is True. In the case that DILinger is True (default), follow two scenarios to determine how long the connection will linger. In the first scenario, if [DILingerTime](#DILingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, [DILingerTime](#DILingerTime) is a positive value, the system will attempt to send pending data until the specified [DILingerTime](#DILingerTime) 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 are 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. **DILingerTime**: Time in seconds to have the DI connection linger. LingerTime is the time, in seconds, to let the socket connection linger. This value is 0 by default, which means it will use the default IP timeout. **FileTimeFormat**: The format of file time reported by the server.The default value is "M/d/yyyy hh:mm:ss tt". When set, the class will format the time returned by the server when calling the QueryFileTime method. To disable all formatting, set this to empty string. This setting applies only when calling QueryFileTime. It does not apply to the *FileTime* parameter of the [DirList](#as3senderdirlist-event) event. **IgnoreEntries**: Directory entry data to ignore.Sometimes the FTP server will return data in a directory listing that is not entry data and can be ignored. The IgnoreEntries configuration setting takes a comma-separated list of entries to ignore. Only the beginning of the entries need to be specified and correct case is not required. **MaskSensitiveData**: Masks passwords in logs.The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs. **ModeZCompressionLevel**: Used to specify the level of compression used.The default value is 7. Valid values range from 0 to 9. A higher value indicates that a higher compression level is being used. This is valid only when [UseModeZ](#UseModeZ) is set to True. NOTE: When this setting is specified, the class immediately performs an action. Use the *ConfigAsync* method to avoid blocking execution. **PortRange**: Allows the specification of a port range where the class listens for active mode connections.When set to use active mode ([Passive](#as3senderpassive-property) = False), the class uses any available port to listen to incoming connections from the server. You can override this behavior by setting [PortRange](#PortRange) to a value containing the range of ports the class will be listening to. The range is provided as *start-end*, for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 4010 or between 50000 and 50010. **PreserveFileTime**: Attempts to preserve timestamps when transferring files.When set to True, the class will try to preserve timestamps when transferring files. The *MDTM* command is used when downloading, and the *MFTM* command is used when uploading. The server must support these commands for this to work and is False by default. **RealTimeUpload**: Enables real time uploading.When this value is set to True, the class will upload the data in the file specified by LocalFile and continue monitoring LocalFile for additional data to upload until no new data is found for [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is False. **RealTimeUploadAgeLimit**: The age limit in seconds when using RealTimeUpload.This value is only applicable when [RealTimeUpload](#RealTimeUpload) is set to "True". This specifies the number of seconds for which the class will monitor LocalFile for new data to upload. If this limit is reached and no new data are found in LocalFile the upload will complete. The default value is "1". **ReusePISSLSessionInDI**: Whether the PI SSL session will be reused for the DI connection.When set to True (default), the class will reuse the PI SSL session when creating the DI connection. When set to False, the class will create a separate SSL session for the DI connection. The default value is True. **ReuseSSLSessionInDI**: Whether the SSL session will be reused for the DI connection.When set to True (default), the class will ask the server to reuse the existing DI Secure Sockets Layer (SSL) session. When set to False, a new SSL session will always be created for the DI connection. **UseClearChannel**: Allows for the Clear Command Channel (CCC) command.When this is set, the class will send the *CCC* command to the server requesting a clear (unprotected) command channel. **UseClearDataChannel**: Allows for the PROT C command.When this is set, the class will use a clear (unprotected) data channel by sending the *PROT C* command to the server. **UseEPSV**: Allows extended passive mode.When this is set, the extended passive mode will be used. **UseMLSD**: Uses listings for machine processing.When this is set to True, the class will list files in the directory using the *MLSD* command. This command is an extension to the protocol that defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False. When set to True, set RemoteFile to the filemask and call either [ListDirectory](#as3senderlistdirectory-method) or [ListDirectoryLong](#as3senderlistdirectorylong-method). There is no difference between the two methods when this setting is enabled. **UseMLST**: Uses single file listing for machine processing.This setting is similar to [UseMLSD](#UseMLSD) except that it is valid only for a single file. When this is set to True, the class will list the file or folder specified by RemoteFile. If RemoteFile is not set, a listing for the current directory will be returned. This command is an extension to the protocol, which defines a more standardized and reliable directory listing format, but does so only for a single file or folder. Not all servers support this command. The default value is False. When set to True, set RemoteFile to the file or folder you wish to get information about and call either [ListDirectory](#as3senderlistdirectory-method) or [ListDirectoryLong](#as3senderlistdirectorylong-method). There is no difference between the two methods when this setting is enabled. When both [UseMLSD](#UseMLSD) and [UseMLST](#UseMLST) are set, [UseMLSD](#UseMLSD) takes precedence. **UseModeZ**: Allows compression to be used when transferring data.The default value is False. When set to True, the class will issue the *MODE Z* command to the FTP server. This will enable deflate compression so that all data transferred are first compressed either by the server (when downloading) or by the class (when uploading). NOTE: Not all servers support this feature. NOTE: When this setting is specified, the class immediately performs an action. Use the *ConfigAsync* method to avoid blocking execution. **UseOldAUTHSSL**: Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'.By default, the class uses the standard *AUTH TLS* command to initiate the SSL handshake with the server. This configuration setting is included for optional support of older servers that support only the *AUTH SSL* command. NOTE: Using *AUTH SSL* instead of *AUTH TLS* is strongly discouraged because of potential security vulnerabilities. If you must use this configuration setting, please do so very carefully. **UseProtWhenImplicit**: Sends the PROT P command to the server.When [SSLStartMode](#as3sendersslstartmode-property) is set to *sslImplicit*, setting this to True will instruct the class to send the *PROT P* command to the server. This explicitly tells the server that the data channel will be protected. The default value is True. **UseRemoteHostAddressForPassive**: Instructs the class to use the address specified by RemoteHost when establishing a data connection.When this setting is True, the class will use the address specified by [RemoteHost](#as3senderremotehost-property) when establishing a data connection for directory listings and file transfers. This setting is applicable only when [AutoSelectDataIP](#AutoSelectDataIP) is set to False. When this setting is False (default) and [AutoSelectDataIP](#AutoSelectDataIP) is also False, the class will use the IP address returned by the server when establishing a data connection. This setting is not applicable when [Passive](#as3senderpassive-property) is set to False (Active mode). **VirtualHostName**: Sends the HOST command to the server.Defined in RFC 7151, the *HOST* command allows user-FTP processes to specify which virtual host to connect to for a server-FTP process that is handling requests for multiple virtual hosts on a single IP address. When this configuration setting is set, the *HOST* command is sent to the server before authenticating. ### TCPClient Config 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](#as3sendertimeout-property) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and [RemoteHost](#as3senderremotehost-property) resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#as3senderconnected-property) operation as a whole. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **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](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration 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 macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (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. **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), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 are 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 (e.g., by a client acknowledgment), 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, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#as3senderlocalhost-property) 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 multihomed 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 classes) only through that interface. If the class is connected, the [LocalHost](#as3senderlocalhost-property) 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 multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting 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 configuration setting is useful when trying to connect to services that require a trusted port on 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](#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](#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](#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](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **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 as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#as3sendersslprovider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#as3sendersslstatus-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#as3sendersslprovider-property) is set to *Platform*. **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). OpenSSL recommends the use of 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 the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class 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 class is the same. **SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#as3sendersslprovider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#as3sendersslcert-property) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is 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. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#as3sendersslstatus-event) event. Use this configuration 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the 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 class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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 [SSLProvider](#as3sendersslprovider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#as3sendersslprovider-property) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#as3sendersslprovider-property) is set to *Internal*include the following: ```text 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_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#as3sendersslprovider-property) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#as3sendersslprovider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#as3sendersslprovider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#as3sendersslprovider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#as3sendersslserverauthentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#as3sendersslserverauthentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#as3sendersslserverauthentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#as3sendersslprovider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#as3sendersslprovider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#as3sendersslprovider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#as3sendertimeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. 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. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. 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 Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *ipworksedi.[as3sender](#as3sender-class)) ### AS3Sender Errors | | | | --- | --- | | 901 | You must specify ReceiptContent or a filename. | | 903 | You must specify the remote filename. | | 501 | Unable to verify receipt signature. | | 502 | Incorrect Received-Content-MIC in receipt. | | 504 | Bad or unsupported receipt format. Error description contains detailed message. | | 601 | Unsupported signature algorithm. | | 602 | Warning: Error description contains detailed message. | ### FTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains detailed information. | | 141 | FTP error. The error message contains the server reply. | | 142 | Communication error. The error message contains the description. | | 143 | Busy executing current method. | | 144 | Local file error. The error description contains detailed information. | | 145 | Can't open LocalFile for reading. | | 146 | No RemoteFile specified while uploading. | | 147 | Data interface error. The error description contains detailed information. | | 148 | LocalFile already exists and overwrite is False. | | 149 | Windows message queue dropped a message (typically due to heavy load). | | 301 | Operation is interrupted. | | 302 | Can't open local file. | | 311 | Accept failed for data connection. | | 312 | Asynchronous select failed for data connection. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the [RemotePort](#as3senderremoteport-property) at this time. A connection is in progress. | | 101 | You cannot change the [RemoteHost](#as3senderremotehost-property) (Server) at this time. A connection is in progress. | | 102 | The [RemoteHost](#as3senderremotehost-property) address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#as3senderlocalhost-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | [RemotePort](#as3senderremoteport-property) cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### SMIME Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. |