# AS1Receiver Module The AS1Receiver module is used to process AS1 messages and generate receipts. ## Syntax ```text IPWorksEDI.AS1Receiver ``` ## Remarks The AS1Receiver class allows you to receive AS1 messages as specified in RFC 3335. The class can act as an email client, decrypt and verify incoming messages, generate receipts including Message Disposition Notifications (MDNs), and send them over SMTP/S. **Basic Operation** You should first log in to your mail server by setting [MailServer](#mailserver-property-as1receiver-module), [User](#user-property-as1receiver-module), and [Password](#password-property-as1receiver-module), and invoking [Connect](#connect-method-as1receiver-module). You may then navigate your mail inbox by setting [MailMessageNumber](#mailmessagenumber-property-as1receiver-module), and inspecting properties such as [MailMessageFrom](#mailmessagefrom-property-as1receiver-module), etc. When you find the desired file you may download it by invoking [ReadRequest](#readrequest-method-as1receiver-module). Alternatively, you may acquire the AS1 data by other means and directly set [Request](#request-property-as1receiver-module) and [RequestHeaders](#requestheaders-property-as1receiver-module). [ReadRequest](#readrequest-method-as1receiver-module) (or ParseHeaders) will determine information such as [From](#from-property-as1receiver-module) and [SendTo](#sendto-property-as1receiver-module), which will allow you to set the appropriate certificates. You may specify your certificate with the [Certificate](#certificate-property-as1receiver-module) property, and your trading partner's (signing) certificate with the [SignerCert](#signercert-property-as1receiver-module) property. Then, invoke [ProcessRequest](#processrequest-method-as1receiver-module) to process the request and generate the MDN receipt as specified in RFC 3335. If the request was processed successfully, [EDIData](#edidata-property-as1receiver-module) will contain the transmitted EDI data. If a problem occurred, [EDIData](#edidata-property-as1receiver-module) will not be populated and an exception will be thrown. In either case [MDNReceipt](#mdnreceipt-property-as1receiver-module) will contain the RFC-compliant receipt, which should be returned to the client. The [MDNReceipt](#mdnreceipt-property-as1receiver-module) may be returned over SMTP/S by invoking [SendResponse](#sendresponse-method-as1receiver-module). In case the server address for incoming mail is different than that for outgoing mail you should use [Config](#config-method-as1receiver-module) to configure this. To create log files, set [LogDirectory](#logdirectory-property-as1receiver-module) prior to invoking [ProcessRequest](#processrequest-method-as1receiver-module). This will log all incoming and outgoing data, and will also write the received EDI files to disk. **Example** ```text AS1Receiver1.User = "myusername" AS1Receiver1.Password = "mypassword" AS1Receiver1.MailServer = "1.2.3.4" AS1Receiver1.Connect() // You may need to search the server for received files at this point AS1Receiver1.MessageNumber = 1; // You may check properties such as MailMessageFrom, etc. AS1Receiver1.ReadRequest() AS1Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS1Receiver1.SignerCert = (base 64 encoded certificate); AS1Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS1Receiver1.ProcessRequest(); AS1Receiver1.SendResponse(); AS1Receiver1.Disconnect(); ``` 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 module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Attachments](#attachments-property-as1receiver-module) | Collection of files attached to the current message. | | [Certificate](#certificate-property-as1receiver-module) | The decryption and receipt signing certificate. | | [CompressionFormat](#compressionformat-property-as1receiver-module) | The compression format used on the incoming message. | | [Connected](#connected-property-as1receiver-module) | Whether the module is connected. | | [EDIData](#edidata-property-as1receiver-module) | The EDI data sent in Request . | | [Firewall](#firewall-property-as1receiver-module) | A set of properties related to firewall access. | | [From](#from-property-as1receiver-module) | The sender of the original message. | | [LocalHost](#localhost-property-as1receiver-module) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LogDirectory](#logdirectory-property-as1receiver-module) | The path to a directory for logging. | | [LogFile](#logfile-property-as1receiver-module) | The log file written. | | [MailMessageCc](#mailmessagecc-property-as1receiver-module) | The value of the Cc header of the mail message. | | [MailMessageCount](#mailmessagecount-property-as1receiver-module) | The number of messages waiting in the mailbox. | | [MailMessageDate](#mailmessagedate-property-as1receiver-module) | The message date for the currently selected message. | | [MailMessageFrom](#mailmessagefrom-property-as1receiver-module) | The sender of the mail message. | | [MailMessageHeaders](#mailmessageheaders-property-as1receiver-module) | The message headers for the currently selected message. | | [MailMessageNumber](#mailmessagenumber-property-as1receiver-module) | The message number on the incoming mail server. | | [MailMessageReplyTo](#mailmessagereplyto-property-as1receiver-module) | The value of the ReplyTo header of the mail message. | | [MailMessageSubject](#mailmessagesubject-property-as1receiver-module) | The subject of the mail message. | | [MailMessageText](#mailmessagetext-property-as1receiver-module) | The text of the mail message. | | [MailMessageTo](#mailmessageto-property-as1receiver-module) | The recipient of the mail message. | | [MailServer](#mailserver-property-as1receiver-module) | The address of your mail server. | | [MDNReceipt](#mdnreceipt-property-as1receiver-module) | The MDN-based receipt generated by the module. | | [MDNTo](#mdnto-property-as1receiver-module) | The recipient for the Message Disposition Notification (MDN). | | [MessageId](#messageid-property-as1receiver-module) | The message ID of the incoming message. | | [OAuth](#oauth-property-as1receiver-module) | The OAuth settings. | | [Password](#password-property-as1receiver-module) | The password for your incoming mail server. | | [Request](#request-property-as1receiver-module) | The AS1 request to be processed. | | [RequestHeaders](#requestheaders-property-as1receiver-module) | The headers in the AS1 request. | | [RequestHeadersString](#requestheadersstring-property-as1receiver-module) | The headers in the AS1 request. | | [ScanResult](#scanresult-property-as1receiver-module) | The result of invoking ParseRequest . | | [SendTo](#sendto-property-as1receiver-module) | The recipient of the original message. | | [SignerCert](#signercert-property-as1receiver-module) | Your trading partner's certificate. | | [SSLAcceptServerCert](#sslacceptservercert-property-as1receiver-module) | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-as1receiver-module) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-as1receiver-module) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-as1receiver-module) | The server certificate for the last established connection. | | [SSLStartMode](#sslstartmode-property-as1receiver-module) | Determines how the module starts the SSL negotiation. By default, SSL will not be used. | | [User](#user-property-as1receiver-module) | The username for your incoming mail server. | ## Method List *The following is the full list of the methods of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-as1receiver-module) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-as1receiver-module) | Connects to the incoming mail server. | | [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module) | Creates MDNReceipt . | | [DeleteMessage](#deletemessage-method-as1receiver-module) | Deletes the message specified by MailMessageNumber . | | [Disconnect](#disconnect-method-as1receiver-module) | Disconnects from the incoming mail server. | | [ParseRequest](#parserequest-method-as1receiver-module) | Parses the EDI message and determines the EDIData . | | [ProcessQueue](#processqueue-method-as1receiver-module) | Send the messages queued for sending. | | [ProcessRequest](#processrequest-method-as1receiver-module) | Processes the EDI data, and generates the receipt. | | [QueryMessageSize](#querymessagesize-method-as1receiver-module) | Returns the size in bytes of the current message. | | [QueryMessageUID](#querymessageuid-method-as1receiver-module) | Returns the unique identifier of the message as specified by the server. | | [Queue](#queue-method-as1receiver-module) | Prepares and queues the message to the specified directory. | | [ReadRequest](#readrequest-method-as1receiver-module) | Reads the AS1 request from the mail server. | | [Reset](#reset-method-as1receiver-module) | Resets the state of the control. | | [SelectMailMessage](#selectmailmessage-method-as1receiver-module) | Selects and obtains information about the specified message. | | [SendResponse](#sendresponse-method-as1receiver-module) | Sends the MDN receipt. | ## Event List *The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ConnectionStatus](#connectionstatus-event-as1receiver-module) | Fired to indicate changes in the connection state. | | [EndTransfer](#endtransfer-event-as1receiver-module) | Fired when the message text completes transferring. | | [Error](#error-event-as1receiver-module) | Fired when information is available about errors during data delivery. | | [Header](#header-event-as1receiver-module) | This event is fired for every message header being retrieved. | | [LaunchBrowser](#launchbrowser-event-as1receiver-module) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-as1receiver-module) | Fired with log information while processing a message. | | [PITrail](#pitrail-event-as1receiver-module) | This event traces the commands sent to the mail server, and the respective replies. | | [SignerCertInfo](#signercertinfo-event-as1receiver-module) | This event is fired during verification of the signed message. | | [SSLServerAuthentication](#sslserverauthentication-event-as1receiver-module) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-as1receiver-module) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-as1receiver-module) | Fired when the message text starts transferring (on either a send or receive). | | [Transfer](#transfer-event-as1receiver-module) | Fired while the message text gets transferred to or from MailServer . | ## Config Settings *The following is a list of config settings for the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [FileName](#FileName) | The filename of the EDI Data. | | [LogFilename](#LogFilename) | The base name of the log file. | | [POPPort](#POPPort) | The POP mail port to be used, if different than MailServer. | | [POPServer](#POPServer) | The POP server to be used, if different than MailServer. | | [SMTPAuthMechanism](#SMTPAuthMechanism) | The authentication mechanism used to connect to the SMTP server. | | [SMTPPassword](#SMTPPassword) | The password used for authentication. | | [SMTPPort](#SMTPPort) | The SMTP mail port to be used, if different than MailServer. | | [SMTPServer](#SMTPServer) | The SMTP server to be used, if different than MailServer. | | [SMTPSSLStartMode](#SMTPSSLStartMode) | Determines how SSL negotiation starts with the SMTP server. | | [SMTPUser](#SMTPUser) | The user name used for authentication. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [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. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # Attachments Property ([AS1Receiver](#as1receiver-module) Module) Collection of files attached to the current message. ## Syntax ```text public var attachments: Array { get {...} } ``` ## Default Value "" ## Remarks When a message is received, the class will write all of the files attached to the [EDIData](#edidata-property-as1receiver-module) into temp files. These attachments can be retrieved by walking this collection and retrieving their file names. # Certificate Property ([AS1Receiver](#as1receiver-module) Module) The decryption and receipt signing certificate. ## Syntax ```text public var certificate: Certificate { get {...} set {...} } ``` ## Default Value "" ## 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-as1receiver-module), then set the signing certificate before calling [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module). Certificate must be set to a private key certificate. # CompressionFormat Property ([AS1Receiver](#as1receiver-module) Module) The compression format used on the incoming message. ## Syntax ```text public var compressionFormat: AS1ReceiverCompressionFormats { get {...} } public enum AS1ReceiverCompressionFormats: Int32 { case cfNone = 0 case 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 ([AS1Receiver](#as1receiver-module) Module) Whether the module is connected. ## Syntax ```text public var connected: Bool { get {...} } ``` ## Default Value False ## Remarks This property is used to determine whether or not the class is connected to the remote host. Use the [Connect](#connect-method-as1receiver-module) and [Disconnect](#disconnect-method-as1receiver-module) methods to manage the connection. This property is read-only. # EDIData Property ([AS1Receiver](#as1receiver-module) Module) The EDI data sent in Request . ## Syntax ```text public var ediData: EDIData { get {...} } ``` ## Default Value "" ## Remarks This property will only be populated if [ParseRequest](#parserequest-method-as1receiver-module) or [ProcessRequest](#processrequest-method-as1receiver-module) finishes without an error, setting [ScanResult](#scanresult-property-as1receiver-module) to 0. If so, EDIData will contain the processed EDI message. # Firewall Property ([AS1Receiver](#as1receiver-module) Module) A set of properties related to firewall access. ## Syntax ```text public var firewall: Firewall { get {...} set {...} } ``` ## Default Value "" ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. # From Property ([AS1Receiver](#as1receiver-module) Module) The sender of the original message. ## Syntax ```text public var from: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The sender of the original message. The recipient is given by [SendTo](#sendto-property-as1receiver-module). Note that From and [SendTo](#sendto-property-as1receiver-module) correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that From indicates the *recipient*, and [SendTo](#sendto-property-as1receiver-module) indicates the *sender* of the MDN. # LocalHost Property ([AS1Receiver](#as1receiver-module) Module) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public var localHost: String { get {...} set {...} } ``` ## 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 ([AS1Receiver](#as1receiver-module) Module) The path to a directory for logging. ## Syntax ```text public var logDirectory: String { get {...} set {...} } ``` ## 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 AS1 messages created or downloaded by the class will be written with extension ".as1", and MDNs created or downloaded will be written with extension ".as1-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-as1receiver-module) 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 ([AS1Receiver](#as1receiver-module) Module) The log file written. ## Syntax ```text public var logFile: String { get {...} } ``` ## Default Value "" ## Remarks In case [LogDirectory](#logdirectory-property-as1receiver-module) 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 AS1 messages and MDNs will also be written with extensions ".as1" and ".as1-mdn". This property is read-only. # MailMessageCc Property ([AS1Receiver](#as1receiver-module) Module) The value of the Cc header of the mail message. ## Syntax ```text public var mailMessageCc: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will be populated with the value of the Cc header of the mail message. This property is read-only. # MailMessageCount Property ([AS1Receiver](#as1receiver-module) Module) The number of messages waiting in the mailbox. ## Syntax ```text public var mailMessageCount: Int32 { get {...} } ``` ## Default Value 0 ## Remarks When the class is not connected to the mail server, the value of the MailMessageCount property is 0. When connected, it contains the number of messages in the mailbox. You may set [MailMessageNumber](#mailmessagenumber-property-as1receiver-module) to any value between 1 and MailMessageCount to inspect a given message. This property is read-only. # MailMessageDate Property ([AS1Receiver](#as1receiver-module) Module) The message date for the currently selected message. ## Syntax ```text public var mailMessageDate: String { get {...} } ``` ## Default Value "" ## Remarks The date will be formatted like the following example: Wed, 29 Dec 2004 11:58:02 +0700 This property is read-only. # MailMessageFrom Property ([AS1Receiver](#as1receiver-module) Module) The sender of the mail message. ## Syntax ```text public var mailMessageFrom: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will be populated. When processing AS1 transmissions, this will correspond to [From](#from-property-as1receiver-module). When processing MDNs, this will correspond to [SendTo](#sendto-property-as1receiver-module). This property is read-only. # MailMessageHeaders Property ([AS1Receiver](#as1receiver-module) Module) The message headers for the currently selected message. ## Syntax ```text public var mailMessageHeaders: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will contain the full headers of the mail message as reported by the mail server. This property is read-only. # MailMessageNumber Property ([AS1Receiver](#as1receiver-module) Module) The message number on the incoming mail server. ## Syntax ```text public var mailMessageNumber: Int32 { get {...} set {...} } ``` ## Default Value 0 ## Remarks MailMessageNumber specifies a number between 1 and [MailMessageCount](#mailmessagecount-property-as1receiver-module), and serves as a message pointer to an incoming mail message. Set this property before calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) # MailMessageReplyTo Property ([AS1Receiver](#as1receiver-module) Module) The value of the ReplyTo header of the mail message. ## Syntax ```text public var mailMessageReplyTo: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will be populated with the value of the ReplyTo header of the mail message. This property is read-only. # MailMessageSubject Property ([AS1Receiver](#as1receiver-module) Module) The subject of the mail message. ## Syntax ```text public var mailMessageSubject: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will be populated with the subject of the mail message. This property is read-only. # MailMessageText Property ([AS1Receiver](#as1receiver-module) Module) The text of the mail message. ## Syntax ```text public var mailMessageText: String { get {...} } ``` ## Default Value "" ## Remarks The text of the mail message identified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module), if it has been downloaded from the server. To read the message, invoke [ReadRequest](#readrequest-method-as1receiver-module) (receiver) or ReadReceipt (sender). In case the message is not as AS1 message this will throw an exception, but you may catch it and then read the value of MailMessageText. This property is read-only. # MailMessageTo Property ([AS1Receiver](#as1receiver-module) Module) The recipient of the mail message. ## Syntax ```text public var mailMessageTo: String { get {...} } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1receiver-module) this property will be populated with the recipient of the mail message. This property is read-only. # MailServer Property ([AS1Receiver](#as1receiver-module) Module) The address of your mail server. ## Syntax ```text public var mailServer: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The address of your mail server. By default, the class will send outgoing mail via SMTP, and receive incoming mail via POP. Moreover, the class will assume that both servers are located at the address specified by MailServer. In case you use different addresses for incoming and outgoing mail you should set the **POPServer** and **SMTPServer** configuration settings appropriately. You may also set **POPPort** and **SMTPPort** in case you use nonstandard ports. To configure SSL you should set [SSLStartMode](#sslstartmode-property-as1receiver-module). Note that if SSL is used for sending but not receiving, or vice versa, you should set [SSLStartMode](#sslstartmode-property-as1receiver-module) each time you send or receive a file. # MDNReceipt Property ([AS1Receiver](#as1receiver-module) Module) The MDN-based receipt generated by the module. ## Syntax ```text public var mdnReceipt: MDNReceipt { get {...} set {...} } ``` ## Default Value "" ## Remarks After invoking [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module), 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-as1receiver-module); 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-as1receiver-module) and customized further by setting the parameters to [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module). 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module). # MDNTo Property ([AS1Receiver](#as1receiver-module) Module) The recipient for the Message Disposition Notification (MDN). ## Syntax ```text public var mdnTo: String { get {...} } ``` ## Default Value "" ## Remarks MDNTo corresponds to the *Disposition-Notification-To* header of [RequestHeaders](#requestheaders-property-as1receiver-module). If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to [ProcessRequest](#processrequest-method-as1receiver-module) or [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module), and may be sent by calling [SendResponse](#sendresponse-method-as1receiver-module). The receipt will be contained in [MDNReceipt](#mdnreceipt-property-as1receiver-module). If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, [SendResponse](#sendresponse-method-as1receiver-module) will send the response as appropriate. According to RFC specifications, [MDNReceipt](#mdnreceipt-property-as1receiver-module) must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server. This property is read-only. # MessageId Property ([AS1Receiver](#as1receiver-module) Module) The message ID of the incoming message. ## Syntax ```text public var messageId: String { get {...} } ``` ## Default Value "" ## Remarks MessageId corresponds to the *Message-Id* header of [Request](#request-property-as1receiver-module), and will be used as the *Original-Message-Id* header of [MDNReceipt](#mdnreceipt-property-as1receiver-module). This property is read-only. # OAuth Property ([AS1Receiver](#as1receiver-module) Module) The OAuth settings. ## Syntax ```text public var oAuth: MailOAuthSettings { get {...} } ``` ## Default Value "" ## Remarks This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information. # Password Property ([AS1Receiver](#as1receiver-module) Module) The password for your incoming mail server. ## Syntax ```text public var password: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The password for your incoming mail server. Set this before invoking [Connect](#connect-method-as1receiver-module). # Request Property ([AS1Receiver](#as1receiver-module) Module) The AS1 request to be processed. ## Syntax ```text public var request: String { get {...} set {...} } public var requestB: Data { get {...} set {...} } ``` ## Default Value "" ## Remarks You may specify the request manually, or you may load the request from the mail server by invoking [ReadRequest](#readrequest-method-as1receiver-module). The headers generally should be specified separately in [RequestHeaders](#requestheaders-property-as1receiver-module). # RequestHeaders Property ([AS1Receiver](#as1receiver-module) Module) The headers in the AS1 request. ## Syntax ```text public var requestHeaders: Array
{ get {...} } ``` ## Default Value "" ## Remarks The headers will include any and all headers attached by the mail server(s). # RequestHeadersString Property ([AS1Receiver](#as1receiver-module) Module) The headers in the AS1 request. ## Syntax ```text public var requestHeadersString: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The headers will include any and all headers attached by the mail server(s). # ScanResult Property ([AS1Receiver](#as1receiver-module) Module) The result of invoking ParseRequest . ## Syntax ```text public var scanResult: Int32 { get {...} } ``` ## Default Value 0 ## Remarks **ScanResult** will contain information about any errors that occurred while invoking [ParseRequest](#parserequest-method-as1receiver-module) or [ProcessRequest](#processrequest-method-as1receiver-module). **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-as1receiver-module) 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. # SendTo Property ([AS1Receiver](#as1receiver-module) Module) The recipient of the original message. ## Syntax ```text public var sendTo: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The recipient of the original message. The originator is given by [From](#from-property-as1receiver-module). Note that [From](#from-property-as1receiver-module) and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that [From](#from-property-as1receiver-module) indicates the *recipient*, and SendTo indicates the *sender* of the MDN. # SignerCert Property ([AS1Receiver](#as1receiver-module) Module) Your trading partner's certificate. ## Syntax ```text public var signerCert: Certificate { get {...} set {...} } ``` ## Default Value "" ## 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-as1receiver-module) and read the value of AS2To (or for AS3, AS3To). 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. # SSLAcceptServerCert Property ([AS1Receiver](#as1receiver-module) Module) Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public var sslAcceptServerCert: Certificate { get {...} set {...} } ``` ## Default Value "" ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. # SSLCert Property ([AS1Receiver](#as1receiver-module) Module) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public var sslCert: Certificate { get {...} set {...} } ``` ## Default Value "" ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. # SSLProvider Property ([AS1Receiver](#as1receiver-module) Module) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public var sslProvider: AS1ReceiverSSLProviders { get {...} set {...} } public enum AS1ReceiverSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case 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 will be used by default in all cases in the macOS edition. # SSLServerCert Property ([AS1Receiver](#as1receiver-module) Module) The server certificate for the last established connection. ## Syntax ```text public var sslServerCert: Certificate { get {...} } ``` ## Default Value "" ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. # SSLStartMode Property ([AS1Receiver](#as1receiver-module) Module) Determines how the module starts the SSL negotiation. By default, SSL will not be used. ## Syntax ```text public var sslStartMode: AS1ReceiverSSLStartModes { get {...} set {...} } public enum AS1ReceiverSSLStartModes: Int32 { case sslAutomatic = 0 case sslImplicit = 1 case sslExplicit = 2 case 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. | # User Property ([AS1Receiver](#as1receiver-module) Module) The username for your incoming mail server. ## Syntax ```text public var user: String { get {...} set {...} } ``` ## Default Value "" ## Remarks The username for your incoming mail server. Set this before invoking [Connect](#connect-method-as1receiver-module). # Config Method ([AS1Receiver](#as1receiver-module) Module) Sets or retrieves a configuration setting. ## Syntax ```text public func config(configurationString: String) throws -> String ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-as1receiver-module) 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-as1receiver-module), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([AS1Receiver](#as1receiver-module) Module) Connects to the incoming mail server. ## Syntax ```text public func connect() throws -> Void ``` ## Remarks Connects to the incoming mail server specified by [MailServer](#mailserver-property-as1receiver-module). You must set [User](#user-property-as1receiver-module) and [Password](#password-property-as1receiver-module) prior to calling Connect. The connection will be maintained until you call [Disconnect](#disconnect-method-as1receiver-module). If you wish to connect in SSL you should first set the [SSLStartMode](#sslstartmode-property-as1receiver-module) property. Note that it is not necessary to explicitly connect to an SMTP server for outgoing mail; a connection will be created and destroyed each time a mail is sent. # CreateMDNReceipt Method ([AS1Receiver](#as1receiver-module) Module) Creates MDNReceipt . ## Syntax ```text public func createMDNReceipt(headers: String, mdn: String, message: String) throws -> Void ``` ## Remarks **CreateMDNReceipt** may be invoked after [ParseRequest](#parserequest-method-as1receiver-module) 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-as1receiver-module). This method populates [MDNReceipt](#mdnreceipt-property-as1receiver-module) 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. # DeleteMessage Method ([AS1Receiver](#as1receiver-module) Module) Deletes the message specified by MailMessageNumber . ## Syntax ```text public func deleteMessage() throws -> Void ``` ## Remarks Requests that the [MailServer](#mailserver-property-as1receiver-module) delete the message specified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module). The message will not actually be deleted until the connection is closed. # Disconnect Method ([AS1Receiver](#as1receiver-module) Module) Disconnects from the incoming mail server. ## Syntax ```text public func disconnect() throws -> Void ``` ## Remarks Disconnects from the incoming mail server specified by [MailServer](#mailserver-property-as1receiver-module). # ParseRequest Method ([AS1Receiver](#as1receiver-module) Module) Parses the EDI message and determines the EDIData . ## Syntax ```text public func parseRequest() throws -> Void ``` ## Remarks Processes the EDI message in the request (either from the HTTP context, or as given by [Request](#request-property-as1receiver-module) and possibly [RequestHeadersString](#requestheadersstring-property-as1receiver-module)). If the message is encrypted, it will be decrypted with the certificate specified in [Certificate](#certificate-property-as1receiver-module). If it is signed, the signature will be verified against the certificate specified in [SignerCert](#signercert-property-as1receiver-module). If the message is scanned without difficulty, [EDIData](#edidata-property-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) to be determined. If any errors occur, an exception will be thrown and the [ScanResult](#scanresult-property-as1receiver-module) property will reflect the error condition. Whether or not an exception is thrown, an [MDNReceipt](#mdnreceipt-property-as1receiver-module) may be generated by invoking [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module). In the case of a successful scan [MDNReceipt](#mdnreceipt-property-as1receiver-module) will report the success, otherwise the receipt will provide information to the client about the error. [ProcessRequest](#processrequest-method-as1receiver-module) may be used to scan and create the receipt in one step. [ReadRequest](#readrequest-method-as1receiver-module) may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner. # ProcessQueue Method ([AS1Receiver](#as1receiver-module) Module) Send the messages queued for sending. ## Syntax ```text public func processQueue(directory: String) throws -> Void ``` ## Remarks Invoking ProcessQueue sends the messages that have been queued by [Queue](#queue-method-as1receiver-module). # ProcessRequest Method ([AS1Receiver](#as1receiver-module) Module) Processes the EDI data, and generates the receipt. ## Syntax ```text public func processRequest() throws -> Void ``` ## Remarks Invoking **ProcessRequest** automates the entire AS2 server process. The method scans the request, determines the [EDIData](#edidata-property-as1receiver-module), and generates the [MDNReceipt](#mdnreceipt-property-as1receiver-module). In a server environment the receipt may be returned by invoking [SendResponse](#sendresponse-method-as1receiver-module). The method's functionality is the same as the combined functionality of [ParseRequest](#parserequest-method-as1receiver-module) and [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module). The method's operation is controlled by [ErrorProcessingFlags](#ErrorProcessingFlags) and [ErrorReportingFlags](#ErrorReportingFlags), and [ScanResult](#scanresult-property-as1receiver-module) will be populated as in [ParseRequest](#parserequest-method-as1receiver-module). The method will throw an exception, as [ParseRequest](#parserequest-method-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) will provide more detail on the cause of the error. The class will populate [EDIData](#edidata-property-as1receiver-module) if no errors occurred scanning the request, or if [ErrorProcessingFlags](#ErrorProcessingFlags) had been previously configured to allow the error. # QueryMessageSize Method ([AS1Receiver](#as1receiver-module) Module) Returns the size in bytes of the current message. ## Syntax ```text public func queryMessageSize() throws -> Int32 ``` ## Remarks This method queries the server for the size in bytes of the message specified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module). The method returns the size (in bytes) of the message. # QueryMessageUID Method ([AS1Receiver](#as1receiver-module) Module) Returns the unique identifier of the message as specified by the server. ## Syntax ```text public func queryMessageUID() throws -> String ``` ## Remarks This method returns the unique identifier of the message specified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module). # Queue Method ([AS1Receiver](#as1receiver-module) Module) Prepares and queues the message to the specified directory. ## Syntax ```text public func queue(directory: String) throws -> Void ``` ## Remarks Invoking Queue will prepare and queue the AS1 message. It will be signed if SigningCert is set, encrypted if RecipientCert is set, and compressed if [CompressionFormat](#compressionformat-property-as1receiver-module) is set. A receipt will be requested if [MDNTo](#mdnto-property-as1receiver-module) is set. The queued message can then be sent by invoking [ProcessQueue](#processqueue-method-as1receiver-module). # ReadRequest Method ([AS1Receiver](#as1receiver-module) Module) Reads the AS1 request from the mail server. ## Syntax ```text public func readRequest() throws -> Void ``` ## Remarks In the **Java** edition, ReadRequest will retrieve the file specified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module) from the mail server. The request will be stored in [Request](#request-property-as1receiver-module) and the headers in [RequestHeaders](#requestheaders-property-as1receiver-module). The headers will also be parsed as in ParseHeaders, and the appropriate values of [From](#from-property-as1receiver-module), [SendTo](#sendto-property-as1receiver-module), etc., will be populated. After looking up and setting your trading partner information (such as certificates) you may then call [ProcessRequest](#processrequest-method-as1receiver-module). # Reset Method ([AS1Receiver](#as1receiver-module) Module) Resets the state of the control. ## Syntax ```text public func reset() throws -> Void ``` ## Remarks **Reset** resets the state of the class. All properties will be set to their default values. # SelectMailMessage Method ([AS1Receiver](#as1receiver-module) Module) Selects and obtains information about the specified message. ## Syntax ```text public func selectMailMessage() throws -> Void ``` ## Remarks This method selects the message specified by [MailMessageNumber](#mailmessagenumber-property-as1receiver-module) and retrieves information about it. After calling this method properties such as [MailMessageHeaders](#mailmessageheaders-property-as1receiver-module), [MailMessageDate](#mailmessagedate-property-as1receiver-module), [MailMessageFrom](#mailmessagefrom-property-as1receiver-module), etc., allow you to determine if this message is an AS1 message. Additional properties are exposed via the [Config](#config-method-as1receiver-module) method. If this message is an AS1 transmission, you may use [ReadRequest](#readrequest-method-as1receiver-module) to read it. The [Request](#request-property-as1receiver-module) and [RequestHeaders](#requestheaders-property-as1receiver-module) properties will contain the request and request headers, and [From](#from-property-as1receiver-module) will be populated with the originator of the request. You may then set trading partner information and invoke [ProcessRequest](#processrequest-method-as1receiver-module) to process the request. # SendResponse Method ([AS1Receiver](#as1receiver-module) Module) Sends the MDN receipt. ## Syntax ```text public func sendResponse() throws -> Void ``` ## Remarks Sends the MDN receipt specified by [MDNReceipt](#mdnreceipt-property-as1receiver-module). The receipt will be created when invoking [ProcessRequest](#processrequest-method-as1receiver-module) or [CreateMDNReceipt](#createmdnreceipt-method-as1receiver-module). By default, the class will assume that the SMTP server is located at the same address as the incoming mail server. The [SMTPServer](#SMTPServer) and [SMTPPort](#SMTPPort) settings can be used to set a different address or to use a non default port. A response will only be sent if requested by the client. The MDN will be directed to the [From](#from-property-as1receiver-module) address that sent the request, regardless of the [MDNTo](#mdnto-property-as1receiver-module) value. If [MDNTo](#mdnto-property-as1receiver-module) is empty, this method will do nothing. # ConnectionStatus Event ([AS1Receiver](#as1receiver-module) Module) Fired to indicate changes in the connection state. ## Syntax ```text func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String) ``` ## 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. # EndTransfer Event ([AS1Receiver](#as1receiver-module) Module) Fired when the message text completes transferring. ## Syntax ```text func onEndTransfer() ``` ## Remarks Fired when the message text completes transferring (on either a send or receive). # Error Event ([AS1Receiver](#as1receiver-module) Module) Fired when information is available about errors during data delivery. ## Syntax ```text func onError(errorCode: Int32, description: String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-as1receiver-module) section. # Header Event ([AS1Receiver](#as1receiver-module) Module) This event is fired for every message header being retrieved. ## Syntax ```text func onHeader(field: String, value: String) ``` ## Remarks The *Field* parameter contains the name of the header (in the same case as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # LaunchBrowser Event ([AS1Receiver](#as1receiver-module) Module) Fires before launching a browser with the authorization URL. ## Syntax ```text func onLaunchBrowser(url: inout String, command: inout String) ``` ## Remarks When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the class will fire this event with the *Command*, which will be executed by the class. The *URL* parameter will be the authorization URL that the user will be directed to authenticate. Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end. In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to: - edit - explore - find - open - print # Log Event ([AS1Receiver](#as1receiver-module) Module) Fired with log information while processing a message. ## Syntax ```text func onLog(logType: String, logMessage: Data) ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" 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-as1receiver-module). 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-as1receiver-module) (i.e. when [LogDirectory](#logdirectory-property-as1receiver-module) 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 ([AS1Receiver](#as1receiver-module) Module) This event traces the commands sent to the mail server, and the respective replies. ## Syntax ```text func onPITrail(direction: Int32, message: String) ``` ## Remarks The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers. 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 ([AS1Receiver](#as1receiver-module) Module) This event is fired during verification of the signed message. ## Syntax ```text func onSignerCertInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, certEncoded: Data) ``` ## 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-as1receiver-module) 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-as1receiver-module) 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 ([AS1Receiver](#as1receiver-module) Module) Fired after the server presents its certificate to the client. ## Syntax ```text func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool) ``` ## 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 ([AS1Receiver](#as1receiver-module) Module) Fired when secure connection progress messages are available. ## Syntax ```text func onSSLStatus(message: String) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AS1Receiver](#as1receiver-module) Module) Fired when the message text starts transferring (on either a send or receive). ## Syntax ```text func onStartTransfer() ``` ## Remarks Fired when the message text starts transferring (on either a send or receive). # Transfer Event ([AS1Receiver](#as1receiver-module) Module) Fired while the message text gets transferred to or from MailServer . ## Syntax ```text func onTransfer(bytesTransferred: Int64) ``` ## Remarks Fired while the message text gets transferred to or from [MailServer](#mailserver-property-as1receiver-module). # 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) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **effectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **expirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **extendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **fingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **fingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **privateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **privateKeyAvailable** *Bool (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **privateKeyContainer** *String (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **publicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **publicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **publicKeyLength** *Int32 (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. **storeB** *Data* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **storePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **storeType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **subjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **thumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **usage** *String (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **usageFlags** *Int32 (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **encodedB** *Data* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors *Swift Syntax* ```text public init() ``` Creates a instance whose properties can be set. *Swift Syntax* ```text public init(encoded: ) ``` Parses * Encoded * as an X.509 public key. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , 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 component 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. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , 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 component 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. # 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) - [Name](#EDIAttachment_f_Name) ## Fields **contentType** *String* *Default Value: ""* The MIME content-type of this [EDIAttachment](#ediattachment-type). **dataB** *Data* *Default Value: ""* This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. **data** *String* *Default Value: ""* This property contains the attachment data. In a receiver, the class decodes the attachment to the property when 's value is first queried. This property will contain the full decrypted text of the attachment. **fileName** *String* *Default Value: ""* The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the . **headers** *String* *Default Value: ""* The class fills out each time any of the other properties for that [EDIAttachment](#ediattachment-type) are changed. If additional headers are needed they should be appended after all the other properties for that [EDIAttachment](#ediattachment-type) are set. **name** *String* *Default Value: ""* is the final name to be associated with the contents of either the or properties. This corresponds to the *filename* attribute of the *Content-Disposition* header for this attachment. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(fileName: ) ``` *Swift Syntax* ```text public init(fileName: , contentType: ) ``` *Swift Syntax* ```text public init(fileName: , contentType: , 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) - [Name](#EDIData_f_Name) - [FileName](#EDIData_f_FileName) ## Fields **dataB** *Data* *Default Value: ""* This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **data** *String* *Default Value: ""* This property contains the EDI payload of the transmission. In a receiver, this property will only be populated if IncomingDirectory and have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **ediType** *String* *Default Value: ""* The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml". **name** *String* *Default Value: "rfc1767.edi"* is the final name to be associated with the contents of either the or properties. This corresponds to the *filename* attribute of the *Content-Disposition* header for the EDI payload. When constructing EDI data to be sent, will be set to the same value as , but can be overridden after setting to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. **fileName** *String* *Default Value: ""* In a sender, if is specified, the file specified will be used for the EDI payload of the transmission. will be populated with the name of the file. In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents. Note: When is set, the data will be written to the stream and this property will not be populated. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(data: , eDIType: ) ``` *Swift Syntax* ```text public init(fileName: , eDIType: ) ``` # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the . The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **autoDetect** *Bool* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **firewallType** *FirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. | **host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class . **password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . **port** *Int32* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details. NOTE: This property is set automatically when is set to a valid value. See the description of the property for details. **user** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class . ## Constructors *Swift Syntax* ```text public init() ``` # 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 , and its corresponding . The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(field: , value: ) ``` # MailOAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the class the necessary information needed to complete the OAuth process. The following fields are available: - [AccessToken](#MailOAuthSettings_f_AccessToken) - [AuthorizationScope](#MailOAuthSettings_f_AuthorizationScope) - [ClientId](#MailOAuthSettings_f_ClientId) - [ClientSecret](#MailOAuthSettings_f_ClientSecret) - [RefreshToken](#MailOAuthSettings_f_RefreshToken) - [ReturnURL](#MailOAuthSettings_f_ReturnURL) - [ServerAuthURL](#MailOAuthSettings_f_ServerAuthURL) - [ServerTokenURL](#MailOAuthSettings_f_ServerTokenURL) ## Fields **accessToken** *String* *Default Value: ""* The access token returned by the authorization server. This is set when the class makes a request to the token server. **authorizationScope** *String* *Default Value: ""* The scope request or response parameter used during authorization. **clientId** *String* *Default Value: ""* The id of the client assigned when registering the application. **clientSecret** *String* *Default Value: ""* The secret value for the client assigned when registering the application. **refreshToken** *String* *Default Value: ""* Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens. **returnURL** *String* *Default Value: ""* The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. **serverAuthURL** *String* *Default Value: ""* The URL of the authorization server. **serverTokenURL** *String* *Default Value: ""* The URL of the token server used to obtain the access token. ## Constructors *Swift Syntax* ```text public init() ``` # 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 **contentB** *Data* *Default Value: ""* This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **content** *String* *Default Value: ""* This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable (Message Disposition Notification) and a human readable , which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **headerCount** *Int32 (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** *Int32* *Default Value: 0* Which MDN header is currently selected to populate and . Valid values are 0 to - 1. **headers** *String* *Default Value: ""* **Headers** contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as *AS2-From*, *AS2-To*, *Date*, *Content-Type*, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option). You can also use , , , and to easily iterate through each individual header. **headerValue** *String (read-only)* *Default Value: ""* The value of the MDN header currently selected by . **mdn** *String (read-only)* *Default Value: ""* **MDN** will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant. **message** *String (read-only)* *Default Value: ""* The human-readable portion of the MDN receipt. The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered. **micValue** *String (read-only)* *Default Value: ""* The Message Integrity Check(s) (one-way hash) of the original EDI message. An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed. The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` . **signingProtocol** *String (read-only)* *Default Value: ""* This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this [MDNReceipt](#mdnreceipt-type). It will contain an empty string if the receipt is unsigned. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(headers: , content: ) ``` # Config Settings ([AS1Receiver](#as1receiver-module) Module) 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-as1receiver-module) method. ### AS1Receiver Config Settings **FileName**: The filename of the EDI Data.This is a read only setting that gives the filename of the content received. ### AS1 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. **POPPort**: The POP mail port to be used, if different than MailServer.The mail port to be used for POP (or POP/S). For implicit SSL, use port 995. **POPServer**: The POP server to be used, if different than MailServer.The mail server to be used for POP (or POP/S), in case different than **MailServer**. **SMTPAuthMechanism**: The authentication mechanism used to connect to the SMTP server.By default, **SMTPAuthMechanism** is set to 0, which sends the AUTH command is **SMTPUser** and **SMTPPassword** are set. **SMTPAuthMechanism** can be set to 1 to use the more secure CRAM-MD5 authentication command. **SMTPPassword**: The password used for authentication.If SMTPPassword is set to a non empty string, then when connecting to the **SMTPServer** an AUTH or CRAM-MD5 (depending on **SMTPAuthMechanism**) command is sent for user authentication. **SMTPPort**: The SMTP mail port to be used, if different than MailServer.The mail port to be used for SMTP (or POP/S). For implicit SSL, use port 465. **SMTPServer**: The SMTP server to be used, if different than MailServer.The mail server to be used for SMTP (or SMTP/S), in case different than **MailServer**. **SMTPSSLStartMode**: Determines how SSL negotiation starts with the SMTP server.0 **ssl Automatic** 1 **ssl Implicit** 2 **ssl Explicit** 3 **ssl None** Default These modes have the same interpretation as defined by the property **SSLStartMode**. **SMTPUser**: The user name used for authentication.If SMTPUser is set to a non empty string, then when connecting to the **SMTPServer** an AUTH or CRAM-MD5 (depending on **SMTPAuthMechanism**) command is sent for user authentication. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-as1receiver-module) 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-as1receiver-module) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-as1receiver-module) 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 . 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 . 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-as1receiver-module) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) 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-as1receiver-module) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-as1receiver-module) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-as1receiver-module) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-as1receiver-module) 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 ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors ([AS1Receiver](#as1receiver-module) Module) *Note: The starred errors may be ignored by configuring the [ErrorProcessingFlags](#ErrorProcessingFlags) and [ErrorReportingFlags](#ErrorReportingFlags) of the class.* ### AS1Receiver Errors | | | | --- | --- | | 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. | ### POP Errors | | | | --- | --- | | 116 | MailPort cannot be zero. Please specify a valid service port number. | | 118 | Firewall error. Error message contains detailed description. | | 171 | POP protocol error. Description contains the server reply. | | 172 | Error communicating with server. Error text is attached. | | 173 | Please specify a valid [MailServer](#mailserver-property-as1receiver-module). | | 174 | Busy executing current method. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost 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-as1receiver-module) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### SMTP Errors | | | | --- | --- | | 118 | Firewall Error. Error message contains detailed description. | | 161 | SMTP protocol error. Description contains the server reply. | | 162 | Error communicating with server. Error text is attached. | | 163 | Please specify a [MailServer](#mailserver-property-as1receiver-module). | | 164 | Please specify a sender ([From](#from-property-as1receiver-module)). | | 165 | Please specify a recipient. | | 166 | Busy executing current method. | | 301 | Operation interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost 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-as1receiver-module) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### SMIME Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. |