AS1Sender Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 class 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 class 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 class 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 class 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 class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Attachments Property (AS1Sender Class)

Collection of files attached to the current message.

Syntax

public EDIAttachmentList getAttachments();


public void setAttachments(EDIAttachmentList attachments);

Remarks

When a call to Send is made, the class will attach the files referenced by each EDIAttachment in this collection to the EDIData.

This property is not available at design time.

CompressionFormat Property (AS1Sender Class)

The compression format (if any) to use.

Syntax

public int getCompressionFormat();


public void setCompressionFormat(int compressionFormat);


Enumerated values:
  public final static int cfNone = 0;
  public final static int cfZLIB = 1;

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the class 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 Class)

This shows whether the class is connected.

Syntax

public boolean isConnected();


public void setConnected(boolean connected);

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

EDIData Property (AS1Sender Class)

The EDI or other data to be sent.

Syntax

public EDIData getEDIData();


public void setEDIData(EDIData EDIData);

Remarks

The EDI message to send.

This property is not available at design time.

EncryptionAlgorithm Property (AS1Sender Class)

The algorithm used to encrypt the EDI data.

Syntax

public String getEncryptionAlgorithm();


public void setEncryptionAlgorithm(String encryptionAlgorithm);

Default Value

"3DES"

Remarks

If RecipientCerts 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 class supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The class supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

Possible values are:

• 3DES (default)
• DES
• AESCBC128
• AESCBC192
• AESCBC256
• AESGCM128
• AESGCM192
• AESGCM256

Firewall Property (AS1Sender Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

From Property (AS1Sender Class)

The sender of the original message.

Syntax

public String getFrom();


public void setFrom(String from);

Default Value

""

Remarks

The sender of the original message. The recipient is given by SendTo.

Note that From and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that From indicates the recipient, and SendTo indicates the sender of the MDN.

LocalHost Property (AS1Sender Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

public String getLocalHost();


public void setLocalHost(String localHost);

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed 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 Class)

The path to a directory for logging.

Syntax

public String getLogDirectory();


public void setLogDirectory(String logDirectory);

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response.

The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS1 messages created or downloaded by the class will be written with extension ".as1", and MDNs created or downloaded will be written with extension ".as1-mdn".

The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile 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 Class)

The log file written.

Syntax

public String getLogFile();

Default Value

""

Remarks

In case LogDirectory 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 Class)

The value of the Cc header of the mail message.

Syntax

public String getMailMessageCc();

Default Value

""

Remarks

After calling SelectMailMessage this property will be populated with the value of the Cc header of the mail message.

This property is read-only.

MailMessageCount Property (AS1Sender Class)

The number of messages waiting in the mailbox.

Syntax

public int getMailMessageCount();

Default Value

0

Remarks

When the class is not connected to the mail server, the value of the MailMessageCount property is 0. When connected, it contains the number of messages in the mailbox. You may set MailMessageNumber to any value between 1 and MailMessageCount to inspect a given message.

This property is read-only.

MailMessageDate Property (AS1Sender Class)

The message date for the currently selected message.

Syntax

public String getMailMessageDate();

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 Class)

The sender of the mail message.

Syntax

public String getMailMessageFrom();

Default Value

""

Remarks

After calling SelectMailMessage this property will be populated. When processing AS1 transmissions, this will correspond to From. When processing MDNs, this will correspond to SendTo.

This property is read-only.

MailMessageHeaders Property (AS1Sender Class)

The message headers for the currently selected message.

Syntax

public String getMailMessageHeaders();

Default Value

""

Remarks

After calling SelectMailMessage 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 Class)

The message number on the incoming mail server.

Syntax

public int getMailMessageNumber();


public void setMailMessageNumber(int mailMessageNumber);

Default Value

0

Remarks

MailMessageNumber specifies a number between 1 and MailMessageCount, and serves as a message pointer to an incoming mail message.

