AS1Receiver Component

Properties   Methods   Events   Config Settings   Errors  

The AS1Receiver component is used to process AS1 messages and generate receipts.

Syntax

nsoftware.IPWorksEDI.As1receiver

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.

Method List

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

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.

Config Settings

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

Attachments Property (AS1Receiver Component)

Collection of files attached to the current message.

Syntax

• C#
• VB.NET

public EDIAttachmentList Attachments { get; }

Public ReadOnly Property Attachments As EDIAttachmentList

Remarks

When a message is received, the component will write all of the files attached to the EDIData into temp files. These attachments can be retrieved by walking this collection and retrieving their file names.

This property is read-only and not available at design time.

Certificate Property (AS1Receiver Component)

The decryption and receipt signing certificate.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As Certificate

Remarks

The digital certificate that the component will use to decrypt incoming transmissions and sign the MDN receipt (if requested). If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling ParseRequest, then set the signing certificate before calling CreateMDNReceipt. Certificate must be set to a private key certificate.

CompressionFormat Property (AS1Receiver Component)

The compression format used on the incoming message.

Syntax

• C#
• VB.NET

public As1receiverCompressionFormats CompressionFormat { get; }

enum As1receiverCompressionFormats {
  cfNone,
  cfZLIB
}

Public ReadOnly Property CompressionFormat As As1receiverCompressionFormats

Enum As1receiverCompressionFormats
  cfNone
  cfZLIB
End Enum

Default Value

0

Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the component.

This property is read-only.

Connected Property (AS1Receiver Component)

This shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component 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 (AS1Receiver Component)

The EDI data sent in Request .

Syntax

• C#
• VB.NET

public EDIData EDIData { get; }

Public ReadOnly Property EDIData As EDIData

Remarks

This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

