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

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 AS1Receiver component allows you to receive AS1 messages as specified in RFC 3335. The component can act as an email client, decrypt and verify incoming messages, generate receipts including Message Disposition Notifications (MDNs), and send them over SMTP/S.

Basic Operation

You should first log in to your mail server by setting MailServer, User, and Password, and invoking Connect. You may then navigate your mail inbox by setting MailMessageNumber, and inspecting properties such as MailMessageFrom, etc. When you find the desired file you may download it by invoking ReadRequest. Alternatively, you may acquire the AS1 data by other means and directly set Request and RequestHeaders.

ReadRequest (or ParseHeaders) will determine information such as From and SendTo, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned over SMTP/S by invoking SendResponse. In case the server address for incoming mail is different than that for outgoing mail you should use Config to configure this.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

Example

AS1Receiver1.User = "myusername"
AS1Receiver1.Password = "mypassword"
AS1Receiver1.MailServer = "1.2.3.4"
AS1Receiver1.Connect()
// You may need to search the server for received files at this point
AS1Receiver1.MessageNumber = 1;
// You may check properties such as MailMessageFrom, etc.
AS1Receiver1.ReadRequest()
AS1Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me");
AS1Receiver1.SignerCert = (base 64 encoded certificate);
AS1Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory";
AS1Receiver1.ProcessRequest();
AS1Receiver1.SendResponse();
AS1Receiver1.Disconnect();

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

Property List

The following is the full list of the properties of the 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.
CertEffectiveDate	The date which this certificate becomes valid.
CertEncoded	The certificate (PEM/base64 encoded).
CertExpirationDate	The date the certificate expires.
CertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
CertIssuer	The issuer of the certificate.
CertKeyPassword	The password for the certificate's private key (if any).
CertPrivateKey	The private key of the certificate (if available).
CertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
CertPublicKey	The public key of the certificate.
CertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
CertPublicKeyLength	The length of the certificate public key (in bits).
CertSerialNumber	The serial number of the certificate encoded as a string.
CertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
CertStore	The name of the certificate store for the client certificate.
CertStorePassword	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.
CertStoreType	The type of certificate store for this certificate.
CertSubject	The subject of the certificate used for client authentication.
CertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
CertThumbprintMD5	MD5 hash of the certificate.
CertThumbprintSHA1	SHA1 hash of the certificate.
CertUsage	Textual description of UsageFlags .
CertUsageFlags	Flags that show intended use for the certificate.
CertVersion	The certificate's version number.
CompressionFormat	The compression format used on the incoming message.
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.
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.
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 recipient for the Message Disposition Notification (MDN).
MessageId	The message ID of the incoming message.
Password	The password for your incoming mail server.
Request	The AS1 request to be processed.
RequestHeaderCount	The number of records in the RequestHeader arrays.
RequestHeaderField	This property contains the name of the HTTP header (same case as it is delivered).
RequestHeaderValue	This property contains the header contents.
RequestHeadersString	The headers in the AS1 request.
ScanResult	The result of invoking ParseRequest.
SendTo	The recipient of the original message.
SignerCertEffectiveDate	The date which this certificate becomes valid.
SignerCertEncoded	The certificate (PEM/base64 encoded).
SignerCertExpirationDate	The date the certificate expires.
SignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SignerCertIssuer	The issuer of the certificate.
SignerCertKeyPassword	The password for the certificate's private key (if any).
SignerCertPrivateKey	The private key of the certificate (if available).
SignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SignerCertPublicKey	The public key of the certificate.
SignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SignerCertPublicKeyLength	The length of the certificate public key (in bits).
SignerCertSerialNumber	The serial number of the certificate encoded as a string.
SignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SignerCertStore	The name of the certificate store for the client certificate.
SignerCertStorePassword	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.
SignerCertStoreType	The type of certificate store for this certificate.
SignerCertSubject	The subject of the certificate used for client authentication.
SignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SignerCertThumbprintMD5	MD5 hash of the certificate.
SignerCertThumbprintSHA1	SHA1 hash of the certificate.
SignerCertUsage	Textual description of UsageFlags .
SignerCertUsageFlags	Flags that show intended use for the certificate.
SignerCertVersion	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.
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.
CreateMDNReceipt	Creates MDNReceipt.
DeleteMessage	Deletes the message specified by MailMessageNumber.
Disconnect	Disconnects from the incoming mail server.
ParseRequest	Parses the EDI message and determines the EDIData.
ProcessQueue	Send the messages queued for sending.
ProcessRequest	Processes the EDI data, and generates the receipt.
Queue	Prepares and queues the message to the specified directory.
ReadRequest	Reads the AS1 request from the mail server.
SendResponse	Sends the 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.


filename	The filename of the EDI Data.
SenderSigningAlgorithm	The algorithm used by the sender to sign the message.
UseCryptoAPI	Whether to use the Microsoft Crypto API for cryptographic message generation.
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.

|

About

|

Privacy Policy

|

Terms of Use

|