Set this property before calling SelectMailMessage, QueryMessageSize or QueryMessageUID.

This property is not available at design time.

MailMessageReplyTo Property (AS1Sender Class)

The value of the ReplyTo header of the mail message.

Syntax

public String getMailMessageReplyTo();

Default Value

""

Remarks

After calling SelectMailMessage this property will be populated with the value of the ReplyTo header of the mail message.

This property is read-only.

MailMessageSize Property (AS1Sender Class)

The size of the mail message.

Syntax

public int getMailMessageSize();

Default Value

0

Remarks

After calling QueryMessageSize this property will be populated with the the size of the mail message.

Note: It is recommended to use the QueryMessageSize method instead of getting this property.

This property is read-only.

MailMessageSubject Property (AS1Sender Class)

The subject of the mail message.

Syntax

public String getMailMessageSubject();

Default Value

""

Remarks

After calling SelectMailMessage this property will be populated with the subject of the mail message.

This property is read-only.

MailMessageText Property (AS1Sender Class)

The text of the mail message.

Syntax

public String getMailMessageText();

Default Value

""

Remarks

The text of the mail message identified by MailMessageNumber, if it has been downloaded from the server. To read the message, invoke ReadRequest (receiver) or ReadReceipt (sender). In case the message is not as AS1 message this will throw an exception, but you may catch it and then read the value of MailMessageText.

This property is read-only.

MailMessageTo Property (AS1Sender Class)

The recipient of the mail message.

Syntax

public String getMailMessageTo();

Default Value

""

Remarks

After calling SelectMailMessage this property will be populated with the recipient of the mail message.

This property is read-only.

MailMessageUID Property (AS1Sender Class)

The unique id of the mail message.

Syntax

public String getMailMessageUID();

Default Value

""

Remarks

After calling QueryMessageUID this property will be populated with the unique id of the mail message.

Note: It is recommended to use the QueryMessageUID method instead of getting this property.

This property is read-only.

MailServer Property (AS1Sender Class)

The address of your mail server.

Syntax

public String getMailServer();


public void setMailServer(String mailServer);

Default Value

""

Remarks

The address of your mail server. By default, the class will send outgoing mail via SMTP, and receive incoming mail via POP. Moreover, the class will assume that both servers are located at the address specified by MailServer.

In case you use different addresses for incoming and outgoing mail you should set the POPServer and SMTPServer configuration settings appropriately. You may also set POPPort and SMTPPort in case you use nonstandard ports.

To configure SSL you should set SSLStartMode. Note that if SSL is used for sending but not receiving, or vice versa, you should set SSLStartMode each time you send or receive a file.

MDNOptions Property (AS1Sender Class)

Used to indicate the options requested for the MDN receipt.

Syntax

public String getMDNOptions();


public void setMDNOptions(String MDNOptions);

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256"

Remarks

By default, the class 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 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.

MDNReceipt Property (AS1Sender Class)

The MDN receipt returned from the server.

Syntax

public MDNReceipt getMDNReceipt();


public void setMDNReceipt(MDNReceipt MDNReceipt);

Remarks

This property will contain an instance of MDNReceipt 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.

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, MDNOptions, and ReceiptSignerCert 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.

Alternatively, AsyncMDNInfoDir may be set in place of OriginalContentMIC, MessageId, and MDNOptions (provided it was set to the same value when the message was sent). If AsyncMDNInfoDir was specified when the message was sent, the class would have saved OriginalContentMIC and MDNOptions to a file identified by the MessageId for the transmission. These properties are read from the file matching the MessageId in the MDNReceipt automatically if AsyncMDNInfoDir is specified.

Note: MDNReceipt must be populated prior to calling VerifyReceipt.

MDNTo Property (AS1Sender Class)

The system to which an MDN should be directed.

Syntax

public String getMDNTo();


public void setMDNTo(String MDNTo);

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. You should specify a valid email address; you might, for example, specify the same e-mail address as in From.