Firewall Property (AS1Receiver Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

From Property (AS1Receiver Component)

The sender of the original message.

Syntax

• C#
• VB.NET

public string From { get; set; }

Public Property From As String

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 (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

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 component initiate connections (or accept in the case of server components) only through that interface.

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 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 (AS1Receiver Component)

The path to a directory for logging.

Syntax

• C#
• VB.NET

public string LogDirectory { get; set; }

Public Property LogDirectory As String

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 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 (AS1Receiver Component)

The log file written.

Syntax

• C#
• VB.NET

public string LogFile { get; }

Public ReadOnly Property LogFile As String

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 (AS1Receiver Component)

The value of the Cc header of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageCc { get; }

Public ReadOnly Property MailMessageCc As String

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 (AS1Receiver Component)

The number of messages waiting in the mailbox.

Syntax

• C#
• VB.NET

public int MailMessageCount { get; }

Public ReadOnly Property MailMessageCount As Integer

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 to any value between 1 and MailMessageCount to inspect a given message.

This property is read-only.

MailMessageDate Property (AS1Receiver Component)

The message date for the currently selected message.

Syntax

• C#
• VB.NET

public string MailMessageDate { get; }

Public ReadOnly Property MailMessageDate As String

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 (AS1Receiver Component)

The sender of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageFrom { get; }

Public ReadOnly Property MailMessageFrom As String

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 (AS1Receiver Component)

The message headers for the currently selected message.

Syntax

• C#
• VB.NET

public string MailMessageHeaders { get; }

Public ReadOnly Property MailMessageHeaders As String

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 (AS1Receiver Component)

The message number on the incoming mail server.

Syntax

• C#
• VB.NET

public int MailMessageNumber { get; set; }

Public Property MailMessageNumber As Integer

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

This property is not available at design time.

MailMessageReplyTo Property (AS1Receiver Component)

The value of the ReplyTo header of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageReplyTo { get; }

Public ReadOnly Property MailMessageReplyTo As String

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 (AS1Receiver Component)

The size of the mail message.

Syntax

• C#
• VB.NET

public int MailMessageSize { get; }

Public ReadOnly Property MailMessageSize As Integer

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 (AS1Receiver Component)

The subject of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageSubject { get; }

Public ReadOnly Property MailMessageSubject As String

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 (AS1Receiver Component)

The text of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageText { get; }

Public ReadOnly Property MailMessageText As String

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 (AS1Receiver Component)

The recipient of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageTo { get; }

Public ReadOnly Property MailMessageTo As String

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 (AS1Receiver Component)

The unique id of the mail message.

Syntax

• C#
• VB.NET

public string MailMessageUID { get; }

Public ReadOnly Property MailMessageUID As String

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 (AS1Receiver Component)

The address of your mail server.

Syntax

• C#
• VB.NET

public string MailServer { get; set; }

Public Property MailServer As String

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

MDNReceipt Property (AS1Receiver Component)

The MDN-based receipt generated by the component.

Syntax

• C#
• VB.NET

public MDNReceipt MDNReceipt { get; set; }

Public Property MDNReceipt As MDNReceipt

Remarks

After invoking CreateMDNReceipt, MDNReceipt will contain the entire text of the receipt to be returned to the client. It will report either success or failure depending on ScanResult; in either case it will be RFC-compliant and suitable for returning to the client.

The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking CreateMDNReceipt and customized further by setting the parameters to CreateMDNReceipt.

A variety of configuration settings may be used to override the default generation of the outgoing MDN. The MIC algorithm used in the MDN may be set with MDNMICAlgorithm;. MDNReportingUA specifies the reporting agent, and MDNSendingMode may be used to specify the "disposition-mode" field in the MDN.

The signature, if any, will use the protocol specified by the ReceiptSigningProtocol configuration setting, and the certificate specified.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDNReceipt to report a failure to process the message (either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error). Setting ErrorReportingFlags will cause the MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the MDNWarning configuration setting.

MDNReceipt will always be generated by the component; however, if MDNTo is empty, an MDN-based receipt has not been requested. One may be sent anyway at the option of the server. If MDNTo is nonempty, the receipt MUST be returned according to RFC specifications. In AS2, the MDN should be returned in the body of the HTTP reply, or if ReceiptDeliveryOption is nonempty, to the URL specified there instead. In AS3, the MDN should be returned to the URL specified in MDNTo.

MDNTo Property (AS1Receiver Component)

The recipient for the Message Disposition Notification (MDN).

Syntax

• C#
• VB.NET

public string MDNTo { get; }

Public ReadOnly Property MDNTo As String

Default Value

""

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.

According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.

This property is read-only.

MessageId Property (AS1Receiver Component)

The message ID of the incoming message.

Syntax

• C#
• VB.NET

public string MessageId { get; }

Public ReadOnly Property MessageId As String

Default Value

""

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

Password Property (AS1Receiver Component)

The password for your incoming mail server.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

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

Request Property (AS1Receiver Component)

The AS1 request to be processed.

Syntax

• C#
• VB.NET

public string Request { get; set; }
public byte[] RequestB { get; set; }

Public Property Request As String
Public Property RequestB As Byte()

Default Value

""

Remarks

You may specify the request manually, or you may load the request from the mail server by invoking ReadRequest.

The headers generally should be specified separately in RequestHeaders.

RequestHeaders Property (AS1Receiver Component)

The headers in the AS1 request.

Syntax

• C#
• VB.NET

public HeaderList RequestHeaders { get; }

Public Property RequestHeaders As HeaderList

Remarks

The headers will include any and all headers attached by the mail server(s).

RequestHeadersString Property (AS1Receiver Component)

The headers in the AS1 request.

Syntax

• C#
• VB.NET

public string RequestHeadersString { get; set; }

Public Property RequestHeadersString As String

Default Value

""

Remarks

The headers will include any and all headers attached by the mail server(s).

ScanResult Property (AS1Receiver Component)

The result of invoking ParseRequest .

Syntax

• C#
• VB.NET

public int ScanResult { get; }

Public ReadOnly Property ScanResult As Integer

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

This property is read-only.

SendTo Property (AS1Receiver Component)

The recipient of the original message.

Syntax

• C#
• VB.NET

public string SendTo { get; set; }

Public Property SendTo As String

Default Value

""

Remarks

The recipient of the original 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.

SignerCert Property (AS1Receiver Component)

Your trading partner's certificate.

Syntax

• C#
• VB.NET

public Certificate SignerCert { get; set; }

Public Property SignerCert As Certificate

Remarks

You must set your trading partner's certificate before processing any signed messages. This property should be set to a public key certificate.

If the trading partner's identity is unknown, you should first invoke ReadRequest and read the value of AS2To (or for AS3, AS3To). This will allow you to determine the correct certificate to use.

As a special case, you may set AcceptAnySignerCert to true. In this case, the component will attempt to validate the signature without knowing the certificate in advance. This is not recommended for production use, as it poses a security risk.

This property is not available at design time.

SSLAcceptServerCert Property (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

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.

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 (AS1Receiver Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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 field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (AS1Receiver Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public As1receiverSSLProviders SSLProvider { get; set; }

enum As1receiverSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As As1receiverSSLProviders

Enum As1receiverSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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:

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 the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (AS1Receiver Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

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 (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public As1receiverSSLStartModes SSLStartMode { get; set; }

enum As1receiverSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As As1receiverSSLStartModes

Enum As1receiverSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

User Property (AS1Receiver Component)

The username for your incoming mail server.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

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

Config Method (AS1Receiver Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (AS1Receiver Component)

Connects to the incoming mail server.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

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.

CreateMDNReceipt Method (AS1Receiver Component)

Creates MDNReceipt .

Syntax

• C#
• VB.NET

public void CreateMDNReceipt(string headers, string MDN, string message);

Async Version
public async Task CreateMDNReceipt(string headers, string MDN, string message);
public async Task CreateMDNReceipt(string headers, string MDN, string message, CancellationToken cancellationToken);

Public Sub CreateMDNReceipt(ByVal Headers As String, ByVal MDN As String, ByVal Message As String)

Async Version
Public Sub CreateMDNReceipt(ByVal Headers As String, ByVal MDN As String, ByVal Message As String) As Task
Public Sub CreateMDNReceipt(ByVal Headers As String, ByVal MDN As String, ByVal Message As String, cancellationToken As CancellationToken) As Task

Remarks

CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.

This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the component generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

DeleteMessage Method (AS1Receiver Component)

Deletes the message specified by MailMessageNumber .

Syntax

• C#
• VB.NET

public void DeleteMessage();

Async Version
public async Task DeleteMessage();
public async Task DeleteMessage(CancellationToken cancellationToken);

Public Sub DeleteMessage()

Async Version
Public Sub DeleteMessage() As Task
Public Sub DeleteMessage(cancellationToken As CancellationToken) As Task

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 (AS1Receiver Component)

Disconnects from the incoming mail server.

Syntax

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

Disconnects from the incoming mail server specified by MailServer.

ParseRequest Method (AS1Receiver Component)

Parses the EDI message and determines the EDIData .

Syntax

• C#
• VB.NET

public void ParseRequest();

Async Version
public async Task ParseRequest();
public async Task ParseRequest(CancellationToken cancellationToken);

Public Sub ParseRequest()

Async Version
Public Sub ParseRequest() As Task
Public Sub ParseRequest(cancellationToken As CancellationToken) As Task

Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.

If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.

The component may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.

Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.

ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

ProcessQueue Method (AS1Receiver Component)

Send the messages queued for sending.

Syntax

• C#
• VB.NET

public void ProcessQueue(string directory);

Async Version
public async Task ProcessQueue(string directory);
public async Task ProcessQueue(string directory, CancellationToken cancellationToken);

Public Sub ProcessQueue(ByVal Directory As String)

Async Version
Public Sub ProcessQueue(ByVal Directory As String) As Task
Public Sub ProcessQueue(ByVal Directory As String, cancellationToken As CancellationToken) As Task

Remarks

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

ProcessRequest Method (AS1Receiver Component)

Processes the EDI data, and generates the receipt.

Syntax

• C#
• VB.NET

public void ProcessRequest();

Async Version
public async Task ProcessRequest();
public async Task ProcessRequest(CancellationToken cancellationToken);

Public Sub ProcessRequest()

Async Version
Public Sub ProcessRequest() As Task
Public Sub ProcessRequest(cancellationToken As CancellationToken) As Task

Remarks

Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.

The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.

The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.

The component will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

Queue Method (AS1Receiver Component)

Prepares and queues the message to the specified directory.

Syntax

• C#
• VB.NET

public void Queue(string directory);

Async Version
public async Task Queue(string directory);
public async Task Queue(string directory, CancellationToken cancellationToken);

Public Sub Queue(ByVal Directory As String)

Async Version
Public Sub Queue(ByVal Directory As String) As Task
Public Sub Queue(ByVal Directory As String, cancellationToken As CancellationToken) As Task

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.

ReadRequest Method (AS1Receiver Component)

Reads the AS1 request from the mail server.

Syntax

• C#
• VB.NET

public void ReadRequest();

Async Version
public async Task ReadRequest();
public async Task ReadRequest(CancellationToken cancellationToken);

Public Sub ReadRequest()

Async Version
Public Sub ReadRequest() As Task
Public Sub ReadRequest(cancellationToken As CancellationToken) As Task

Remarks

In the Java edition, ReadRequest will retrieve the file specified by MailMessageNumber from the mail server. The request will be stored in Request and the headers in RequestHeaders. The headers will also be parsed as in ParseHeaders, and the appropriate values of From, SendTo, etc., will be populated. After looking up and setting your trading partner information (such as certificates) you may then call ProcessRequest.

Reset Method (AS1Receiver Component)

Resets the state of the control.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SelectMailMessage Method (AS1Receiver Component)

Selects and obtains information about the specified message.

Syntax

• C#
• VB.NET

public void SelectMailMessage();

Async Version
public async Task SelectMailMessage();
public async Task SelectMailMessage(CancellationToken cancellationToken);

Public Sub SelectMailMessage()

Async Version
Public Sub SelectMailMessage() As Task
Public Sub SelectMailMessage(cancellationToken As CancellationToken) As Task

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., 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 transmission, you may use ReadRequest to read it. The Request and RequestHeaders properties will contain the request and request headers, and From will be populated with the originator of the request. You may then set trading partner information and invoke ProcessRequest to process the request.

SendResponse Method (AS1Receiver Component)

Sends the MDN receipt.

Syntax

• C#
• VB.NET

public void SendResponse();

Async Version
public async Task SendResponse();
public async Task SendResponse(CancellationToken cancellationToken);

Public Sub SendResponse()

Async Version
Public Sub SendResponse() As Task
Public Sub SendResponse(cancellationToken As CancellationToken) As Task

Remarks

Sends the MDN receipt specified by MDNReceipt. You may create this receipt by invoking ProcessRequest or CreateMDNReceipt.

By default the component will assume that your SMTP server is located at the same address as your incoming mail server. To set a different address, to use a non default port, see the various Config settings. To use SMTPS (SSL), set the various SSL properties.

A response will only be sent if requested by the client. If MDNTo is empty, this method will do nothing.

ConnectionStatus Event (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, As1receiverConnectionStatusEventArgs e);

public class As1receiverConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As As1receiverConnectionStatusEventArgs)

Public Class As1receiverConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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 (AS1Receiver Component)

Fired when the message text completes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, As1receiverEndTransferEventArgs e);

public class As1receiverEndTransferEventArgs : EventArgs {
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As As1receiverEndTransferEventArgs)

Public Class As1receiverEndTransferEventArgs Inherits EventArgs
End Class

Remarks

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

Error Event (AS1Receiver Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, As1receiverErrorEventArgs e);

public class As1receiverErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As As1receiverErrorEventArgs)

Public Class As1receiverErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

Header Event (AS1Receiver Component)

This event is fired for every message header being retrieved.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, As1receiverHeaderEventArgs e);

public class As1receiverHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As As1receiverHeaderEventArgs)

Public Class As1receiverHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

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 (AS1Receiver Component)

Fired with log information while processing a message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, As1receiverLogEventArgs e);

public class As1receiverLogEventArgs : EventArgs {
  public string LogType { get; }
  public string LogMessage { get; }
  public byte[] LogMessageB { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As As1receiverLogEventArgs)

Public Class As1receiverLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogType As String
  Public ReadOnly Property LogMessage As String
  Public ReadOnly Property LogMessageB As Byte()
End Class

Remarks

This event fires once for each log message generated by the component. 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 (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, As1receiverPITrailEventArgs e);

public class As1receiverPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As As1receiverPITrailEventArgs)

Public Class As1receiverPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Message As String
End Class

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:

SignerCertInfo Event (AS1Receiver Component)

This event is fired during verification of the signed message.

Syntax

• C#
• VB.NET

public event OnSignerCertInfoHandler OnSignerCertInfo;

public delegate void OnSignerCertInfoHandler(object sender, As1receiverSignerCertInfoEventArgs e);

public class As1receiverSignerCertInfoEventArgs : EventArgs {
  public string Issuer { get; }
  public string SerialNumber { get; }
  public string SubjectKeyIdentifier { get; }
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
}

Public Event OnSignerCertInfo As OnSignerCertInfoHandler

Public Delegate Sub OnSignerCertInfoHandler(sender As Object, e As As1receiverSignerCertInfoEventArgs)

Public Class As1receiverSignerCertInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property SerialNumber As String
  Public ReadOnly Property SubjectKeyIdentifier As String
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
End Class

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

Note: When this value is present, the component will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

SSLServerAuthentication Event (AS1Receiver Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, As1receiverSSLServerAuthenticationEventArgs e);

public class As1receiverSSLServerAuthenticationEventArgs : 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; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As As1receiverSSLServerAuthenticationEventArgs)

Public Class As1receiverSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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 (AS1Receiver Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, As1receiverSSLStatusEventArgs e);

public class As1receiverSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As As1receiverSSLStatusEventArgs)

Public Class As1receiverSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, As1receiverStartTransferEventArgs e);

public class As1receiverStartTransferEventArgs : EventArgs {
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As As1receiverStartTransferEventArgs)

Public Class As1receiverStartTransferEventArgs Inherits EventArgs
End Class

Remarks

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

Transfer Event (AS1Receiver Component)

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

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, As1receiverTransferEventArgs e);

public class As1receiverTransferEventArgs : EventArgs {
  public long BytesTransferred { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As As1receiverTransferEventArgs)

Public Class As1receiverTransferEventArgs Inherits EventArgs
  Public ReadOnly Property BytesTransferred As Long
End Class

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

• C#
• VB.NET

public Certificate();

Public Certificate()

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

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

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

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

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

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

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

• C#
• VB.NET

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

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

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 component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

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

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

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

Fields

Constructors

• C#
• VB.NET

public EDIAttachment();

Public EDIAttachment()

• C#
• VB.NET

public EDIAttachment(string filename);

Public EDIAttachment(ByVal Filename As String)

• C#
• VB.NET

public EDIAttachment(string filename, string contentType);

Public EDIAttachment(ByVal Filename As String, ByVal ContentType As String)

• C#
• VB.NET

public EDIAttachment(string filename, string contentType, string headers);

Public EDIAttachment(ByVal Filename As String, ByVal ContentType As String, ByVal Headers As String)

EDIData Type

The EDI payload of the AS2 message.

Remarks

The EDI payload of the AS2 message.

Fields

Constructors

• C#
• VB.NET

public EDIData();

Public EDIData()

• C#
• VB.NET

public EDIData(byte[] data, string EDIType);

Public EDIData(ByVal Data As Byte(), ByVal EDIType As String)

• C#
• VB.NET

public EDIData(string filename, string EDIType);

Public EDIData(ByVal Filename As String, ByVal EDIType As String)

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

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

• C#
• VB.NET

public MDNReceipt();

Public MDNReceipt()

• C#
• VB.NET

public MDNReceipt(string headers, byte[] content);

Public MDNReceipt(ByVal Headers As String, ByVal Content As Byte())

Config Settings (AS1Receiver Component)

AS1Receiver Config Settings

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 (AS1Receiver Component)

AS1Receiver Errors

POP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors

SMTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors

SMIME Errors