IP*Works! EDI AS1Sender Component : AS1Sender OCX, AS1Sender .NET Component, AS1Sender Class, AS1Sender Bean, AS1Sender Object

Available in: EDI | EDI/AS2

AS1Sender Component [IP*Works! EDI V8]

Properties Methods Events Configuration Settings

The AS1Sender component implements an AS1 / EDI-INT client, capable of sending EDI messages over electronic mail.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 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 EDIData 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 RecipientCert.

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.


AttachmentCount	The number of records in the Attachment arrays.
AttachmentContentType	The MIME content-type of this ediattachment.
AttachmentFileName	The file name where the attachment data is stored.
AttachmentHeaders	The component fills out Headers each time any of the other properties for that ediattachment are changed.
CompressionFormat	The compression format (if any) to use.
Connected	Shows whether the component is connected.
EDIData	This property contains the EDI payload of the transmission.
EDIEDIType	The Content-Type of the EDI message.
EDIFileName	In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.
EDIName	Name is the final name to be associated with the contents of either the Data or FileName properties.
EncryptingAlgorithm	The algorithm used to encrypt the EDI data.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
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.
MDNContent	This contains the entire content of the MDN Receipt.
MDNHeaders	ReceiptHeaders contains the AS2 headers of the MDN Receipt.
MDNMDN	MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.
MDNMessage	The human-readable portion of the MDN receipt.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the original EDI message.
MDNSigningProtocol	This property contains the MIME type of the signature used, if any (i.
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.
ReceiptSignerCertEffectiveDate	The date which this certificate becomes valid.
ReceiptSignerCertEncoded	The certificate (PEM/base64 encoded).
ReceiptSignerCertExpirationDate	The date the certificate expires.
ReceiptSignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
ReceiptSignerCertIssuer	The issuer of the certificate.
ReceiptSignerCertKeyPassword	The password for the certificate's private key (if any).
ReceiptSignerCertPrivateKey	The private key of the certificate (if available).
ReceiptSignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
ReceiptSignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
ReceiptSignerCertPublicKey	The public key of the certificate.
ReceiptSignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
ReceiptSignerCertPublicKeyLength	The length of the certificate public key (in bits).
ReceiptSignerCertSerialNumber	The serial number of the certificate encoded as a string.
ReceiptSignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
ReceiptSignerCertStore	The name of the certificate store for the client certificate.
ReceiptSignerCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ReceiptSignerCertStoreType	The type of certificate store for this certificate.
ReceiptSignerCertSubject	The subject of the certificate used for client authentication.
ReceiptSignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
ReceiptSignerCertThumbprintMD5	MD5 hash of the certificate.
ReceiptSignerCertThumbprintSHA1	SHA1 hash of the certificate.
ReceiptSignerCertUsage	Textual description of UsageFlags .
ReceiptSignerCertUsageFlags	Flags that show intended use for the certificate.
ReceiptSignerCertVersion	The certificate's version number.
RecipientCertEffectiveDate	The date which this certificate becomes valid.
RecipientCertEncoded	The certificate (PEM/base64 encoded).
RecipientCertExpirationDate	The date the certificate expires.
RecipientCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
RecipientCertIssuer	The issuer of the certificate.
RecipientCertKeyPassword	The password for the certificate's private key (if any).
RecipientCertPrivateKey	The private key of the certificate (if available).
RecipientCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
RecipientCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
RecipientCertPublicKey	The public key of the certificate.
RecipientCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
RecipientCertPublicKeyLength	The length of the certificate public key (in bits).
RecipientCertSerialNumber	The serial number of the certificate encoded as a string.
RecipientCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
RecipientCertStore	The name of the certificate store for the client certificate.
RecipientCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
RecipientCertStoreType	The type of certificate store for this certificate.
RecipientCertSubject	The subject of the certificate used for client authentication.
RecipientCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
RecipientCertThumbprintMD5	MD5 hash of the certificate.
RecipientCertThumbprintSHA1	SHA1 hash of the certificate.
RecipientCertUsage	Textual description of UsageFlags .
RecipientCertUsageFlags	Flags that show intended use for the certificate.
RecipientCertVersion	The certificate's version number.
SendTo	The recipient of the message.
SigningCertEffectiveDate	The date which this certificate becomes valid.
SigningCertEncoded	The certificate (PEM/base64 encoded).
SigningCertExpirationDate	The date the certificate expires.
SigningCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SigningCertIssuer	The issuer of the certificate.
SigningCertKeyPassword	The password for the certificate's private key (if any).
SigningCertPrivateKey	The private key of the certificate (if available).
SigningCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SigningCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SigningCertPublicKey	The public key of the certificate.
SigningCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SigningCertPublicKeyLength	The length of the certificate public key (in bits).
SigningCertSerialNumber	The serial number of the certificate encoded as a string.
SigningCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SigningCertStore	The name of the certificate store for the client certificate.
SigningCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SigningCertStoreType	The type of certificate store for this certificate.
SigningCertSubject	The subject of the certificate used for client authentication.
SigningCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SigningCertThumbprintMD5	MD5 hash of the certificate.
SigningCertThumbprintSHA1	SHA1 hash of the certificate.
SigningCertUsage	Textual description of UsageFlags .
SigningCertUsageFlags	Flags that show intended use for the certificate.
SigningCertVersion	The certificate's version number.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
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.
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.
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.


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.
UseCryptoAPI	Whether to use the Microsoft Crypto API for cryptographic message generation.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
CodePage	The system code page used for Unicode to Multibyte translations.