By default, the class will request a PKCS#7 signature signed over SHA-1. You may set MDNOptions to customize this.

MessageId Property (AS1Sender Class)

The Id of the message.

Syntax

public String getMessageId();


public void setMessageId(String messageId);

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 class 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.

OriginalContentMIC Property (AS1Sender Class)

The Message Integrity Check(s) (one-way hash) of the outgoing message.

Syntax

public String getOriginalContentMIC();


public void setOriginalContentMIC(String originalContentMIC);

Default Value

""

Remarks

A MIC will be calculated over the outgoing message using the same algorithm in the SignatureAlgorithm configuration used to sign the message. The property will be set when Post (in AS3, Send) 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. "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 Class)

The password for your incoming mail server.

Syntax

public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

The password for your incoming mail server. Set this before invoking Connect.

ReceiptSignerCert Property (AS1Sender Class)

The public key certificate for the MDN receipt signature.

Syntax

public Certificate getReceiptSignerCert();


public void setReceiptSignerCert(Certificate receiptSignerCert);

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, 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.

RecipientCerts Property (AS1Sender Class)

The public key certificates of the recipients for this message.

Syntax

public CertificateList getRecipientCerts();


public void setRecipientCerts(CertificateList recipientCerts);

Remarks

The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by EncryptionAlgorithm.

This property will also be used to verify signed receipts if ReceiptSignerCert 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 to the signing certificate.

If the class is unable to verify a signature make sure RecipientCerts are set appropriately.

If set, this property should could contain public key instances of Certificate.

The encryption certificates of the recipients. If this property is specified, the message content will be encrypted using the algorithm given by EncryptionAlgorithm.

This property will also be used to verify signed receipts if ReceiptSignerCert 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 to the signing certificate.

If the class is unable to verify a signature make sure RecipientCerts are set appropriately.

If set, this property should could contain public key instances of Certificate.

This property is not available at design time.

SendTo Property (AS1Sender Class)

The recipient of the message.

Syntax

public String getSendTo();


public void setSendTo(String sendTo);

Default Value

""

Remarks

The recipient of the AS1 message. The originator is given by From.

Note that From and SendTo correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that From indicates the recipient, and SendTo indicates the sender of the MDN.

SignatureAlgorithm Property (AS1Sender Class)

Signature algorithm to be used in outgoing messages.

Syntax

public String getSignatureAlgorithm();


public void setSignatureAlgorithm(String signatureAlgorithm);

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 property is automatically updated to request the MDN receipt be signed with the same algorithm.

SigningCert Property (AS1Sender Class)

Contains the certificate to use when signing messages.

Syntax

public Certificate getSigningCert();


public void setSigningCert(Certificate signingCert);

Remarks

This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by SignatureAlgorithm.

If set, this property should be a private key instance of Certificate.

