AS1Sender Component
Properties Methods Events Configuration Settings Errors
The AS1Sender component implements an AS1 / EDI-INT client, capable of sending EDI messages over electronic mail.
Syntax
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 and SendTo, MailServer, and Data and EDIType. The Send 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. To encrypt, set RecipientCerts.
TLS/SSL will also be used if SSLStartMode is set. In case your trading partner is using a self-signed certificate with their mail server it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.
The message may also be compressed by setting CompressionFormat.
To request a receipt, or Message Disposition Notification (MDN), simply set the MDNTo property. The MDN will be returned in a separate email response. The MDNOptions 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, User, and Password properties, and call Connect. At this point you may search your mailbox using the MailMessage properties; when you have found the appropriate message you should invoke ReadReceipt, which will set MDNReceipt. If the receipt is indeed an MDN it will also be parsed (although not verified) and MessageId will be set. If the message is not an MDN an exception will be thrown.
You should then use the values of From and MessageId to look up your trading partner's certificates, the MDNOptions requested, and the OriginalContentMIC calculated when you sent the original message (you must store this value externally to verify signed receipts). Finally, invoke VerifyReceipt.
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 | Collection of files attached to the current message. |
CompressionFormat | The compression format (if any) to use. |
Connected | Shows whether the component is connected. |
EDIData | The EDI or other data to be sent. |
EncryptionAlgorithm | The algorithm used to encrypt the EDI data. |
Firewall | A set of properties related to firewall access. |
From | The sender of the original message. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MailMessageCc | The value of the Cc header of the mail message. |
MailMessageCount | The number of messages waiting in the mailbox. |
MailMessageDate | The message date for the currently selected message. |
MailMessageFrom | The sender of the mail message. |
MailMessageHeaders | The message headers for the currently selected message. |
MailMessageNumber | The message number on the incoming mail server. |
MailMessageReplyTo | The value of the ReplyTo header of the mail message. |
MailMessageSize | The size of the mail message. |
MailMessageSubject | The subject of the mail message. |
MailMessageText | The text of the mail message. |
MailMessageTo | The recipient of the mail message. |
MailMessageUID | The unique id of the mail message. |
MailServer | The address of your mail server. |
MDNOptions | Used to indicate the options requested for the MDN receipt. |
MDNReceipt | The MDN receipt returned from the server. |
MDNTo | The system to which an MDN should be directed. |
MessageId | The Id of the message. |
OriginalContentMIC | The Message Integrity Check(s) (one-way hash) of the outgoing message. |
Password | The password for your incoming mail server. |
ReceiptSignerCert | The public key certificate for the MDN receipt signature. |
RecipientCerts | The public key certificates of the recipients for this message. |
SendTo | The recipient of the message. |
SignatureAlgorithm | Signature algorithm to be used in outgoing messages. |
SigningCert | Contains the certificate to use when signing messages. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
SSLStartMode | Determines how the component starts the SSL negotiation. By default, SSL will not be used. |
Subject | The subject of the message. |
User | 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 | Sets or retrieves a configuration setting. |
Connect | Connects to the incoming mail server. |
DeleteMessage | Deletes the message specified by MailMessageNumber . |
Disconnect | Disconnects from the incoming mail server. |
ProcessQueue | Send the messages queued for sending. |
Queue | Prepares and queues the message to the specified directory. |
ReadReceipt | Reads and parses (but does not verify) an MDN receipt. |
Reset | Resets the state of the control. |
Send | Prepares and sends the AS1 message. |
SetRequestHeader | Allows the user to set or add arbitrary HTTP request headers. |
VerifyReceipt | 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 | Fired to indicate changes in connection state. |
EndTransfer | Fired when the message text completes transferring. |
Error | Information about errors during data delivery. |
Header | Fired for every message header being retrieved. |
Log | Fired with log information while processing a message. |
PITrail | Traces the commands sent to the mail server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when the message text starts transferring (on either a send or receive). |
Transfer | Fired while the message text gets transferred to or from MailServer . |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
LogFilename | The base name of the log file. |
POPPort | The POP mail port to be used, if different than MailServer. |
POPServer | The POP server to be used, if different than MailServer. |
SMTPAuthMechanism | The authentication mechanism used to connect to the SMTP server. |
SMTPPassword | The password used for authentication. |
SMTPPort | The SMTP mail port to be used, if different than MailServer. |
SMTPServer | The SMTP server to be used, if different than MailServer. |
SMTPSSLStartMode | Determines how SSL negotiation starts with the SMTP server. |
SMTPUser | The user name used for authentication. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |