# AS1Sender Component The AS1Sender component implements an AS1 / EDI-INT client, capable of sending EDI messages over electronic mail. ## Syntax ```text nsoftware.IPWorksEDI.AS1Sender ``` ## Remarks The AS1Sender component is used to send EDI or other messages over SMTP/S, using the AS1 protocol specified in RFC 3335. The component is also used to retrieve and verify server responses. A typical AS1 transaction is as follows: (1) The sender sends an EDI document to the receiver using SMTP or SMTPS. Typically the document will be signed and encrypted (particularly if TLS/SSL is not used). A signed receipt will also be requested. (2) The receiver decrypts the message and verifies the signature. (3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message. **When sending an EDI message**, the client should specify, at a minimum, [From](#from-property-as1sender-component) and [SendTo](#sendto-property-as1sender-component), [MailServer](#mailserver-property-as1sender-component), and [Data](#EDIData_f_Data) and [EDIType](#EDIData_f_EDIType). The [Send](#send-method-as1sender-component) method should then be invoked. **To secure the EDI transmission**, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the component will apply message security if the appropriate certificates are specified. To sign the data set [SigningCert](#signingcert-property-as1sender-component). To encrypt, set [RecipientCerts](#recipientcerts-property-as1sender-component). **TLS/SSL** will also be used if [SSLStartMode](#sslstartmode-property-as1sender-component) is set. In case your trading partner is using a self-signed certificate with their mail server it will be necessary to set [SSLAcceptServerCert](#sslacceptservercert-property-as1sender-component) or trap the [SSLServerAuthentication](#sslserverauthentication-event-as1sender-component) event to accept the certificate. The message may also be **compressed** by setting [CompressionFormat](#compressionformat-property-as1sender-component). **To request a receipt**, or Message Disposition Notification (MDN), simply set the [MDNTo](#mdnto-property-as1sender-component) property. The MDN will be returned in a separate email response. The [MDNOptions](#mdnoptions-property-as1sender-component) property may be used to customize the request. By default, the component will request a signed MDN over an SHA1 hash. **Validating AS1 MDNs** AS1 MDNs are returned asynchronously in a separate email. Generally MDNs will not be returned immediately. The component supports the use of the POP/S protocol for receiving e-mail. To receive an MDN, set the [MailServer](#mailserver-property-as1sender-component), [User](#user-property-as1sender-component), and [Password](#password-property-as1sender-component) properties, and call [Connect](#connect-method-as1sender-component). At this point you may search your mailbox using the **MailMessage** properties; when you have found the appropriate message you should invoke [ReadReceipt](#readreceipt-method-as1sender-component), which will set [MDNReceipt](#mdnreceipt-property-as1sender-component). If the receipt is indeed an MDN it will also be parsed (although not verified) and [MessageId](#messageid-property-as1sender-component) will be set. If the message is not an MDN an exception will be thrown. You should then use the values of [From](#from-property-as1sender-component) and [MessageId](#messageid-property-as1sender-component) to look up your trading partner's certificates, the [MDNOptions](#mdnoptions-property-as1sender-component) requested, and the [OriginalContentMIC](#originalcontentmic-property-as1sender-component) calculated when you sent the original message (you *must* store this value externally to verify signed receipts). Finally, invoke [VerifyReceipt](#verifyreceipt-method-as1sender-component). ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Attachments](#attachments-property-as1sender-component) | Collection of files attached to the current message. | | [CompressionFormat](#compressionformat-property-as1sender-component) | The compression format (if any) to use. | | [Connected](#connected-property-as1sender-component) | Whether the component is connected. | | [EDIData](#edidata-property-as1sender-component) | The EDI or other data to be sent. | | [EncryptionAlgorithm](#encryptionalgorithm-property-as1sender-component) | The algorithm used to encrypt the EDI data. | | [Firewall](#firewall-property-as1sender-component) | A set of properties related to firewall access. | | [From](#from-property-as1sender-component) | The sender of the original message. | | [LocalHost](#localhost-property-as1sender-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LogDirectory](#logdirectory-property-as1sender-component) | The path to a directory for logging. | | [LogFile](#logfile-property-as1sender-component) | The log file written. | | [MailMessageCc](#mailmessagecc-property-as1sender-component) | The value of the Cc header of the mail message. | | [MailMessageCount](#mailmessagecount-property-as1sender-component) | The number of messages waiting in the mailbox. | | [MailMessageDate](#mailmessagedate-property-as1sender-component) | The message date for the currently selected message. | | [MailMessageFrom](#mailmessagefrom-property-as1sender-component) | The sender of the mail message. | | [MailMessageHeaders](#mailmessageheaders-property-as1sender-component) | The message headers for the currently selected message. | | [MailMessageNumber](#mailmessagenumber-property-as1sender-component) | The message number on the incoming mail server. | | [MailMessageReplyTo](#mailmessagereplyto-property-as1sender-component) | The value of the ReplyTo header of the mail message. | | [MailMessageSubject](#mailmessagesubject-property-as1sender-component) | The subject of the mail message. | | [MailMessageText](#mailmessagetext-property-as1sender-component) | The text of the mail message. | | [MailMessageTo](#mailmessageto-property-as1sender-component) | The recipient of the mail message. | | [MailServer](#mailserver-property-as1sender-component) | The address of your mail server. | | [MDNOptions](#mdnoptions-property-as1sender-component) | Used to indicate the options requested for the MDN receipt. | | [MDNReceipt](#mdnreceipt-property-as1sender-component) | The MDN receipt returned from the server. | | [MDNTo](#mdnto-property-as1sender-component) | The system to which an MDN should be directed. | | [MessageId](#messageid-property-as1sender-component) | The Id of the message. | | [OAuth](#oauth-property-as1sender-component) | The OAuth settings. | | [OriginalContentMIC](#originalcontentmic-property-as1sender-component) | The Message Integrity Check(s) (one-way hash) of the outgoing message. | | [Password](#password-property-as1sender-component) | The password for your incoming mail server. | | [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) | The public key certificate for the MDN receipt signature. | | [RecipientCerts](#recipientcerts-property-as1sender-component) | The public key certificates of the recipients for this message. | | [SendTo](#sendto-property-as1sender-component) | The recipient of the message. | | [SignatureAlgorithm](#signaturealgorithm-property-as1sender-component) | Signature algorithm to be used in outgoing messages. | | [SigningCert](#signingcert-property-as1sender-component) | Contains the certificate to use when signing messages. | | [SSLAcceptServerCert](#sslacceptservercert-property-as1sender-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-as1sender-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-as1sender-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-as1sender-component) | The server certificate for the last established connection. | | [SSLStartMode](#sslstartmode-property-as1sender-component) | Determines how the component starts the SSL negotiation. By default, SSL will not be used. | | [Subject](#subject-property-as1sender-component) | The subject of the message. | | [User](#user-property-as1sender-component) | The username for your incoming mail server. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-as1sender-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-as1sender-component) | Connects to the incoming mail server. | | [DeleteMessage](#deletemessage-method-as1sender-component) | Deletes the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component) . | | [Disconnect](#disconnect-method-as1sender-component) | Disconnects from the incoming mail server. | | [ProcessQueue](#processqueue-method-as1sender-component) | Send the messages queued for sending. | | [QueryMessageSize](#querymessagesize-method-as1sender-component) | Returns the size in bytes of the current message. | | [QueryMessageUID](#querymessageuid-method-as1sender-component) | Returns the unique identifier of the message as specified by the server. | | [Queue](#queue-method-as1sender-component) | Prepares and queues the message to the specified directory. | | [ReadReceipt](#readreceipt-method-as1sender-component) | Reads and parses (but does not verify) an MDN receipt. | | [Reset](#reset-method-as1sender-component) | Resets the state of the control. | | [SelectMailMessage](#selectmailmessage-method-as1sender-component) | Selects and obtains information about the specified message. | | [Send](#send-method-as1sender-component) | Prepares and sends the AS1 message. | | [SetRequestHeader](#setrequestheader-method-as1sender-component) | Allows the user to set or add arbitrary HTTP request headers. | | [VerifyReceipt](#verifyreceipt-method-as1sender-component) | Verifies an MDN receipt. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ConnectionStatus](#connectionstatus-event-as1sender-component) | Fired to indicate changes in the connection state. | | [EndTransfer](#endtransfer-event-as1sender-component) | Fired when the message text completes transferring. | | [Error](#error-event-as1sender-component) | Fired when information is available about errors during data delivery. | | [Header](#header-event-as1sender-component) | This event is fired for every message header being retrieved. | | [LaunchBrowser](#launchbrowser-event-as1sender-component) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-as1sender-component) | Fired with log information while processing a message. | | [PITrail](#pitrail-event-as1sender-component) | This event traces the commands sent to the mail server, and the respective replies. | | [SSLServerAuthentication](#sslserverauthentication-event-as1sender-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-as1sender-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-as1sender-component) | Fired when the message text starts transferring (on either a send or receive). | | [Transfer](#transfer-event-as1sender-component) | Fired while the message text gets transferred to or from [MailServer](#mailserver-property-as1sender-component) . | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [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. | | [CACertFilePaths](#CACertFilePaths) | The paths to CA certificate files when using Mono on Unix/Linux. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [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. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # Attachments Property ([AS1Sender](#as1sender-component) Component) Collection of files attached to the current message. ## Syntax ```text public EDIAttachmentList Attachments { get; } ``` ## Remarks When a call to [Send](#send-method-as1sender-component) is made, the component will attach the files referenced by each [EDIAttachment](#ediattachment-type) in this collection to the [EDIData](#edidata-property-as1sender-component). This property is not available at design time. Please refer to the [EDIAttachment](#ediattachment-type) type for a complete list of fields. # CompressionFormat Property ([AS1Sender](#as1sender-component) Component) The compression format (if any) to use. ## Syntax ```text public AS1SenderCompressionFormats CompressionFormat { get; set; } enum AS1SenderCompressionFormats { cfNone, cfZLIB } ``` ## Default Value 0 ## Remarks By default, outgoing data will not be compressed. Setting this property will instruct the component to compress the outgoing data using the indicated format. Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required. The compression algorithm used is **Zlib**, as required by RFC 3274 and defined in RFCs 1950 and 1951. # Connected Property ([AS1Sender](#as1sender-component) Component) Whether the component is connected. ## Syntax ```text public bool Connected { get; } ``` ## Default Value False ## Remarks This property is used to determine whether or not the component is connected to the remote host. Use the [Connect](#connect-method-as1sender-component) and [Disconnect](#disconnect-method-as1sender-component) methods to manage the connection. This property is read-only and not available at design time. # EDIData Property ([AS1Sender](#as1sender-component) Component) The EDI or other data to be sent. ## Syntax ```text public EDIData EDIData { get; set; } ``` ## Remarks The EDI message to send. This property is not available at design time. Please refer to the [EDIData](#edidata-type) type for a complete list of fields. # EncryptionAlgorithm Property ([AS1Sender](#as1sender-component) Component) The algorithm used to encrypt the EDI data. ## Syntax ```text public string EncryptionAlgorithm { get; set; } ``` ## Default Value "AESCBC256" ## Remarks If [RecipientCerts](#recipientcerts-property-as1sender-component) contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted. The component supports **"AESCBC256"**, or industry-standard 256-bit AES-CBC encryption, by default. The component supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 (default) - AESGCM128 - AESGCM192 - AESGCM256 # Firewall Property ([AS1Sender](#as1sender-component) Component) A set of properties related to firewall access. ## Syntax ```text public Firewall Firewall { get; set; } ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # From Property ([AS1Sender](#as1sender-component) Component) The sender of the original message. ## Syntax ```text public string From { get; set; } ``` ## Default Value "" ## Remarks The sender of the original message. The recipient is given by [SendTo](#sendto-property-as1sender-component). Note that From and [SendTo](#sendto-property-as1sender-component) 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-as1sender-component) indicates the *sender* of the MDN. # LocalHost Property ([AS1Sender](#as1sender-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public string LocalHost { 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 component initiate connections (or accept in the case of server components) 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 component 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 ([AS1Sender](#as1sender-component) Component) The path to a directory for logging. ## Syntax ```text public string LogDirectory { 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 component will log the original EDI data, the complete text of the outgoing request and the incoming response. The component 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 component 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 component. 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-as1sender-component) 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 ([AS1Sender](#as1sender-component) Component) The log file written. ## Syntax ```text public string LogFile { get; } ``` ## Default Value "" ## Remarks In case [LogDirectory](#logdirectory-property-as1sender-component) 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 ([AS1Sender](#as1sender-component) Component) The value of the Cc header of the mail message. ## Syntax ```text public string MailMessageCc { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will be populated with the value of the Cc header of the mail message. This property is read-only. # MailMessageCount Property ([AS1Sender](#as1sender-component) Component) The number of messages waiting in the mailbox. ## Syntax ```text public int MailMessageCount { get; } ``` ## Default Value 0 ## Remarks When the component 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-as1sender-component) to any value between 1 and MailMessageCount to inspect a given message. This property is read-only. # MailMessageDate Property ([AS1Sender](#as1sender-component) Component) The message date for the currently selected message. ## Syntax ```text public string MailMessageDate { 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 ([AS1Sender](#as1sender-component) Component) The sender of the mail message. ## Syntax ```text public string MailMessageFrom { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will be populated. When processing AS1 transmissions, this will correspond to [From](#from-property-as1sender-component). When processing MDNs, this will correspond to [SendTo](#sendto-property-as1sender-component). This property is read-only. # MailMessageHeaders Property ([AS1Sender](#as1sender-component) Component) The message headers for the currently selected message. ## Syntax ```text public string MailMessageHeaders { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will contain the full headers of the mail message as reported by the mail server. This property is read-only. # MailMessageNumber Property ([AS1Sender](#as1sender-component) Component) The message number on the incoming mail server. ## Syntax ```text public int MailMessageNumber { get; set; } ``` ## Default Value 0 ## Remarks MailMessageNumber specifies a number between 1 and [MailMessageCount](#mailmessagecount-property-as1sender-component), and serves as a message pointer to an incoming mail message. Set this property before calling [SelectMailMessage](#selectmailmessage-method-as1sender-component), [QueryMessageSize](#querymessagesize-method-as1sender-component) or [QueryMessageUID](#querymessageuid-method-as1sender-component). This property is not available at design time. # MailMessageReplyTo Property ([AS1Sender](#as1sender-component) Component) The value of the ReplyTo header of the mail message. ## Syntax ```text public string MailMessageReplyTo { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will be populated with the value of the ReplyTo header of the mail message. This property is read-only. # MailMessageSubject Property ([AS1Sender](#as1sender-component) Component) The subject of the mail message. ## Syntax ```text public string MailMessageSubject { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will be populated with the subject of the mail message. This property is read-only. # MailMessageText Property ([AS1Sender](#as1sender-component) Component) The text of the mail message. ## Syntax ```text public string MailMessageText { get; } ``` ## Default Value "" ## Remarks The text of the mail message identified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component), if it has been downloaded from the server. To read the message, invoke ReadRequest (receiver) or [ReadReceipt](#readreceipt-method-as1sender-component) (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 ([AS1Sender](#as1sender-component) Component) The recipient of the mail message. ## Syntax ```text public string MailMessageTo { get; } ``` ## Default Value "" ## Remarks After calling [SelectMailMessage](#selectmailmessage-method-as1sender-component) this property will be populated with the recipient of the mail message. This property is read-only. # MailServer Property ([AS1Sender](#as1sender-component) Component) The address of your mail server. ## Syntax ```text public string MailServer { get; set; } ``` ## Default Value "" ## Remarks The address of your mail server. By default, the component will send outgoing mail via SMTP, and receive incoming mail via POP. Moreover, the component 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-as1sender-component). Note that if SSL is used for sending but not receiving, or vice versa, you should set [SSLStartMode](#sslstartmode-property-as1sender-component) each time you send or receive a file. # MDNOptions Property ([AS1Sender](#as1sender-component) Component) Used to indicate the options requested for the MDN receipt. ## Syntax ```text public string MDNOptions { get; set; } ``` ## Default Value "signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256" ## Remarks By default, the component will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard. Set MDNOptions to an empty string to request an unsigned receipt. This property will automatically be updated when [SignatureAlgorithm](#signaturealgorithm-property-as1sender-component) is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value. The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm. When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed in the requested MIC algorithms. SHA-256, SHA-384, or SHA-512 are recommended instead. # MDNReceipt Property ([AS1Sender](#as1sender-component) Component) The MDN receipt returned from the server. ## Syntax ```text public MDNReceipt MDNReceipt { get; set; } ``` ## Remarks This property will contain an instance of [MDNReceipt](#mdnreceipt-type) with the complete MDN receipt returned from the AS2 receiver. The receipt will be a signed or unsigned multipart/report in MIME format. For synchronous MDN requests, this property is populated automatically after the call to Post. If an asynchronous MDN is sent over HTTP, it may be read from the HTTP context by calling ReadAsyncReceipt, or it may be set manually. When MDNReceipt is set to a valid MDN receipt, the originator of the receipt will be stored in AS2To, the intended recipient (presumably your system) will be stored in AS2From, and the original message ID will be stored in [MessageId](#messageid-property-as1sender-component). If you are processing a MDN receipt asynchronously, you can use the values to look up the original message and validate the receipt. Set the [OriginalContentMIC](#originalcontentmic-property-as1sender-component), [MDNOptions](#mdnoptions-property-as1sender-component), and [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) to the values originally computed when the message was sent (if you are requesting async MDNs you must save this information externally.). You can then validate the asynchronous receipt by invoking [VerifyReceipt](#verifyreceipt-method-as1sender-component). Alternatively, AsyncMDNInfoDir may be set in place of [OriginalContentMIC](#originalcontentmic-property-as1sender-component), [MessageId](#messageid-property-as1sender-component), and [MDNOptions](#mdnoptions-property-as1sender-component) (provided it was set to the same value when the message was sent). If AsyncMDNInfoDir was specified when the message was sent, the component would have saved [OriginalContentMIC](#originalcontentmic-property-as1sender-component) and [MDNOptions](#mdnoptions-property-as1sender-component) to a file identified by the [MessageId](#messageid-property-as1sender-component) for the transmission. These properties are read from the file matching the [MessageId](#messageid-property-as1sender-component) in the MDNReceipt automatically if AsyncMDNInfoDir is specified. NOTE: MDNReceipt must be populated prior to calling [VerifyReceipt](#verifyreceipt-method-as1sender-component). Please refer to the [MDNReceipt](#mdnreceipt-type) type for a complete list of fields. # MDNTo Property ([AS1Sender](#as1sender-component) Component) The system to which an MDN should be directed. ## Syntax ```text public string MDNTo { get; set; } ``` ## Default Value "" ## Remarks If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. This should be set to a valid email address, and would typically be the same as the [From](#from-property-as1sender-component) address. By default, the component will request a PKCS#7 signature signed over SHA-256. This can be customized by specifying [MDNOptions](#mdnoptions-property-as1sender-component). # MessageId Property ([AS1Sender](#as1sender-component) Component) The Id of the message. ## Syntax ```text public string MessageId { get; set; } ``` ## Default Value "" ## Remarks The Id format is as in RFC 2822: *id-left@id-right*. **In AS1**, customizing the MessageId is **not supported**. An appropriate MessageId will be generated by the component for each outgoing message. You should record this value after sending this value, and set it again when you verify the receipt. This property is not available at design time. # OAuth Property ([AS1Sender](#as1sender-component) Component) The OAuth settings. ## Syntax ```text public MailOAuthSettings OAuth { get; } ``` ## Remarks This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information. This property is read-only and not available at design time. Please refer to the [MailOAuthSettings](#mailoauthsettings-type) type for a complete list of fields. # OriginalContentMIC Property ([AS1Sender](#as1sender-component) Component) The Message Integrity Check(s) (one-way hash) of the outgoing message. ## Syntax ```text public string OriginalContentMIC { get; set; } ``` ## Default Value "" ## Remarks A MIC will be calculated over the outgoing message using the same algorithm in the [SignatureAlgorithm](#signaturealgorithm-property-as1sender-component) configuration used to sign the message. The property will be set when Post (in AS3, [Send](#send-method-as1sender-component)) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs. The format is in RFC 3335, i.e. ```plaintext w7AguNJEmhF/qIjJw6LnnA==, md5 ``` , with a newline at the end. If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use AsyncMDNInfoDir). # Password Property ([AS1Sender](#as1sender-component) Component) The password for your incoming mail server. ## Syntax ```text public string Password { get; set; } ``` ## Default Value "" ## Remarks The password for your incoming mail server. Set this before invoking [Connect](#connect-method-as1sender-component). # ReceiptSignerCert Property ([AS1Sender](#as1sender-component) Component) The public key certificate for the MDN receipt signature. ## Syntax ```text public Certificate ReceiptSignerCert { get; set; } ``` ## Remarks Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in RecipientCert is used for both encryption and verifying the receipt signature. If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking Post. After invoking Post or [VerifyReceipt](#verifyreceipt-method-as1sender-component), this will contain the certificate used to sign the receipt, if the receipt is signed. If set, this property should be a public key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # RecipientCerts Property ([AS1Sender](#as1sender-component) Component) The public key certificates of the recipients for this message. ## Syntax ```text public CertificateList RecipientCerts { get; } ``` ## Remarks The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by [EncryptionAlgorithm](#encryptionalgorithm-property-as1sender-component). This property will also be used to verify signed receipts if [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) to the signing certificate. If the component is unable to verify a signature make sure RecipientCerts are set appropriately. If set, this property should could contain public key instances of [Certificate](#certificate-type). The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by [EncryptionAlgorithm](#encryptionalgorithm-property-as1sender-component). This property will also be used to verify signed receipts if [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) to the signing certificate. If the component is unable to verify a signature make sure RecipientCerts are set appropriately. If set, this property should could contain public key instances of [Certificate](#certificate-type). This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SendTo Property ([AS1Sender](#as1sender-component) Component) The recipient of the message. ## Syntax ```text public string SendTo { get; set; } ``` ## Default Value "" ## Remarks The recipient of the AS1 message. The originator is given by [From](#from-property-as1sender-component). Note that [From](#from-property-as1sender-component) and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that [From](#from-property-as1sender-component) indicates the *recipient*, and SendTo indicates the *sender* of the MDN. # SignatureAlgorithm Property ([AS1Sender](#as1sender-component) Component) Signature algorithm to be used in outgoing messages. ## Syntax ```text public string SignatureAlgorithm { get; set; } ``` ## Default Value "sha-256" ## Remarks *Signature Algorithm* can be set to indicate the preferred signing algorithm. Possible values are: - sha1 - md5 - sha-256 (or sha256) (default) - sha-384 (or sha384) - sha-512 (or sha512) - sha-224 (or sha224) The default value is "sha-256". When this property is set the [MDNOptions](#mdnoptions-property-as1sender-component) property is automatically updated to request the MDN receipt be signed with the same algorithm. When AS2Version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed for generated messages. "sha-256", "sha-384", or "sha-512" are recommended instead. # SigningCert Property ([AS1Sender](#as1sender-component) Component) Contains the certificate to use when signing messages. ## Syntax ```text public Certificate SigningCert { get; set; } ``` ## Remarks This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by [SignatureAlgorithm](#signaturealgorithm-property-as1sender-component). If set, this property should be a private key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLAcceptServerCert Property ([AS1Sender](#as1sender-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public Certificate SSLAcceptServerCert { get; set; } ``` ## Remarks If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([AS1Sender](#as1sender-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public Certificate SSLCert { get; set; } ``` ## Remarks This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([AS1Sender](#as1sender-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public AS1SenderSSLProviders SSLProvider { get; set; } enum AS1SenderSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal } ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the component 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 component will select a provider depending on the current platform. When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. The .NET Standard library will always use the internal implementation on all platforms. # SSLServerCert Property ([AS1Sender](#as1sender-component) Component) The server certificate for the last established connection. ## Syntax ```text public Certificate SSLServerCert { get; } ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLStartMode Property ([AS1Sender](#as1sender-component) Component) Determines how the component starts the SSL negotiation. By default, SSL will not be used. ## Syntax ```text public AS1SenderSSLStartModes SSLStartMode { get; set; } enum AS1SenderSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone } ``` ## Default Value 3 ## Remarks The SSLStartMode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic - default) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the component 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 component 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. | # Subject Property ([AS1Sender](#as1sender-component) Component) The subject of the message. ## Syntax ```text public string Subject { get; set; } ``` ## Default Value "AS1 Message" ## Remarks The human-readable subject of the outgoing message. # User Property ([AS1Sender](#as1sender-component) Component) The username for your incoming mail server. ## Syntax ```text public string User { get; set; } ``` ## Default Value "" ## Remarks The username for your incoming mail server. Set this before invoking [Connect](#connect-method-as1sender-component). # Config Method ([AS1Sender](#as1sender-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); Async Version public async Task Config(string configurationString); public async Task Config(string configurationString, CancellationToken cancellationToken); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-as1sender-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-as1sender-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([AS1Sender](#as1sender-component) Component) Connects to the incoming mail server. ## Syntax ```text public void Connect(); Async Version public async Task Connect(); public async Task Connect(CancellationToken cancellationToken); ``` ## Remarks Connects to the incoming mail server specified by [MailServer](#mailserver-property-as1sender-component). You must set [User](#user-property-as1sender-component) and [Password](#password-property-as1sender-component) prior to calling Connect. The connection will be maintained until you call [Disconnect](#disconnect-method-as1sender-component). If you wish to connect in SSL you should first set the [SSLStartMode](#sslstartmode-property-as1sender-component) 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. # DeleteMessage Method ([AS1Sender](#as1sender-component) Component) Deletes the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component) . ## Syntax ```text public void DeleteMessage(); Async Version public async Task DeleteMessage(); public async Task DeleteMessage(CancellationToken cancellationToken); ``` ## Remarks Requests that the [MailServer](#mailserver-property-as1sender-component) delete the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component). The message will not actually be deleted until the connection is closed. # Disconnect Method ([AS1Sender](#as1sender-component) Component) Disconnects from the incoming mail server. ## Syntax ```text public void Disconnect(); Async Version public async Task Disconnect(); public async Task Disconnect(CancellationToken cancellationToken); ``` ## Remarks Disconnects from the incoming mail server specified by [MailServer](#mailserver-property-as1sender-component). # ProcessQueue Method ([AS1Sender](#as1sender-component) Component) Send the messages queued for sending. ## Syntax ```text public void ProcessQueue(string directory); Async Version public async Task ProcessQueue(string directory); public async Task ProcessQueue(string directory, CancellationToken cancellationToken); ``` ## Remarks Invoking ProcessQueue sends the messages that have been queued by [Queue](#queue-method-as1sender-component). # QueryMessageSize Method ([AS1Sender](#as1sender-component) Component) Returns the size in bytes of the current message. ## Syntax ```text public int QueryMessageSize(); Async Version public async Task QueryMessageSize(); public async Task QueryMessageSize(CancellationToken cancellationToken); ``` ## Remarks This method queries the server for the size in bytes of the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component). The method returns the size (in bytes) of the message. # QueryMessageUID Method ([AS1Sender](#as1sender-component) Component) Returns the unique identifier of the message as specified by the server. ## Syntax ```text public string QueryMessageUID(); Async Version public async Task QueryMessageUID(); public async Task QueryMessageUID(CancellationToken cancellationToken); ``` ## Remarks This method returns the unique identifier of the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component). # Queue Method ([AS1Sender](#as1sender-component) Component) Prepares and queues the message to the specified directory. ## Syntax ```text public void Queue(string directory); Async Version public async Task Queue(string directory); public async Task Queue(string directory, CancellationToken cancellationToken); ``` ## Remarks Invoking Queue will prepare and queue the AS1 message. It will be signed if [SigningCert](#signingcert-property-as1sender-component) is set, encrypted if RecipientCert is set, and compressed if [CompressionFormat](#compressionformat-property-as1sender-component) is set. A receipt will be requested if [MDNTo](#mdnto-property-as1sender-component) is set. The queued message can then be sent by invoking [ProcessQueue](#processqueue-method-as1sender-component). # ReadReceipt Method ([AS1Sender](#as1sender-component) Component) Reads and parses (but does ** not ** verify) an MDN receipt. ## Syntax ```text public void ReadReceipt(); Async Version public async Task ReadReceipt(); public async Task ReadReceipt(CancellationToken cancellationToken); ``` ## Remarks ReadReceipt will retrieve the file specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component) from the mail server, store it in [MDNReceipt](#mdnreceipt-property-as1sender-component) and attempt to parse it as an MDN receipt. If the file is a valid MDN receipt, the component will determine the originator of the receipt and the [MessageId](#messageid-property-as1sender-component) of the original message. The originator of the receipt (your trading partner) will be stored in [SendTo](#sendto-property-as1sender-component), the intended recipient (presumably your system) will be stored in [From](#from-property-as1sender-component), and the original message Id will be stored in [MessageId](#messageid-property-as1sender-component). If you are not currently connected to a mail server, the component will process the receipt specified by [MDNReceipt](#mdnreceipt-property-as1sender-component). You should then look up the original message and set [OriginalContentMIC](#originalcontentmic-property-as1sender-component) to the value of [OriginalContentMIC](#originalcontentmic-property-as1sender-component) originally computed when the message was sent (you will need to save this information externally). You should also set [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) based on the value of [SendTo](#sendto-property-as1sender-component) if necessary. Also, set [MDNOptions](#mdnoptions-property-as1sender-component) to the value used when making the original request. Finally, [VerifyReceipt](#verifyreceipt-method-as1sender-component) should be used to verify the receipt. # Reset Method ([AS1Sender](#as1sender-component) Component) Resets the state of the control. ## Syntax ```text public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken); ``` ## Remarks **Reset** resets the state of the component. All properties will be set to their default values. # SelectMailMessage Method ([AS1Sender](#as1sender-component) Component) Selects and obtains information about the specified message. ## Syntax ```text public void SelectMailMessage(); Async Version public async Task SelectMailMessage(); public async Task SelectMailMessage(CancellationToken cancellationToken); ``` ## Remarks This method selects the message specified by [MailMessageNumber](#mailmessagenumber-property-as1sender-component) and retrieves information about it. After calling this method properties such as [MailMessageHeaders](#mailmessageheaders-property-as1sender-component), [MailMessageDate](#mailmessagedate-property-as1sender-component), [MailMessageFrom](#mailmessagefrom-property-as1sender-component), etc. will be populated and allow you to determine if this message is an AS1 message. Additional properties are exposed via the [Config](#config-method-as1sender-component) method. If this message is an AS1 receipt (MDN), use [ReadReceipt](#readreceipt-method-as1sender-component) to read it. The [MDNReceipt](#mdnreceipt-property-as1sender-component) will then be populated with the receipt, and [SendTo](#sendto-property-as1sender-component) will be populated with the email address of the *originator*. ([From](#from-property-as1sender-component) and [SendTo](#sendto-property-as1sender-component) correspond to the originator and recipient of the original AS1 transmission.) You may then set trading partner information and invoke [VerifyReceipt](#verifyreceipt-method-as1sender-component) to verify the receipt. # Send Method ([AS1Sender](#as1sender-component) Component) Prepares and sends the AS1 message. ## Syntax ```text public void Send(); Async Version public async Task Send(); public async Task Send(CancellationToken cancellationToken); ``` ## Remarks Invoking Send will prepare and send the AS1 message. It will be signed if [SigningCert](#signingcert-property-as1sender-component) is set, encrypted if RecipientCert is set, and compressed if [CompressionFormat](#compressionformat-property-as1sender-component) is set. A receipt will be requested if [MDNTo](#mdnto-property-as1sender-component) is set. You should set [MailServer](#mailserver-property-as1sender-component) prior to sending. # SetRequestHeader Method ([AS1Sender](#as1sender-component) Component) Allows the user to set or add arbitrary HTTP request headers. ## Syntax ```text public void SetRequestHeader(string headerName, string headerValue); Async Version public async Task SetRequestHeader(string headerName, string headerValue); public async Task SetRequestHeader(string headerName, string headerValue, CancellationToken cancellationToken); ``` ## Remarks *HeaderName* should contain the header name, and *HeaderValue* should contain its value. Use this to set headers such as *To*, *Date*, etc. Note that a default value for *Date* will automatically be determined and this method may be used to override the default. **SetRequestHeader** may be used to set any header except for the following: *AS2-To*, *AS2-From*, *AS2-Version*, *Subject*, *Message-Id*, *Disposition-Notification-To*, *Disposition-Notification-Options*, *Receipt-Delivery-Option*, *Host*, *Content-Length*. # VerifyReceipt Method ([AS1Sender](#as1sender-component) Component) Verifies an MDN receipt. ## Syntax ```text public void VerifyReceipt(); Async Version public async Task VerifyReceipt(); public async Task VerifyReceipt(CancellationToken cancellationToken); ``` ## Remarks **VerifyReceipt** verifies the receipt in [MDNReceipt](#mdnreceipt-property-as1sender-component) against the values of [OriginalContentMIC](#originalcontentmic-property-as1sender-component) and [MessageId](#messageid-property-as1sender-component) and the preferences specified in [MDNOptions](#mdnoptions-property-as1sender-component). The method operates similarly to Post: After the method finishes, the [MDNReceipt](#mdnreceipt-property-as1sender-component), [ReceiptSigningProtocol](#ReceiptSigningProtocol), and [ReceiptSignerCert](#receiptsignercert-property-as1sender-component) properties will be populated with the appropriate values. The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN. If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal. You should first invoke [ReadReceipt](#readreceipt-method-as1sender-component) when it is not known which message the receipt is in response to. This will allow you to determine the original [MessageId](#messageid-property-as1sender-component) and originator of the receipt before trying to verify it. # ConnectionStatus Event ([AS1Sender](#as1sender-component) Component) Fired to indicate changes in the connection state. ## Syntax ```text public event OnConnectionStatusHandler OnConnectionStatus; public delegate void OnConnectionStatusHandler(object sender, AS1SenderConnectionStatusEventArgs e); public class AS1SenderConnectionStatusEventArgs : EventArgs { public string ConnectionEvent { get; } public int StatusCode { get; } public string Description { get; } } ``` ## 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 ([AS1Sender](#as1sender-component) Component) Fired when the message text completes transferring. ## Syntax ```text public event OnEndTransferHandler OnEndTransfer; public delegate void OnEndTransferHandler(object sender, AS1SenderEndTransferEventArgs e); public class AS1SenderEndTransferEventArgs : EventArgs { } ``` ## Remarks Fired when the message text completes transferring (on either a send or receive). # Error Event ([AS1Sender](#as1sender-component) Component) Fired when information is available about errors during data delivery. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, AS1SenderErrorEventArgs e); public class AS1SenderErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-as1sender-component) section. # Header Event ([AS1Sender](#as1sender-component) Component) This event is fired for every message header being retrieved. ## Syntax ```text public event OnHeaderHandler OnHeader; public delegate void OnHeaderHandler(object sender, AS1SenderHeaderEventArgs e); public class AS1SenderHeaderEventArgs : EventArgs { public string Field { get; } public string Value { get; } } ``` ## 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 ([AS1Sender](#as1sender-component) Component) Fires before launching a browser with the authorization URL. ## Syntax ```text public event OnLaunchBrowserHandler OnLaunchBrowser; public delegate void OnLaunchBrowserHandler(object sender, AS1SenderLaunchBrowserEventArgs e); public class AS1SenderLaunchBrowserEventArgs : EventArgs { public string URL { get; set; } public string Command { get; set; } } ``` ## Remarks When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the component will fire this event with the *Command*, which will be executed by the component. 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 component 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. # Log Event ([AS1Sender](#as1sender-component) Component) Fired with log information while processing a message. ## Syntax ```text public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, AS1SenderLogEventArgs e); public class AS1SenderLogEventArgs : EventArgs { public string LogType { get; } public string LogMessage { get; } public byte[] LogMessageB { get; } } ``` ## Remarks This event fires once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting. Log messages available through this event correspond to log files written to [LogDirectory](#logdirectory-property-as1sender-component). 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-as1sender-component) (i.e. when [LogDirectory](#logdirectory-property-as1sender-component) 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 ([AS1Sender](#as1sender-component) Component) This event traces the commands sent to the mail server, and the respective replies. ## Syntax ```text public event OnPITrailHandler OnPITrail; public delegate void OnPITrailHandler(object sender, AS1SenderPITrailEventArgs e); public class AS1SenderPITrailEventArgs : EventArgs { public int Direction { get; } public string Message { get; } } ``` ## 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 component code). | # SSLServerAuthentication Event ([AS1Sender](#as1sender-component) Component) Fired after the server presents its certificate to the client. ## Syntax ```text public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, AS1SenderSSLServerAuthenticationEventArgs e); public class AS1SenderSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; } public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } } ``` ## 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 ([AS1Sender](#as1sender-component) Component) Fired when secure connection progress messages are available. ## Syntax ```text public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, AS1SenderSSLStatusEventArgs e); public class AS1SenderSSLStatusEventArgs : EventArgs { public string Message { get; } } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AS1Sender](#as1sender-component) Component) Fired when the message text starts transferring (on either a send or receive). ## Syntax ```text public event OnStartTransferHandler OnStartTransfer; public delegate void OnStartTransferHandler(object sender, AS1SenderStartTransferEventArgs e); public class AS1SenderStartTransferEventArgs : EventArgs { } ``` ## Remarks Fired when the message text starts transferring (on either a send or receive). # Transfer Event ([AS1Sender](#as1sender-component) Component) Fired while the message text gets transferred to or from [MailServer](#mailserver-property-as1sender-component) . ## Syntax ```text public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, AS1SenderTransferEventArgs e); public class AS1SenderTransferEventArgs : EventArgs { public long BytesTransferred { get; } } ``` ## Remarks Fired while the message text gets transferred to or from [MailServer](#mailserver-property-as1sender-component). # 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: "" 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: "" 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: "" A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* Default: "" 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: "" 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: "" 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: "" The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *string (read-only)* Default: "" The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *bool (read-only)* Default: False Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* Default: "" The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* Default: "" The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* Default: "" The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* Default: 0 The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* Default: "" 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: "" The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *string* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte []* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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: "" If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* Default: 0 The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* Default: "" Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* Default: "" 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: "" 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: "" 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: "" The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* Default: 0 The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* Default: "" The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* Default: "" The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte []* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(string certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the 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. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the 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. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the 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. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the 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. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # EDIAttachment Type This describes the file being attached. ## Remarks Information about the file's location that is being attached to the message is contained here. The following fields are available: - [ContentType](#EDIAttachment_f_ContentType) - [Data](#EDIAttachment_f_Data) - [FileName](#EDIAttachment_f_FileName) - [Headers](#EDIAttachment_f_Headers) - [InputStream](#EDIAttachment_f_InputStream) - [Name](#EDIAttachment_f_Name) - [OutputStream](#EDIAttachment_f_OutputStream) ## Fields **ContentType** *string* Default: "" The MIME content-type of this [EDIAttachment](#ediattachment-type). **Data** *string* Default: "" This field contains the attachment data. In a receiver, the component decodes the attachment to the [Data](#EDIAttachment_f_Data) field when [Data](#EDIAttachment_f_Data)'s value is first queried. This field will contain the full decrypted text of the attachment. **DataB** *byte []* Default: "" This field contains the attachment data. In a receiver, the component decodes the attachment to the [Data](#EDIAttachment_f_Data) field when [Data](#EDIAttachment_f_Data)'s value is first queried. This field will contain the full decrypted text of the attachment. **FileName** *string* Default: "" The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this field. Otherwise, this will contain the name of the attachment as described in the [Headers](#EDIAttachment_f_Headers). **Headers** *string* Default: "" The component fills out [Headers](#EDIAttachment_f_Headers) each time any of the other fields for that [EDIAttachment](#ediattachment-type) are changed. If additional headers are needed they should be appended after all the other fields for that [EDIAttachment](#ediattachment-type) are set. **InputStream** *System.IO.Stream* Default: "" If [InputStream](#EDIAttachment_f_InputStream) is specified, the data from the stream specified will be used for the EDI attachment. **Name** *string* Default: "" [Name](#EDIAttachment_f_Name) is the final name to be associated with the contents of either the [Data](#EDIAttachment_f_Data) or [FileName](#EDIAttachment_f_FileName) fields. This corresponds to the *filename* attribute of the *Content-Disposition* header for this attachment. **OutputStream** *System.IO.Stream (read-only)* Default: "" The component decodes the attachment of Message when This field's value is first set, and writes the decoded attachment to the stream. NOTE: It is recommended to use the SetAttachmentOutputStream method instead of setting this field. ## Constructors ```text public EDIAttachment(); ``` ```text public EDIAttachment(string fileName); ``` ```text public EDIAttachment(string fileName, string contentType); ``` ```text public EDIAttachment(string fileName, string contentType, string headers); ``` # EDIData Type The EDI payload of the AS2 message. ## Remarks The EDI payload of the AS2 message. The following fields are available: - [Data](#EDIData_f_Data) - [EDIType](#EDIData_f_EDIType) - [InputStream](#EDIData_f_InputStream) - [Name](#EDIData_f_Name) - [OutputStream](#EDIData_f_OutputStream) - [FileName](#EDIData_f_FileName) ## Fields **Data** *string* Default: "" This field contains the EDI payload of the transmission. In a receiver, this field will only be populated if IncomingDirectory and [OutputStream](#EDIData_f_OutputStream) have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **DataB** *byte []* Default: "" This field contains the EDI payload of the transmission. In a receiver, this field will only be populated if IncomingDirectory and [OutputStream](#EDIData_f_OutputStream) have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, **Data** will contain the full decrypted text of the EDI message. **EDIType** *string* Default: "" The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml". **InputStream** *System.IO.Stream* Default: "" In a sender, if [InputStream](#EDIData_f_InputStream) is specified, the data from the specified stream will be used for the EDI payload of the transmission. **Name** *string* Default: "rfc1767.edi" [Name](#EDIData_f_Name) is the final name to be associated with the contents of either the [Data](#EDIData_f_Data) or [FileName](#EDIData_f_FileName) fields. This corresponds to the *filename* attribute of the *Content-Disposition* header for the EDI payload. When constructing EDI data to be sent, [Name](#EDIData_f_Name) will be set to the same value as [FileName](#EDIData_f_FileName), but can be overridden after setting [FileName](#EDIData_f_FileName) to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, [Name](#EDIData_f_Name) will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. **OutputStream** *System.IO.Stream* Default: "" In a receiver, if this field is set, the EDI payload will be written to this stream if ParseRequest finishes without an error, setting ScanResult to 0. If so, the specified stream will contain the full decrypted text of the EDI message. NOTE: When [OutputStream](#EDIData_f_OutputStream) is used and the underlying data contains attachments, the attachments will not be decoded to the output stream. Attachments are accessible via the Attachments collection. **FileName** *string* Default: "" In a sender, if [FileName](#EDIData_f_FileName) is specified, the file specified will be used for the EDI payload of the transmission. [Name](#EDIData_f_Name) will be populated with the name of the file. In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents. Note: When [OutputStream](#EDIData_f_OutputStream) is set, the data will be written to the stream and this field will not be populated. ## Constructors ```text public EDIData(); ``` ```text public EDIData(byte[] data, string EDIType); ``` ```text public EDIData(string fileName, string EDIType); ``` # Firewall Type The firewall the 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 [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *bool* Default: False Whether to automatically detect and use firewall system settings, if available. **FirewallType** *FirewallTypes* Default: 0 The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *string* Default: "" The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception. **Password** *string* Default: "" A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception. **Port** *int* Default: 0 The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *string* Default: "" A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component throws an exception. ## Constructors ```text public Firewall(); ``` # MailOAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the component 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: "" The access token returned by the authorization server. This is set when the component makes a request to the token server. **AuthorizationScope** *string* Default: "" The scope request or response parameter used during authorization. **ClientId** *string* Default: "" The id of the client assigned when registering the application. **ClientSecret** *string* Default: "" The secret value for the client assigned when registering the application. **RefreshToken** *string* Default: "" Specifies the refresh token received from or sent to the authorization server. This field is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the [GrantType](#MailOAuthSettings_f_GrantType) field is set to a grant that can use refresh tokens. **ReturnURL** *string* Default: "" The URL where the user (browser) returns after authenticating. This field is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field 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: "" The URL of the authorization server. **ServerTokenURL** *string* Default: "" The URL of the token server used to obtain the access token. ## Constructors ```text public MailOAuthSettings(); ``` # MDNReceipt Type The complete MDN Receipt returned by the receiver. ## Remarks The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature. The following fields are available: - [Content](#MDNReceipt_f_Content) - [HeaderCount](#MDNReceipt_f_HeaderCount) - [HeaderField](#MDNReceipt_f_HeaderField) - [HeaderIndex](#MDNReceipt_f_HeaderIndex) - [Headers](#MDNReceipt_f_Headers) - [HeaderValue](#MDNReceipt_f_HeaderValue) - [MDN](#MDNReceipt_f_MDN) - [Message](#MDNReceipt_f_Message) - [MICValue](#MDNReceipt_f_MICValue) - [SigningProtocol](#MDNReceipt_f_SigningProtocol) ## Fields **Content** *string* Default: "" This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable [MDN](#MDNReceipt_f_MDN) (Message Disposition Notification) and a human readable [Message](#MDNReceipt_f_Message), which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **ContentB** *byte []* Default: "" This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable [MDN](#MDNReceipt_f_MDN) (Message Disposition Notification) and a human readable [Message](#MDNReceipt_f_Message), which itself may be embedded in a multipart/signed entity if requested by the AS2 sender. **HeaderCount** *int (read-only)* Default: 0 The number of headers in the MDN. **HeaderField** *string (read-only)* Default: "" The field name of the MDN header currently selected by [HeaderIndex](#MDNReceipt_f_HeaderIndex). **HeaderIndex** *int* Default: 0 Which MDN header is currently selected to populate [HeaderField](#MDNReceipt_f_HeaderField) and [HeaderValue](#MDNReceipt_f_HeaderValue). Valid values are 0 to [HeaderCount](#MDNReceipt_f_HeaderCount) - 1. **Headers** *string* Default: "" **Headers** contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as *AS2-From*, *AS2-To*, *Date*, *Content-Type*, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option). You can also use [HeaderCount](#MDNReceipt_f_HeaderCount), [HeaderIndex](#MDNReceipt_f_HeaderIndex), [HeaderField](#MDNReceipt_f_HeaderField), and [HeaderValue](#MDNReceipt_f_HeaderValue) to easily iterate through each individual header. **HeaderValue** *string (read-only)* Default: "" The value of the MDN header currently selected by [HeaderIndex](#MDNReceipt_f_HeaderIndex). **MDN** *string (read-only)* Default: "" **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: "" 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: "" 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: "" This field contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this [MDNReceipt](#mdnreceipt-type). It will contain an empty string if the receipt is unsigned. ## Constructors ```text public MDNReceipt(); ``` ```text public MDNReceipt(string headers, byte[] content); ``` # Config Settings ([AS1Sender](#as1sender-component) Component) The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-as1sender-component) method. ### 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 **CACertFilePaths**: The paths to CA certificate files when using Mono on Unix/Linux.This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances. The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is as follows: */etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem* **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-as1sender-component) 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-as1sender-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-as1sender-component) is set to *Platform*. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the component will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the component is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-as1sender-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-as1sender-component) 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 component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component 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 component throws an exception. When set to 0 (default), the CRL check will not be performed by the component. 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 component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component 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 component throws an exception. When set to 0 (default), the component 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-as1sender-component) 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 component 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-as1sender-component) 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-as1sender-component) 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-as1sender-component) 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-as1sender-component) 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 component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-as1sender-component) 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-as1sender-component) 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 component when the [SSLProvider](#sslprovider-property-as1sender-component) 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-as1sender-component) 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-as1sender-component) 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-as1sender-component) 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-as1sender-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-as1sender-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When [SSLProvider](#sslprovider-property-as1sender-component) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the component 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 component will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-as1sender-component) 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 in Java or 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-as1sender-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the component 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 component throws an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-as1sender-component) 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. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component 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*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*. Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. NOTE: This setting is static. The value set is applicable to all components used in the application. When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file. # Trappable Errors ([AS1Sender](#as1sender-component) Component) ### AS1Sender Errors | | | | --- | --- | | 501 | Unable to parse the receipt. | | 502 | The receipt is signed with an unsupported signature format (details follow). | | 511 | Unsupported compression algorithm requested. | | 521 | A Message Integrity Check was requested, but not provided in the MDN. | | 522 | The Message Integrity Check returned in the MDN is incorrect. | | 523 | Unable to parse Message Integrity Check. | | 524 | Unrequested hashing algorithm used (check MDNOptions). | | 525 | The Message ID returned in the MDN does not match. | | 531 | The receipt was unsigned, and a signed receipt was expected. | | 532 | The receipt signature could not be verified. | | 533 | An MDN was expected, but was not returned. | | 600 | Failure reported in MDN: Unsupported signing protocol. | | 601 | Failure reported in MDN: Unsupported MIC algorithms. | | 602 | Failure reported in MDN: Other (details follow). | | 611 | Error reported in MDN: Decryption failed. | | 612 | Error reported in MDN: Authentication failed. | | 613 | Error reported in MDN: Could not verify content integrity. | | 614 | Error reported in MDN: Unexpected processing error. | | 615 | Error reported in MDN: Other (details follow). | | 621 | Warning reported in MDN: Authentication failed, processing continued by receiver. | | 622 | Warning reported in MDN: Other (details follow). | | 831 | I/O Error (details follow). | ### 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-as1sender-component). | | 174 | Busy executing current method. | The component may also return one of the following error codes, which are inherited from other components. ### 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-as1sender-component) 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 component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### 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-as1sender-component). | | 164 | Please specify a sender ([From](#from-property-as1sender-component)). | | 165 | Please specify a recipient. | | 166 | Busy executing current method. | | 301 | Operation interrupted. | | 302 | Cannot open AttachedFile. | The component may also return one of the following error codes, which are inherited from other components. ### 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-as1sender-component) 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 component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). | ### SMIME Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. |