SSLAcceptServerCert Property (AS1Sender Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (AS1Sender Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (AS1Sender Class)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (AS1Sender Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (AS1Sender Class)

Determines how the class starts the SSL negotiation. By default, SSL will not be used.

Syntax

public int getSSLStartMode();


public void setSSLStartMode(int SSLStartMode);


Enumerated values:
  public final static int sslAutomatic = 0;
  public final static int sslImplicit = 1;
  public final static int sslExplicit = 2;
  public final static int sslNone = 3;

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (AS1Sender Class)

The subject of the message.

Syntax

public String getSubject();


public void setSubject(String subject);

Default Value

"AS1 Message"

Remarks

The human-readable subject of the outgoing message.

User Property (AS1Sender Class)

The username for your incoming mail server.

Syntax

public String getUser();


public void setUser(String user);

Default Value

""

Remarks

The username for your incoming mail server. Set this before invoking Connect.

Config Method (As1sender Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (As1sender Class)

Connects to the incoming mail server.

Syntax

public void connect();

Remarks

Connects to the incoming mail server specified by MailServer. You must set User and Password prior to calling Connect. The connection will be maintained until you call Disconnect.

If you wish to connect in SSL you should first set the SSLStartMode 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 Class)

Deletes the message specified by MailMessageNumber .

Syntax

public void deleteMessage();

Remarks

Requests that the MailServer delete the message specified by MailMessageNumber. The message will not actually be deleted until the connection is closed.

Disconnect Method (As1sender Class)

Disconnects from the incoming mail server.

Syntax

public void disconnect();

Remarks

Disconnects from the incoming mail server specified by MailServer.

ProcessQueue Method (As1sender Class)

Send the messages queued for sending.

Syntax

public void processQueue(String directory);

Remarks

Invoking ProcessQueue sends the messages that have been queued by Queue.

QueryMessageSize Method (As1sender Class)

Returns the size in bytes of the current message.

Syntax

public int queryMessageSize();

Remarks

This method queries the server for the size in bytes of the message specified by MailMessageNumber. The method returns the size (in bytes) of the message.

QueryMessageUID Method (As1sender Class)

Returns the unique identifier of the message as specified by the server.

Syntax

public String queryMessageUID();

Remarks

This method returns the unique identifier of the message specified by MailMessageNumber.

Queue Method (As1sender Class)

Prepares and queues the message to the specified directory.

Syntax

public void queue(String directory);

Remarks

Invoking Queue will prepare and queue the AS1 message. It will be signed if SigningCert is set, encrypted if RecipientCert is set, and compressed if CompressionFormat is set. A receipt will be requested if MDNTo is set. The queued message can then be sent by invoking ProcessQueue.

ReadReceipt Method (As1sender Class)

Reads and parses (but does not verify) an MDN receipt.

Syntax

public void readReceipt();

Remarks

ReadReceipt will retrieve the file specified by MailMessageNumber from the mail server, store it in MDNReceipt and attempt to parse it as an MDN receipt. If the file is a valid MDN receipt, the class will determine the originator of the receipt and the MessageId of the original message. The originator of the receipt (your trading partner) will be stored in SendTo, the intended recipient (presumably your system) will be stored in From, and the original message Id will be stored in MessageId.

If you are not currently connected to a mail server, the class will process the receipt specified by MDNReceipt.

You should then look up the original message and set OriginalContentMIC to the value of OriginalContentMIC originally computed when the message was sent (you will need to save this information externally). You should also set ReceiptSignerCert based on the value of SendTo if necessary. Also, set MDNOptions to the value used when making the original request.

Finally, VerifyReceipt should be used to verify the receipt.

Reset Method (As1sender Class)

Resets the state of the control.

Syntax

public void reset();

Remarks

Reset resets the state of the class. All properties will be set to their default values.

SelectMailMessage Method (As1sender Class)

Selects and obtains information about the specified message.

Syntax

public void selectMailMessage();

Remarks

This method selects the message specified by MailMessageNumber and retrieves information about it.

After calling this method properties such as MailMessageHeaders, MailMessageDate, MailMessageFrom, etc. will be populated and allow you to determine if this message is an AS1 message. Additional properties are exposed via the Config method.

If this message is an AS1 receipt (MDN), use ReadReceipt to read it. The MDNReceipt will then be populated with the receipt, and SendTo will be populated with the email address of the originator. (From and SendTo correspond to the originator and recipient of the original AS1 transmission.) You may then set trading partner information and invoke VerifyReceipt to verify the receipt.

Send Method (As1sender Class)

Prepares and sends the AS1 message.

Syntax

public void send();

Remarks

Invoking Send will prepare and send the AS1 message. It will be signed if SigningCert is set, encrypted if RecipientCert is set, and compressed if CompressionFormat is set. A receipt will be requested if MDNTo is set.

You should set MailServer prior to sending.

SetRequestHeader Method (As1sender Class)

Allows the user to set or add arbitrary HTTP request headers.

Syntax

public void setRequestHeader(String headerName, String headerValue);

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 Class)

Verifies an MDN receipt.

Syntax

public void verifyReceipt();

Remarks

VerifyReceipt verifies the receipt in MDNReceipt against the values of OriginalContentMIC and MessageId and the preferences specified in MDNOptions. The method operates similarly to Post: After the method finishes, the MDNReceipt, ReceiptSigningProtocol, and ReceiptSignerCert 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 when it is not known which message the receipt is in response to. This will allow you to determine the original MessageId and originator of the receipt before trying to verify it.

ConnectionStatus Event (As1sender Class)

This event is fired to indicate changes in the connection state.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void connectionStatus(As1senderConnectionStatusEvent e) {}
  ...
}

public class As1senderConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

The ConnectionStatus 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:

EndTransfer Event (As1sender Class)

Fired when the message text completes transferring.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void endTransfer(As1senderEndTransferEvent e) {}
  ...
}

