# AS3Receiver Class

The AS3Receiver class is used to process AS3 messages and generate receipts.

## Syntax

```text
ipworksedi.AS3Receiver
```

## Remarks

The AS3Receiver class allows you to receive AS3 messages over FTP, as specified in [AS3] and RFC 3335. The class can act as a FTP client, decrypt and verify incoming messages, and generate receipts including Message Disposition Notifications (MDNs). The class is designed to interoperate easily with a standard FTP server.

**BASIC OPERATION**

You should first log in to the FTP server by invoking [Logon](#logon-method-as3receiver-class). If you need to search the FTP server for requests you may set RemotePath, invoke [ListDirectory](#listdirectory-method-as3receiver-class), etc. When you find the desired files you may then download them invoking [ReadRequest](#readrequest-method-as3receiver-class). Alternatively, if you acquire the AS3 data by other means you may simply set [Request](#request-property-as3receiver-class).

[ReadRequest](#readrequest-method-as3receiver-class) (or ParseHeaders) will determine information such as [AS3From](#as3from-property-as3receiver-class) and [AS3To](#as3to-property-as3receiver-class), which will allow you to set the appropriate certificates. You may specify your certificate with the [Certificate](#certificate-property-as3receiver-class) property, and your trading partner's (signing) certificate with the [SignerCert](#signercert-property-as3receiver-class) property.

Then, invoke [ProcessRequest](#processrequest-method-as3receiver-class) to process the request and generate the MDN receipt as specified in [AS3]. If the request was processed successfully, [EDIData](#edidata-property-as3receiver-class) will contain the transmitted EDI data. If a problem occurred, [EDIData](#edidata-property-as3receiver-class) will not be populated and an exception will be thrown. In either case [MDNReceipt](#mdnreceipt-property-as3receiver-class) will contain the RFC-compliant receipt, which should be returned to the client.

The [MDNReceipt](#mdnreceipt-property-as3receiver-class) may be returned over the same FTP connection by invoking [SendResponse](#sendresponse-method-as3receiver-class). If it is necessary to create a new connection or send receipts to a different server you may [Logoff](#logoff-method-as3receiver-class) and [Logon](#logon-method-as3receiver-class) at will.

To create log files, set [LogDirectory](#logdirectory-property-as3receiver-class) prior to invoking [ProcessRequest](#processrequest-method-as3receiver-class). This will log all incoming and outgoing data, and will also write the received EDI files to disk.

**EXAMPLE**

```text
AS3Receiver1.User = "myusername"
AS3Receiver1.Password = "mypassword"
AS3Receiver1.RemoteHost = "ftp.mytradingpartner.com"
AS3Receiver1.Logon()
// You may need to search the server for received files at this point
AS3Receiver1.ReadRequest("1053-ji094986.as3")
// At this point, you should check the values of AS2From and AS2To.
AS3Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me");
AS3Receiver1.SignerCert = (...);
AS3Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory";
AS3Receiver1.ProcessRequest();
// It will probably be necessary to change the RemotePath or even logon
// to a different server here.
AS3Receiver1.SendResponse("1053-ji094986-mdn.as3");
```

 Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

## 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](#as3from-property-as3receiver-class) | The identity of the sending system. |
| [AS3To](#as3to-property-as3receiver-class) | The identity of the receiving system. |
| [AS3VersionIncoming](#as3versionincoming-property-as3receiver-class) | The version of AS3 being used. |
| [AS3VersionOutgoing](#as3versionoutgoing-property-as3receiver-class) | The version of AS3 being used. |
| [Attachments](#attachments-property-as3receiver-class) | Collection of files attached to the current message. |
| [Certificate](#certificate-property-as3receiver-class) | The decryption and receipt signing certificate. |
| [CompressionFormat](#compressionformat-property-as3receiver-class) | The compression format used on the incoming message. |
| [Connected](#connected-property-as3receiver-class) | Whether the class is connected. |
| [EDIData](#edidata-property-as3receiver-class) | The EDI data sent in Request . |
| [Firewall](#firewall-property-as3receiver-class) | A set of properties related to firewall access. |
| [FTPLastReply](#ftplastreply-property-as3receiver-class) | The last reply from the FTP server. |
| [LocalHost](#localhost-property-as3receiver-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LogDirectory](#logdirectory-property-as3receiver-class) | The path to a directory for logging. |
| [LogFile](#logfile-property-as3receiver-class) | The log file written. |
| [MDNReceipt](#mdnreceipt-property-as3receiver-class) | The MDN-based receipt generated by the class. |
| [MDNTo](#mdnto-property-as3receiver-class) | The URL for the Message Disposition Notification (MDN). |
| [MessageId](#messageid-property-as3receiver-class) | The message ID of the incoming message. |
| [Passive](#passive-property-as3receiver-class) | This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall. |
| [Password](#password-property-as3receiver-class) | This is the password used to log in. |
| [RemoteHost](#remotehost-property-as3receiver-class) | This is the domain name or IP address of the FTP server. |
| [RemotePort](#remoteport-property-as3receiver-class) | This is the port for the FTP service (default is 21). |
| [Request](#request-property-as3receiver-class) | The AS3 request to process. |
| [RequestHeaders](#requestheaders-property-as3receiver-class) | The headers in the AS3 request. |
| [RequestHeadersString](#requestheadersstring-property-as3receiver-class) | The headers in the AS3 request. |
| [ScanResult](#scanresult-property-as3receiver-class) | The result of invoking ParseRequest . |
| [SignerCert](#signercert-property-as3receiver-class) | Your trading partner's certificate. |
| [SSLAcceptServerCert](#sslacceptservercert-property-as3receiver-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-as3receiver-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#sslprovider-property-as3receiver-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-as3receiver-class) | The server certificate for the last established connection. |
| [SSLStartMode](#sslstartmode-property-as3receiver-class) | Determines how the class starts the SSL negotiation. By default, SSL will not be used. |
| [Timeout](#timeout-property-as3receiver-class) | The timeout for the class. |
| [User](#user-property-as3receiver-class) | 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](#abort-method-as3receiver-class) | The method aborts the current upload or download. |
| [ChangeRemotePath](#changeremotepath-method-as3receiver-class) | This method changes the current path on the FTP server. |
| [Config](#config-method-as3receiver-class) | Sets or retrieves a configuration setting. |
| [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class) | Creates MDNReceipt . |
| [DeleteFile](#deletefile-method-as3receiver-class) | This method removes a file specified by FileName from an FTP server. |
| [GetFileSize](#getfilesize-method-as3receiver-class) | Gets the size of a file on the FTP server. |
| [GetFileTime](#getfiletime-method-as3receiver-class) | Gets the last modification time of a file on the FTP server. |
| [ListDirectory](#listdirectory-method-as3receiver-class) | List the current directory on an FTP server. |
| [ListDirectoryLong](#listdirectorylong-method-as3receiver-class) | List the current directory on an FTP server. |
| [Logoff](#logoff-method-as3receiver-class) | This method is used to log off from the FTP server by posting a QUIT command. |
| [Logon](#logon-method-as3receiver-class) | Logon to the FTP RemoteHost using the current User and Password . |
| [ParseRequest](#parserequest-method-as3receiver-class) | Parses the EDI message and determines the EDIData . |
| [ProcessRequest](#processrequest-method-as3receiver-class) | Processes the EDI data, and generates the receipt. |
| [QueryRemotePath](#queryremotepath-method-as3receiver-class) | This queries the server for the current path. |
| [ReadRequest](#readrequest-method-as3receiver-class) | Reads the AS3 request from the FTP server. |
| [Reset](#reset-method-as3receiver-class) | Resets the state of the control. |
| [SendFTPCommand](#sendftpcommand-method-as3receiver-class) | This method sends the exact FTP command directly to the FTP server. |
| [SendResponse](#sendresponse-method-as3receiver-class) | Uploads the 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](#connectionstatus-event-as3receiver-class) | Fired to indicate changes in the connection state. |
| [DirList](#dirlist-event-as3receiver-class) | This event is fired when a directory entry is received. |
| [EndTransfer](#endtransfer-event-as3receiver-class) | This event is fired when a file finishes downloading or uploading. |
| [Error](#error-event-as3receiver-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-as3receiver-class) | Fired with log information while processing a message. |
| [PITrail](#pitrail-event-as3receiver-class) | This event traces the commands sent to the server, and the respective replies. |
| [SignerCertInfo](#signercertinfo-event-as3receiver-class) | This event is fired during verification of the signed message. |
| [SSLServerAuthentication](#sslserverauthentication-event-as3receiver-class) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-as3receiver-class) | Fired when secure connection progress messages are available. |
| [StartTransfer](#starttransfer-event-as3receiver-class) | This event fires when a file starts downloading or uploading. |
| [Transfer](#transfer-event-as3receiver-class) | 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.*

|  |  |
| --- | --- |
| [LogFilename](#LogFilename) | The base name of the log file. |
| [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. |
| [DirEntryPattern](#DirEntryPattern) | Allows the use of regular expressions to parse non-standard directory entry formats. |
| [FileTimeFormat](#FileTimeFormat) | The format of file time reported by the server. |
| [IgnoreEntries](#IgnoreEntries) | Directory entry data to ignore. |
| [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. |
| [MaxDirEntries](#MaxDirEntries) | Instructs class to save the amount of entries specified that are returned by the server after a ListDirectory call has been made. |
| [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. |
| [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the class will close the upload or download stream after the transfer. |
| [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. |
| [FirewallListener](#FirewallListener) | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
| [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. |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [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. |
| [SSLContextProtocol](#SSLContextProtocol) | The protocol used when getting an SSLContext instance. |
| [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. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [SSLTrustManagerFactoryAlgorithm](#SSLTrustManagerFactoryAlgorithm) | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
| [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. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# AS3From Property ([AS3Receiver](#as3receiver-class) Class)

The identity of the sending system.

## Syntax

```text
public String getAS3From();
```

## Default Value

""

## Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

# AS3To Property ([AS3Receiver](#as3receiver-class) Class)

The identity of the receiving system.

## Syntax

```text
public String getAS3To();
```

## Default Value

""

## Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

# AS3VersionIncoming Property ([AS3Receiver](#as3receiver-class) Class)

The version of AS3 being used.

## Syntax

```text
public String getAS3VersionIncoming();
```

## Default Value

"1.0"

## Remarks

The version of AS3 being used on the incoming transmission. Should be "1.0".

This property is read-only.

# AS3VersionOutgoing Property ([AS3Receiver](#as3receiver-class) Class)

The version of AS3 being used.

## Syntax

```text
public String getAS3VersionOutgoing();
public void setAS3VersionOutgoing(String AS3VersionOutgoing);
```

## Default Value

"1.0"

## Remarks

The version of AS3 being used on the outgoing transmission. Should be "1.0".

# Attachments Property ([AS3Receiver](#as3receiver-class) Class)

Collection of files attached to the current message.

## Syntax

```text
public EDIAttachmentList getAttachments();
```

## Remarks

When a message is received, the class will write all of the files attached to the [EDIData](#edidata-property-as3receiver-class) into temp files. These attachments can be retrieved by walking this collection and retrieving their file names.

This property is read-only and not available at design time.

 Please refer to the [EDIAttachment](#ediattachment-type) type for a complete list of fields.

# Certificate Property ([AS3Receiver](#as3receiver-class) Class)

The decryption and receipt signing certificate.

## Syntax

```text
public Certificate getCertificate();
public void setCertificate(Certificate certificate);
```

## Remarks

The digital certificate that the class will use to decrypt incoming transmissions and sign the MDN receipt (if requested). If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling [ParseRequest](#parserequest-method-as3receiver-class), then set the signing certificate before calling [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class). Certificate must be set to a private key certificate.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# CompressionFormat Property ([AS3Receiver](#as3receiver-class) Class)

The compression format used on the incoming message.

## Syntax

```text
public int getCompressionFormat();

Enumerated values:
  public final static int cfNone = 0;
  public final static int cfZLIB = 1;
```

## Default Value

0

## Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the class.

This property is read-only.

# Connected Property ([AS3Receiver](#as3receiver-class) Class)

Whether the class is connected.

## Syntax

```text
public boolean isConnected();
```

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

# EDIData Property ([AS3Receiver](#as3receiver-class) Class)

The EDI data sent in Request .

## Syntax

```text
public EDIData getEDIData();
```

## Remarks

This property will only be populated if [ParseRequest](#parserequest-method-as3receiver-class) or [ProcessRequest](#processrequest-method-as3receiver-class) finishes without an error, setting [ScanResult](#scanresult-property-as3receiver-class) to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

 Please refer to the [EDIData](#edidata-type) type for a complete list of fields.

# Firewall Property ([AS3Receiver](#as3receiver-class) Class)

A set of properties related to firewall access.

## Syntax

```text
public Firewall getFirewall();
public void setFirewall(Firewall firewall);
```

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

# FTPLastReply Property ([AS3Receiver](#as3receiver-class) Class)

The last reply from the FTP server.

## Syntax

```text
public String getFTPLastReply();
```

## Default Value

""

## Remarks

The last reply from the FTP server.

This property is read-only.

# LocalHost Property ([AS3Receiver](#as3receiver-class) Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

## Syntax

```text
public String getLocalHost();
public void setLocalHost(String localHost);
```

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

# LogDirectory Property ([AS3Receiver](#as3receiver-class) Class)

The path to a directory for logging.

## Syntax

```text
public String getLogDirectory();
public void setLogDirectory(String logDirectory);
```

## 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](#logfile-property-as3receiver-class) 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.

# LogFile Property ([AS3Receiver](#as3receiver-class) Class)

The log file written.

## Syntax

```text
public String getLogFile();
```

## Default Value

""

## Remarks

In case [LogDirectory](#logdirectory-property-as3receiver-class) 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.

# MDNReceipt Property ([AS3Receiver](#as3receiver-class) Class)

The MDN-based receipt generated by the class.

## Syntax

```text
public MDNReceipt getMDNReceipt();
public void setMDNReceipt(MDNReceipt MDNReceipt);
```

## Remarks

After invoking [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class), MDNReceipt will contain the entire text of the receipt to be returned to the client. It will report either success or failure depending on [ScanResult](#scanresult-property-as3receiver-class); in either case it will be RFC-compliant and suitable for returning to the client.

The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class) and customized further by setting the parameters to [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class).

A variety of configuration settings may be used to override the default generation of the outgoing MDN. The MIC algorithm used in the MDN may be set with [MDNMICAlgorithm](#MDNMICAlgorithm);. [MDNReportingUA](#MDNReportingUA) specifies the reporting agent, and [MDNSendingMode](#MDNSendingMode) may be used to specify the "disposition-mode" field in the MDN.

The signature, if any, will use the protocol specified by the [ReceiptSigningProtocol](#ReceiptSigningProtocol) configuration setting, and the certificate specified.

Error reporting may be controlled by configuring [ErrorReportingFlags](#ErrorReportingFlags). By default, any errors will cause MDNReceipt to report a failure to process the message (either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error). Setting [ErrorReportingFlags](#ErrorReportingFlags) will cause the MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the [MDNWarning](#MDNWarning) configuration setting.

MDNReceipt will always be generated by the component; however, if [MDNTo](#mdnto-property-as3receiver-class) is empty, an MDN-based receipt has not been requested. One may be sent anyway at the option of the server. If [MDNTo](#mdnto-property-as3receiver-class) is nonempty, the receipt MUST be returned according to RFC specifications. In AS2, the MDN should be returned in the body of the HTTP reply, or if ReceiptDeliveryOption is nonempty, to the URL specified there instead. In AS3, the MDN should be returned to the URL specified in [MDNTo](#mdnto-property-as3receiver-class).

 Please refer to the [MDNReceipt](#mdnreceipt-type) type for a complete list of fields.

# MDNTo Property ([AS3Receiver](#as3receiver-class) Class)

The URL for the Message Disposition Notification (MDN).

## Syntax

```text
public String getMDNTo();
public void setMDNTo(String MDNTo);
```

## Default Value

""

## Remarks

**MDNTo** corresponds to the *Disposition-Notification-To* header of [RequestHeaders](#requestheaders-property-as3receiver-class). If nonempty, the client has requested that an MDN-based receipt be returned to the URL specified. This receipt will be generated in a call to [ProcessRequest](#processrequest-method-as3receiver-class) or [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class), and may be sent by calling [SendResponse](#sendresponse-method-as3receiver-class).

The receipt and headers will be contained in [MDNReceipt](#mdnreceipt-property-as3receiver-class).

According to RFC specifications, [MDNReceipt](#mdnreceipt-property-as3receiver-class) must be sent if requested by the client.

# MessageId Property ([AS3Receiver](#as3receiver-class) Class)

The message ID of the incoming message.

## Syntax

```text
public String getMessageId();
```

## Default Value

""

## Remarks

MessageId corresponds to the *Message-Id* header of [Request](#request-property-as3receiver-class), and will be used as the *Original-Message-Id* header of [MDNReceipt](#mdnreceipt-property-as3receiver-class).

This property is read-only.

# Passive Property ([AS3Receiver](#as3receiver-class) Class)

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

## Syntax

```text
public boolean isPassive();
public void setPassive(boolean passive);
```

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

# Password Property ([AS3Receiver](#as3receiver-class) Class)

This is the password used to log in.

## Syntax

```text
public String getPassword();
public void setPassword(String password);
```

## Default Value

""

## Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

# RemoteHost Property ([AS3Receiver](#as3receiver-class) Class)

This is the domain name or IP address of the FTP server.

## Syntax

```text
public String getRemoteHost();
public void setRemoteHost(String remoteHost);
```

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

# RemotePort Property ([AS3Receiver](#as3receiver-class) Class)

This is the port for the FTP service (default is 21).

## Syntax

```text
public int getRemotePort();
public void setRemotePort(int remotePort);
```

## 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](#sslstartmode-property-as3receiver-class) property for more information).

This property is not available at design time.

# Request Property ([AS3Receiver](#as3receiver-class) Class)

The AS3 request to process.

## Syntax

```text
public byte[] getRequest();
public void setRequest(byte[] request);
```

## Default Value

""

## Remarks

You may specify the request manually, or you may load the request from the FTP server by invoking [ReadRequest](#readrequest-method-as3receiver-class).

The request may contain the AS3 headers, or these may be specified separately in [RequestHeaders](#requestheaders-property-as3receiver-class). Any methods which read or process the request will split the request into headers and body and populate Request and [RequestHeaders](#requestheaders-property-as3receiver-class) appropriately.

# RequestHeaders Property ([AS3Receiver](#as3receiver-class) Class)

The headers in the AS3 request.

## Syntax

```text
public HeaderList getRequestHeaders();
```

## Remarks

The headers will be parsed from the request by calls to methods such as ParseHeaders, [ParseRequest](#parserequest-method-as3receiver-class), or [ProcessRequest](#processrequest-method-as3receiver-class) is invoked.

 Please refer to the [Header](#header-type) type for a complete list of fields.

# RequestHeadersString Property ([AS3Receiver](#as3receiver-class) Class)

The headers in the AS3 request.

## Syntax

```text
public String getRequestHeadersString();
public void setRequestHeadersString(String requestHeadersString);
```

## Default Value

""

## Remarks

The headers will be parsed from the request by calls to methods such as ParseHeaders, [ParseRequest](#parserequest-method-as3receiver-class), or [ProcessRequest](#processrequest-method-as3receiver-class) is invoked.

# ScanResult Property ([AS3Receiver](#as3receiver-class) Class)

The result of invoking ParseRequest .

## Syntax

```text
public int getScanResult();
```

## Default Value

0

## Remarks

**ScanResult** will contain information about any errors that occurred while invoking [ParseRequest](#parserequest-method-as3receiver-class) or [ProcessRequest](#processrequest-method-as3receiver-class). **ScanResult** will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

|  |  |
| --- | --- |
| 0x01 | Unable to decrypt data. |
| 0x02 | Unable to decompress data. |
| 0x04 | Unable to validate integrity of data. |
| 0x08 | Unable to verify the signature. |
| 0x10 | Client requested unsupported signature type. |
| 0x20 | Client requested unsupported MIC algorithm. |
| 0x40 | Insufficient message security, as determined by the [Config](#config-method-as3receiver-class) entries [RequireSign](#RequireSign) and [RequireEncrypt](#RequireEncrypt). |
| 0x80 | Unexpected processing error. An exception was encountered outside of message processing, such as configuration issues in the class. |
| 0x100 | Duplicate filename. |
| 0x200 | Illegal filename. |
| 0x400 | Empty filename. |
| 0x800 | Error writing incoming file. |

This property is read-only.

# SignerCert Property ([AS3Receiver](#as3receiver-class) Class)

Your trading partner's certificate.

## Syntax

```text
public Certificate getSignerCert();
public void setSignerCert(Certificate signerCert);
```

## Remarks

You must set your trading partner's certificate before processing any signed messages. This property should be set to a public key certificate.

If the trading partner's identity is unknown, you should first invoke [ReadRequest](#readrequest-method-as3receiver-class) and read the value of AS2To (or for AS3, [AS3To](#as3to-property-as3receiver-class)). This will allow you to determine the correct certificate to use.

As a special case, you may set [AcceptAnySignerCert](#AcceptAnySignerCert) to *true*. In this case, the class will attempt to validate the signature without knowing the certificate in advance. This is not recommended for production use, as it poses a security risk.

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLAcceptServerCert Property ([AS3Receiver](#as3receiver-class) Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
```

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

# SSLCert Property ([AS3Receiver](#as3receiver-class) Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);
```

## 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 [Encoded](#Certificate_f_Encoded) 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.

# SSLProvider Property ([AS3Receiver](#as3receiver-class) Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

```text
public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;
```

## 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 is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

# SSLServerCert Property ([AS3Receiver](#as3receiver-class) Class)

The server certificate for the last established connection.

## Syntax

```text
public Certificate getSSLServerCert();
```

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

# SSLStartMode Property ([AS3Receiver](#as3receiver-class) Class)

Determines how the class starts the SSL negotiation. By default, SSL will not be used.

## Syntax

```text
public int getSSLStartMode();
public void setSSLStartMode(int SSLStartMode);

Enumerated values:
  public final static int sslAutomatic = 0;
  public final static int sslImplicit = 1;
  public final static int sslExplicit = 2;
  public final static int sslNone = 3;
```

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

# Timeout Property ([AS3Receiver](#as3receiver-class) Class)

The timeout for the class.

## Syntax

```text
public int getTimeout();
public void setTimeout(int timeout);
```

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

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.

# User Property ([AS3Receiver](#as3receiver-class) Class)

This property contains the user identifier to use to log in.

## Syntax

```text
public String getUser();
public void setUser(String user);
```

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

# Abort Method ([AS3Receiver](#as3receiver-class) Class)

The method aborts the current upload or download.

## Syntax

```text
public void abort();
```

## Remarks

This method sends an *ABOR* command to the FTP server. It is used to interrupt file uploads and downloads.

# ChangeRemotePath Method ([AS3Receiver](#as3receiver-class) Class)

This method changes the current path on the FTP server.

## Syntax

```text
public void changeRemotePath(String remotePath);
```

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

# Config Method ([AS3Receiver](#as3receiver-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-as3receiver-class) 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-as3receiver-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateMDNReceipt Method ([AS3Receiver](#as3receiver-class) Class)

Creates MDNReceipt .

## Syntax

```text
public void createMDNReceipt(String headers, String MDN, String message);
```

## Remarks

**CreateMDNReceipt** may be invoked after [ParseRequest](#parserequest-method-as3receiver-class) to create an MDN-based receipt. The receipt will report success or failure depending on [ErrorReportingFlags](#ErrorReportingFlags) and the success or failure of [ParseRequest](#parserequest-method-as3receiver-class).

This method populates [MDNReceipt](#mdnreceipt-property-as3receiver-class) with a new **MDNReceipt**. The *Headers*, *MDN*, and *Message* parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the class generated defaults. *Headers* will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). *MDN* can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If *MDN* is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. *Message* will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

# DeleteFile Method ([AS3Receiver](#as3receiver-class) Class)

This method removes a file specified by FileName from an FTP server.

## Syntax

```text
public void deleteFile(String fileName);
```

## 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](#changeremotepath-method-as3receiver-class). If no FTP session is in place, one is automatically created by first calling the [Logon](#logon-method-as3receiver-class) method.

# GetFileSize Method ([AS3Receiver](#as3receiver-class) Class)

Gets the size of a file on the FTP server.

## Syntax

```text
public void getFileSize(String fileName);
```

## Remarks

Gets the size of the file specified by *FileName* and RemotePath on the FTP server.

# GetFileTime Method ([AS3Receiver](#as3receiver-class) Class)

Gets the last modification time of a file on the FTP server.

## Syntax

```text
public void getFileTime(String fileName);
```

## Remarks

Gets the last modification time of the file specified by *FileName* and RemotePath on the FTP server.

# ListDirectory Method ([AS3Receiver](#as3receiver-class) Class)

List the current directory on an FTP server.

## Syntax

```text
public void listDirectory(String filesToList);
```

## 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](#dirlist-event-as3receiver-class) event.

Similar to [ListDirectoryLong](#listdirectorylong-method-as3receiver-class), except only file names are returned. If no FTP session is in place, one is automatically created by first calling the [Logon](#logon-method-as3receiver-class) method.

# ListDirectoryLong Method ([AS3Receiver](#as3receiver-class) Class)

List the current directory on an FTP server.

## Syntax

```text
public void listDirectoryLong(String filesToList);
```

## 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](#dirlist-event-as3receiver-class) event. Extended file information is returned.

If no FTP session is in place, one is automatically created by first calling the [Logon](#logon-method-as3receiver-class) method.

# Logoff Method ([AS3Receiver](#as3receiver-class) Class)

This method is used to log off from the FTP server by posting a QUIT command.

## Syntax

```text
public void logoff();
```

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

# Logon Method ([AS3Receiver](#as3receiver-class) Class)

Logon to the FTP RemoteHost using the current User and Password .

## Syntax

```text
public void logon();
```

## Remarks

Logon to the FTP server using the current [User](#user-property-as3receiver-class) and [Password](#password-property-as3receiver-class). If an SSL (TLS) connection is required, you should first set [SSLStartMode](#sslstartmode-property-as3receiver-class).

**Example (Logging On)**

```text
FTPControl.RemoteHost = "ftpserver"
FTPControl.User = "username"
FTPControl.Password = "password"
FTPControl.Logon()
```

# ParseRequest Method ([AS3Receiver](#as3receiver-class) Class)

Parses the EDI message and determines the EDIData .

## Syntax

```text
public void parseRequest();
```

## Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by [Request](#request-property-as3receiver-class) and possibly [RequestHeadersString](#requestheadersstring-property-as3receiver-class)). If the message is encrypted, it will be decrypted with the certificate specified in [Certificate](#certificate-property-as3receiver-class). If it is signed, the signature will be verified against the certificate specified in [SignerCert](#signercert-property-as3receiver-class).

If the message is scanned without difficulty, [EDIData](#edidata-property-as3receiver-class) will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, [EDIData](#edidata-property-as3receiver-class) will not be determined.

The class may be configured to ignore certain errors by setting [ErrorProcessingFlags](#ErrorProcessingFlags). This will allow the message to be processed and [EDIData](#edidata-property-as3receiver-class) to be determined. If any errors occur, an exception will be thrown and the [ScanResult](#scanresult-property-as3receiver-class) property will reflect the error condition.

Whether or not an exception is thrown, an [MDNReceipt](#mdnreceipt-property-as3receiver-class) may be generated by invoking [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class). In the case of a successful scan [MDNReceipt](#mdnreceipt-property-as3receiver-class) will report the success, otherwise the receipt will provide information to the client about the error.

[ProcessRequest](#processrequest-method-as3receiver-class) may be used to scan and create the receipt in one step. [ReadRequest](#readrequest-method-as3receiver-class) may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

# ProcessRequest Method ([AS3Receiver](#as3receiver-class) Class)

Processes the EDI data, and generates the receipt.

## Syntax

```text
public void processRequest();
```

## Remarks

Invoking **ProcessRequest** automates the entire AS2 server process. The method scans the request, determines the [EDIData](#edidata-property-as3receiver-class), and generates the [MDNReceipt](#mdnreceipt-property-as3receiver-class). In a server environment the receipt may be returned by invoking [SendResponse](#sendresponse-method-as3receiver-class).

The method's functionality is the same as the combined functionality of [ParseRequest](#parserequest-method-as3receiver-class) and [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class). The method's operation is controlled by [ErrorProcessingFlags](#ErrorProcessingFlags) and [ErrorReportingFlags](#ErrorReportingFlags), and [ScanResult](#scanresult-property-as3receiver-class) will be populated as in [ParseRequest](#parserequest-method-as3receiver-class).

The method will throw an exception, as [ParseRequest](#parserequest-method-as3receiver-class) does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, [MDNReceipt](#mdnreceipt-property-as3receiver-class) will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the [MDNReceipt](#mdnreceipt-property-as3receiver-class) will provide more detail on the cause of the error.

The class will populate [EDIData](#edidata-property-as3receiver-class) if no errors occurred scanning the request, or if [ErrorProcessingFlags](#ErrorProcessingFlags) had been previously configured to allow the error.

# QueryRemotePath Method ([AS3Receiver](#as3receiver-class) Class)

This queries the server for the current path.

## Syntax

```text
public String queryRemotePath();
```

## 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();
```

# ReadRequest Method ([AS3Receiver](#as3receiver-class) Class)

Reads the AS3 request from the FTP server.

## Syntax

```text
public void readRequest(String fileName);
```

## Remarks

Reads the AS3 request from the FTP server. The name of the file should be given by *FileName*. The request will be parsed into [Request](#request-property-as3receiver-class) and [RequestHeaders](#requestheaders-property-as3receiver-class). The headers will also be parsed and the following properties will be populated:

- AS2From
- AS2To
- AS2Version
- [MessageId](#messageid-property-as3receiver-class)
- [MDNTo](#mdnto-property-as3receiver-class)
- ReceiptDeliveryOption
- [RequestedSignatureProtocol](#RequestedSignatureProtocol)
- [RequestedMICAlgorithms](#RequestedMICAlgorithms)

[ParseRequest](#parserequest-method-as3receiver-class) may be used to scan the entire message.

# Reset Method ([AS3Receiver](#as3receiver-class) Class)

Resets the state of the control.

## Syntax

```text
public void reset();
```

## Remarks

**Reset** resets the state of the class. All properties will be set to their default values.

# SendFTPCommand Method ([AS3Receiver](#as3receiver-class) Class)

This method sends the exact FTP command directly to the FTP server.

## Syntax

```text
public void sendFTPCommand(String command);
```

## 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](#ftplastreply-property-as3receiver-class) property or monitor the [PITrail](#pitrail-event-as3receiver-class) event to obtain the server's response.

# SendResponse Method ([AS3Receiver](#as3receiver-class) Class)

Uploads the MDN receipt.

## Syntax

```text
public void sendResponse(String fileName);
```

## Remarks

Uploads the MDN receipt specified by [MDNReceipt](#mdnreceipt-property-as3receiver-class). You may create this receipt by invoking [ProcessRequest](#processrequest-method-as3receiver-class) or [CreateMDNReceipt](#createmdnreceipt-method-as3receiver-class).

Prior to sending, you may [Logon](#logon-method-as3receiver-class) to the FTP server and navigate to the desired RemotePath. If you have not created an FTP connection already then SendResponse will attempt to establish one.

The URL for upload will be specified (by the sender) in [MDNTo](#mdnto-property-as3receiver-class).

*FileName* should contain the name of the file that will be written on the AS3/FTP server.

# ConnectionStatus Event ([AS3Receiver](#as3receiver-class) Class)

Fired to indicate changes in the connection state.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void connectionStatus(AS3ReceiverConnectionStatusEvent e) {}
  ...
}

public class AS3ReceiverConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}
```

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

# DirList Event ([AS3Receiver](#as3receiver-class) Class)

This event is fired when a directory entry is received.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void dirList(AS3ReceiverDirListEvent e) {}
  ...
}

public class AS3ReceiverDirListEvent {
  public String dirEntry;
  public String fileName;
  public boolean isDir;
  public long fileSize;
  public String fileTime;
}
```

## Remarks

The DirList events are fired when a directory listing is received as a response to a [ListDirectory](#listdirectory-method-as3receiver-class) or [ListDirectoryLong](#listdirectorylong-method-as3receiver-class) call.

The [StartTransfer](#starttransfer-event-as3receiver-class) and [EndTransfer](#endtransfer-event-as3receiver-class) events mark the beginning and end of the event stream.

The *DirEntry* parameter contains the filename when [ListDirectory](#listdirectory-method-as3receiver-class) is called and includes extended file information when [ListDirectoryLong](#listdirectorylong-method-as3receiver-class) is called.

The class tries to fill out the *FileName*, *IsDir*, *FileSize*, and *FileTime* parameters when calling the [ListDirectoryLong](#listdirectorylong-method-as3receiver-class) 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.

# EndTransfer Event ([AS3Receiver](#as3receiver-class) Class)

This event is fired when a file finishes downloading or uploading.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void endTransfer(AS3ReceiverEndTransferEvent e) {}
  ...
}

public class AS3ReceiverEndTransferEvent {
  public int direction;
}
```

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

# Error Event ([AS3Receiver](#as3receiver-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void error(AS3ReceiverErrorEvent e) {}
  ...
}

public class AS3ReceiverErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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-as3receiver-class) section.

# Log Event ([AS3Receiver](#as3receiver-class) Class)

Fired with log information while processing a message.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void log(AS3ReceiverLogEvent e) {}
  ...
}

public class AS3ReceiverLogEvent {
  public String logType;
  public byte[] logMessage;
}
```

## 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](#logdirectory-property-as3receiver-class). This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of [LogDirectory](#logdirectory-property-as3receiver-class) (i.e. when [LogDirectory](#logdirectory-property-as3receiver-class) 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. |

# PITrail Event ([AS3Receiver](#as3receiver-class) Class)

This event traces the commands sent to the server, and the respective replies.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void PITrail(AS3ReceiverPITrailEvent e) {}
  ...
}

public class AS3ReceiverPITrailEvent {
  public int direction;
  public String message;
}
```

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

# SignerCertInfo Event ([AS3Receiver](#as3receiver-class) Class)

This event is fired during verification of the signed message.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void signerCertInfo(AS3ReceiverSignerCertInfoEvent e) {}
  ...
}

public class AS3ReceiverSignerCertInfoEvent {
  public String issuer;
  public String serialNumber;
  public String subjectKeyIdentifier;
  public byte[] certEncoded;
}
```

## Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for [SignerCert](#signercert-property-as3receiver-class) to verify the signature. The following parameters may be populated:

*Issuer* specifies the subject of the issuer of the certificate used to sign the message.

*SerialNumber* is the serial number of the certificate used to sign the message.

*SubjectKeyIdentifier* is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

*CertEncoded* is the PEM (Base64 encoded) public certificate needed to verify the signature.

NOTE: When this value is present, the class will automatically use this value to perform signature verification.

The [SignerCert](#signercert-property-as3receiver-class) property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

# SSLServerAuthentication Event ([AS3Receiver](#as3receiver-class) Class)

Fired after the server presents its certificate to the client.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void SSLServerAuthentication(AS3ReceiverSSLServerAuthenticationEvent e) {}
  ...
}

public class AS3ReceiverSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

 When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True.

# SSLStatus Event ([AS3Receiver](#as3receiver-class) Class)

Fired when secure connection progress messages are available.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void SSLStatus(AS3ReceiverSSLStatusEvent e) {}
  ...
}

public class AS3ReceiverSSLStatusEvent {
  public String message;
}
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# StartTransfer Event ([AS3Receiver](#as3receiver-class) Class)

This event fires when a file starts downloading or uploading.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void startTransfer(AS3ReceiverStartTransferEvent e) {}
  ...
}

public class AS3ReceiverStartTransferEvent {
  public int direction;
}
```

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

# Transfer Event ([AS3Receiver](#as3receiver-class) Class)

This event is fired during the file download or upload.

## Syntax

```text
public class DefaultAS3ReceiverEventListener implements AS3ReceiverEventListener {
  ...
  public void transfer(AS3ReceiverTransferEvent e) {}
  ...
}

public class AS3ReceiverTransferEvent {
  public int direction;
  public long bytesTransferred;
  public int percentDone;
  public byte[] text;
}
```

## 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 field 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 [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). 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](#Certificate_f_PrivateKey).

 **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 [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *String (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) 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** *int (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 [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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** *byte[]*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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 field is used to specify the password needed to open the certificate store.

 **StoreType** *int*
*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 field 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 [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_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 [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_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 [UsageFlags](#Certificate_f_UsageFlags).

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** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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 field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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 field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte[]*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) 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 field contains the attachment data.

In a receiver, the class decodes the attachment to the [Data](#EDIAttachment_f_Data) field when [Data](#EDIAttachment_f_Data)'s value is first queried. This field will contain the full decrypted text of the attachment.

 **DataB** *byte[]*
*Default Value: ""*

This field contains the attachment data.

In a receiver, the class decodes the attachment to the [Data](#EDIAttachment_f_Data) field when [Data](#EDIAttachment_f_Data)'s value is first queried. This field 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 field. Otherwise, this will contain the name of the attachment as described in the [Headers](#EDIAttachment_f_Headers).

 **Headers** *String*
*Default Value: ""*

The class fills out [Headers](#EDIAttachment_f_Headers) each time any of the other fields for that [EDIAttachment](#ediattachment-type) are changed. If additional headers are needed they should be appended after all the other fields for that [EDIAttachment](#ediattachment-type) are set.

 **InputStream** *java.io.InputStream*
*Default Value: ""*

If [InputStream](#EDIAttachment_f_InputStream) is specified, the data from the stream specified will be used for the EDI attachment.

 **Name** *String*
*Default Value: ""*

[Name](#EDIAttachment_f_Name) is the final name to be associated with the contents of either the [Data](#EDIAttachment_f_Data) or [FileName](#EDIAttachment_f_FileName) fields. This corresponds to the *filename* attribute of the *Content-Disposition* header for this attachment.

 **OutputStream** *java.io.OutputStream (read-only)*
*Default Value: ""*

The class decodes the attachment of Message when This field'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 field.

## 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 field contains the EDI payload of the transmission.

In a receiver, this field will only be populated if IncomingDirectory and [OutputStream](#EDIData_f_OutputStream) 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** *byte[]*
*Default Value: ""*

This field contains the EDI payload of the transmission.

In a receiver, this field will only be populated if IncomingDirectory and [OutputStream](#EDIData_f_OutputStream) 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** *java.io.InputStream*
*Default Value: ""*

In a sender, if [InputStream](#EDIData_f_InputStream) is specified, the data from the specified stream will be used for the EDI payload of the transmission.

 **Name** *String*
*Default Value: "rfc1767.edi"*

[Name](#EDIData_f_Name) is the final name to be associated with the contents of either the [Data](#EDIData_f_Data) or [FileName](#EDIData_f_FileName) fields. This corresponds to the *filename* attribute of the *Content-Disposition* header for the EDI payload.

When constructing EDI data to be sent, [Name](#EDIData_f_Name) will be set to the same value as [FileName](#EDIData_f_FileName), but can be overridden after setting [FileName](#EDIData_f_FileName) to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, [Name](#EDIData_f_Name) will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

 **OutputStream** *java.io.OutputStream*
*Default Value: ""*

In a receiver, if this field 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 [OutputStream](#EDIData_f_OutputStream) 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 [FileName](#EDIData_f_FileName) is specified, the file specified will be used for the EDI payload of the transmission. [Name](#EDIData_f_Name) 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 [OutputStream](#EDIData_f_OutputStream) is set, the data will be written to the stream and this field 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 [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

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.

Connection information will first be obtained from Java system properties, such as *http.proxyHost* and *https.proxyHost*. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.

If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

 **FirewallType** *int*
*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. [Port](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *String*
*Default Value: ""*

The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.

 **Password** *String*
*Default Value: ""*

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

 **Port** *int*
*Default Value: 0*

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *String*
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class throws an exception.

## Constructors

```text
public Firewall();
```

# Header Type

This is an HTTP header as it is received from the server.

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value).

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *String*
*Default Value: ""*

This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *String*
*Default Value: ""*

This field contains the [Header](#header-type) contents.

## Constructors

```text
public Header();
```

```text
public Header(String field, String value);
```

# 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 [MDN](#MDNReceipt_f_MDN) (Message Disposition Notification) and a human readable [Message](#MDNReceipt_f_Message), which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

 **ContentB** *byte[]*
*Default Value: ""*

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable [MDN](#MDNReceipt_f_MDN) (Message Disposition Notification) and a human readable [Message](#MDNReceipt_f_Message), which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

 **HeaderCount** *int (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](#MDNReceipt_f_HeaderIndex).

 **HeaderIndex** *int*
*Default Value: 0*

Which MDN header is currently selected to populate [HeaderField](#MDNReceipt_f_HeaderField) and [HeaderValue](#MDNReceipt_f_HeaderValue).

Valid values are 0 to [HeaderCount](#MDNReceipt_f_HeaderCount) - 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 [HeaderCount](#MDNReceipt_f_HeaderCount), [HeaderIndex](#MDNReceipt_f_HeaderIndex), [HeaderField](#MDNReceipt_f_HeaderField), and [HeaderValue](#MDNReceipt_f_HeaderValue) to easily iterate through each individual header.

 **HeaderValue** *String (read-only)*
*Default Value: ""*

The value of the MDN header currently selected by [HeaderIndex](#MDNReceipt_f_HeaderIndex).

 **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 field 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 ([AS3Receiver](#as3receiver-class) 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](#config-method-as3receiver-class) method.

### AS3Receiver Config Settings

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

### 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](#passive-property-as3receiver-class) = 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](#passive-property-as3receiver-class) = 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.

**DirEntryPattern**: Allows the use of regular expressions to parse non-standard directory entry formats.In some cases, the server may return a directory entry format that cannot be automatically parsed by the adapter. In this case, the full entry format can be seen in the DirEntry parameter of [DirList](#dirlist-event-as3receiver-class). You can use this property to define a regular expression to parse the entry. The value of this setting is specified in the following format:

*A,B,C,X=Y|RegEx*

A,B,C, and X represent integer values that correspond to the capturing groups of the regular expression in the following order:

- FileName
- FileSize
- FileTime
- IsDir

Because group X represents the IsDir value, the user must specify Y to indicate what value that group must have in order for IsDir to be True.

Take, for instance, a simple entry in this format:

*22 Test.txt*

In this example, "22" is the FileSize and "Test.txt" is the FileName. To parse this entry, we will define the DirEntryPattern as follows:

*2,1,-1,-1|([0-9]+)\s(.*)*

The first value "2" indicates that the first field (FileName) corresponds to the second capturing group in the regular expression. The second value "1" indicates that the second field (FileSize) corresponds to the first capturing group in the regular expression. The capturing group is the regular expression in parenthesis. In the previous example, the first capturing group is ([0-9]+) and the second capturing group is (.*).

As seen in this example, -1 also can be specified as the integer value. When this is specified, that field is ignored.

**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](#dirlist-event-as3receiver-class) 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.

**MaxDirEntries**: Instructs class to save the amount of entries specified that are returned by the server after a ListDirectory call has been made.This configuration setting should be set when populating the DirList collection after a call to either [ListDirectory](#listdirectory-method-as3receiver-class) or [ListDirectoryLong](#listdirectorylong-method-as3receiver-class). This value represents the number of entries that are to be saved in the collection.

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

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

**PortRange**: Allows the specification of a port range where the class listens for active mode connections.When set to use active mode ([Passive](#passive-property-as3receiver-class) = 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](#listdirectory-method-as3receiver-class) or [ListDirectoryLong](#listdirectorylong-method-as3receiver-class). 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](#listdirectory-method-as3receiver-class) or [ListDirectoryLong](#listdirectorylong-method-as3receiver-class). 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.

**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](#sslstartmode-property-as3receiver-class) 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](#remotehost-property-as3receiver-class) 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](#passive-property-as3receiver-class) 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

**CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

**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](#timeout-property-as3receiver-class) 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](#remotehost-property-as3receiver-class) 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 throws an exception 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](#connected-property-as3receiver-class) 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.

**FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the class acts as a server. [RemoteHost](#remotehost-property-as3receiver-class) and [RemotePort](#remoteport-property-as3receiver-class) are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore [RemoteHost](#remotehost-property-as3receiver-class), and it is recommended that [RemoteHost](#remotehost-property-as3receiver-class) be set to empty string in this case.

[RemotePort](#remoteport-property-as3receiver-class) is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the [ConnectionStatus](#connectionstatus-event-as3receiver-class) event.

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

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#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 throws an exception.

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

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](#localhost-property-as3receiver-class) 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](#localhost-property-as3receiver-class) 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](#sslprovider-property-as3receiver-class) 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](#sslstatus-event-as3receiver-class) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-as3receiver-class) is set to *Platform*.

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

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-as3receiver-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-as3receiver-class) 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-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**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](#sslstatus-event-as3receiver-class) 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-----
```

**SSLContextProtocol**: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

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

NOTE: This value must be set after [SSLProvider](#sslprovider-property-as3receiver-class) is set.

Example values:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-as3receiver-class) is set to *Platform* include the following:

- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA

Possible values when [SSLProvider](#sslprovider-property-as3receiver-class) 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:**

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-as3receiver-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-as3receiver-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-as3receiver-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-as3receiver-class) 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](#sslprovider-property-as3receiver-class) 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](#sslserverauthentication-event-as3receiver-class) 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](#sslserverauthentication-event-as3receiver-class) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-as3receiver-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When [SSLProvider](#sslprovider-property-as3receiver-class) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider.

**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](#sslprovider-property-as3receiver-class) 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]");
```

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

**SSLTrustManagerFactoryAlgorithm**: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

**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](#sslprovider-property-as3receiver-class) 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 throws an exception.

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](#sslprovider-property-as3receiver-class) 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](#timeout-property-as3receiver-class) 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.

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

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

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

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;
```

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());
```

When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When [SSLProvider](#sslprovider-property-as3receiver-class) is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If [SSLProvider](#sslprovider-property-as3receiver-class) is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

//required to use BCJSSE when SSLProvider is set to sslpPlatform
import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;
```

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());

//required to use BCJSSE when SSLProvider is set to sslpPlatform
Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS"));

//optional - configure logging level of BCJSSE
Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF);

//configure the class to use BCJSSE
component.setSSLProvider(1); //platform
component.config("UseFIPSCompliantAPI=true");
```

 NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

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

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([AS3Receiver](#as3receiver-class) Class)

### AS3Receiver Errors

|  |  |
| --- | --- |
| 1001 | You must set the request filename first. |
| 903 | You must specify a remote filename. |
| 1002 | A response was not requested. |
| 701 | Unable to write log file. |
| 711 | The incoming message was encrypted with an unknown protocol. |
| 712 | Unable to decrypt message. |
| 713 | Unable to decompress message. |
| 732 | *Unable to verify content integrity. |
| 733 | *Unsupported signature type was requested. |
| 734 | *Unsupported MIC algorithm(s) were requested. |

### 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](#remoteport-property-as3receiver-class) at this time. A connection is in progress. |
| 101 | You cannot change the [RemoteHost](#remotehost-property-as3receiver-class) (Server) at this time. A connection is in progress. |
| 102 | The [RemoteHost](#remotehost-property-as3receiver-class) 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](#localhost-property-as3receiver-class) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | [RemotePort](#remoteport-property-as3receiver-class) 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. |
| 303 | 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. |