public class As1senderEndTransferEvent {
}

Remarks

Fired when the message text completes transferring (on either a send or receive).

Error Event (As1sender Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void error(As1senderErrorEvent e) {}
  ...
}

public class As1senderErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 section.

Header Event (As1sender Class)

This event is fired for every message header being retrieved.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void header(As1senderHeaderEvent e) {}
  ...
}

public class As1senderHeaderEvent {
  public String field;
  public String value;
}

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).

Log Event (As1sender Class)

Fired with log information while processing a message.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void log(As1senderLogEvent e) {}
  ...
}

public class As1senderLogEvent {
  public String logType;
  public byte[] logMessage;
}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory 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:

PITrail Event (As1sender Class)

Traces the commands sent to the mail server, and the respective replies.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void PITrail(As1senderPITrailEvent e) {}
  ...
}

public class As1senderPITrailEvent {
  public int direction;
  public String message;
}

Remarks

The PITrail event is useful for debugging purposes. It shows all 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:

SSLServerAuthentication Event (As1sender Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void SSLServerAuthentication(As1senderSSLServerAuthenticationEvent e) {}
  ...
}

public class As1senderSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

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 Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void SSLStatus(As1senderSSLStatusEvent e) {}
  ...
}

public class As1senderSSLStatusEvent {
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (As1sender Class)

Fired when the message text starts transferring (on either a send or receive).

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void startTransfer(As1senderStartTransferEvent e) {}
  ...
}

public class As1senderStartTransferEvent {
}

Remarks

Fired when the message text starts transferring (on either a send or receive).

Transfer Event (As1sender Class)

Fired while the message text gets transferred to or from MailServer .

Syntax

public class DefaultAs1senderEventListener implements As1senderEventListener {
  ...
  public void transfer(As1senderTransferEvent e) {}
  ...
}

public class As1senderTransferEvent {
  public long bytesTransferred;
}

Remarks

Fired while the message text gets transferred to or from MailServer.

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.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType 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 class 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).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType 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 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 class 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).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType 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 class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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.

Fields

Constructors

public EDIAttachment();

public EDIAttachment( filename);

public EDIAttachment( filename,  contentType);

public EDIAttachment( filename,  contentType,  headers);

EDIData Type

The EDI payload of the AS2 message.

Remarks

The EDI payload of the AS2 message.

Fields

Constructors

public EDIData();

public EDIData( data,  EDIType);

public EDIData( filename,  EDIType);

Firewall Type

The firewall the class 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 and the FirewallType.

Fields

Constructors

public Firewall();

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.

Fields

Constructors

public MDNReceipt();

public MDNReceipt( headers,  content);

Config Settings (As1sender Class)

AS1 Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (As1sender Class)

AS1Sender Errors

POP Errors

TCPClient Errors

TCP/IP Errors

SMTP Errors

TCPClient Errors

TCP/IP Errors

SMIME Errors