AS1Receiver Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AS1Receiver

Remarks

The AS1Receiver class allows you to receive AS1 messages as specified in RFC 3335. The class 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 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 (AS1Receiver Class)

Collection of files attached to the current message.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIEDIAttachment>* GetAttachments();

int ipworksedi_as1receiver_getattachmentcount(void* lpObj);

char* ipworksedi_as1receiver_getattachmentcontenttype(void* lpObj, int attachmentindex);

int ipworksedi_as1receiver_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);

char* ipworksedi_as1receiver_getattachmentfilename(void* lpObj, int attachmentindex);

char* ipworksedi_as1receiver_getattachmentheaders(void* lpObj, int attachmentindex);

char* ipworksedi_as1receiver_getattachmentname(void* lpObj, int attachmentindex);

int getAttachmentCount();

QString getAttachmentContentType(int iAttachmentIndex);

QByteArray getAttachmentData(int iAttachmentIndex);

QString getAttachmentFileName(int iAttachmentIndex);

QString getAttachmentHeaders(int iAttachmentIndex);

QString getAttachmentName(int iAttachmentIndex);

Remarks

When a message is received, the class 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.

Data Type

IPWorksEDIEDIAttachment

Certificate Property (AS1Receiver Class)

The decryption and receipt signing certificate.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetCertificate();
int SetCertificate(IPWorksEDICertificate* val);

char* ipworksedi_as1receiver_getcerteffectivedate(void* lpObj);

char* ipworksedi_as1receiver_getcertexpirationdate(void* lpObj);

char* ipworksedi_as1receiver_getcertextendedkeyusage(void* lpObj);

char* ipworksedi_as1receiver_getcertfingerprint(void* lpObj);

char* ipworksedi_as1receiver_getcertfingerprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getcertfingerprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getcertissuer(void* lpObj);

char* ipworksedi_as1receiver_getcertprivatekey(void* lpObj);

int ipworksedi_as1receiver_getcertprivatekeyavailable(void* lpObj);

char* ipworksedi_as1receiver_getcertprivatekeycontainer(void* lpObj);

char* ipworksedi_as1receiver_getcertpublickey(void* lpObj);

char* ipworksedi_as1receiver_getcertpublickeyalgorithm(void* lpObj);

int ipworksedi_as1receiver_getcertpublickeylength(void* lpObj);

char* ipworksedi_as1receiver_getcertserialnumber(void* lpObj);

char* ipworksedi_as1receiver_getcertsignaturealgorithm(void* lpObj);

int ipworksedi_as1receiver_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_as1receiver_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworksedi_as1receiver_getcertstorepassword(void* lpObj);
int ipworksedi_as1receiver_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworksedi_as1receiver_getcertstoretype(void* lpObj);
int ipworksedi_as1receiver_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworksedi_as1receiver_getcertsubjectaltnames(void* lpObj);

char* ipworksedi_as1receiver_getcertthumbprintmd5(void* lpObj);

char* ipworksedi_as1receiver_getcertthumbprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getcertthumbprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getcertusage(void* lpObj);

int ipworksedi_as1receiver_getcertusageflags(void* lpObj);

char* ipworksedi_as1receiver_getcertversion(void* lpObj);

char* ipworksedi_as1receiver_getcertsubject(void* lpObj);
int ipworksedi_as1receiver_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworksedi_as1receiver_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_as1receiver_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QString getCertEffectiveDate();

QString getCertExpirationDate();

QString getCertExtendedKeyUsage();

QString getCertFingerprint();

QString getCertFingerprintSHA1();

QString getCertFingerprintSHA256();

QString getCertIssuer();

QString getCertPrivateKey();

bool getCertPrivateKeyAvailable();

QString getCertPrivateKeyContainer();

QString getCertPublicKey();

QString getCertPublicKeyAlgorithm();

int getCertPublicKeyLength();

QString getCertSerialNumber();

QString getCertSignatureAlgorithm();

QByteArray getCertStore();
int setCertStore(QByteArray qbaCertStore);

QString getCertStorePassword();
int setCertStorePassword(QString qsCertStorePassword);

int getCertStoreType();
int setCertStoreType(int iCertStoreType);

QString getCertSubjectAltNames();

QString getCertThumbprintMD5();

QString getCertThumbprintSHA1();

QString getCertThumbprintSHA256();

QString getCertUsage();

int getCertUsageFlags();

QString getCertVersion();

QString getCertSubject();
int setCertSubject(QString qsCertSubject);

QByteArray getCertEncoded();
int setCertEncoded(QByteArray qbaCertEncoded);

Remarks

The digital certificate that the class 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.

Data Type

IPWorksEDICertificate

CompressionFormat Property (AS1Receiver Class)

The compression format used on the incoming message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionFormat();

Unicode (Windows)
INT GetCompressionFormat();

CF_NONE(0), 
CF_ZLIB(1)

int ipworksedi_as1receiver_getcompressionformat(void* lpObj);

int getCompressionFormat();

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

Connected Property (AS1Receiver Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksedi_as1receiver_getconnected(void* lpObj);

bool getConnected();

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

EDIData Property (AS1Receiver Class)

The EDI data sent in Request .

Syntax

• C++
• C
• Qt

IPWorksEDIEDIData* GetEDIData();

int ipworksedi_as1receiver_getedidata(void* lpObj, char** lpEDIData, int* lenEDIData);

char* ipworksedi_as1receiver_geteditype(void* lpObj);

char* ipworksedi_as1receiver_getediname(void* lpObj);

char* ipworksedi_as1receiver_getedifilename(void* lpObj);

QByteArray getEDIData();

QString getEDIType();

QString getEDIName();

QString getEDIFileName();

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.

Data Type

IPWorksEDIEDIData

Firewall Property (AS1Receiver Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksEDIFirewall* GetFirewall();
int SetFirewall(IPWorksEDIFirewall* val);

int ipworksedi_as1receiver_getfirewallautodetect(void* lpObj);
int ipworksedi_as1receiver_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksedi_as1receiver_getfirewalltype(void* lpObj);
int ipworksedi_as1receiver_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksedi_as1receiver_getfirewallhost(void* lpObj);
int ipworksedi_as1receiver_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksedi_as1receiver_getfirewallpassword(void* lpObj);
int ipworksedi_as1receiver_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksedi_as1receiver_getfirewallport(void* lpObj);
int ipworksedi_as1receiver_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksedi_as1receiver_getfirewalluser(void* lpObj);
int ipworksedi_as1receiver_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool getFirewallAutoDetect();
int setFirewallAutoDetect(bool bFirewallAutoDetect);

int getFirewallType();
int setFirewallType(int iFirewallType);

QString getFirewallHost();
int setFirewallHost(QString qsFirewallHost);

QString getFirewallPassword();
int setFirewallPassword(QString qsFirewallPassword);

int getFirewallPort();
int setFirewallPort(int iFirewallPort);

QString getFirewallUser();
int setFirewallUser(QString qsFirewallUser);

Remarks

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

Data Type

IPWorksEDIFirewall

From Property (AS1Receiver Class)

The sender of the original message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFrom();
int SetFrom(const char* lpszFrom);

Unicode (Windows)
LPWSTR GetFrom();
INT SetFrom(LPCWSTR lpszFrom);

char* ipworksedi_as1receiver_getfrom(void* lpObj);
int ipworksedi_as1receiver_setfrom(void* lpObj, const char* lpszFrom);

QString getFrom();
int setFrom(QString qsFrom);

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.

Data Type

String

LocalHost Property (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksedi_as1receiver_getlocalhost(void* lpObj);
int ipworksedi_as1receiver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString getLocalHost();
int setLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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

Data Type

String

LogDirectory Property (AS1Receiver Class)

The path to a directory for logging.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogDirectory();
int SetLogDirectory(const char* lpszLogDirectory);

Unicode (Windows)
LPWSTR GetLogDirectory();
INT SetLogDirectory(LPCWSTR lpszLogDirectory);

char* ipworksedi_as1receiver_getlogdirectory(void* lpObj);
int ipworksedi_as1receiver_setlogdirectory(void* lpObj, const char* lpszLogDirectory);

QString getLogDirectory();
int setLogDirectory(QString qsLogDirectory);

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.

Data Type

String

LogFile Property (AS1Receiver Class)

The log file written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();

char* ipworksedi_as1receiver_getlogfile(void* lpObj);

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

Data Type

String

MailMessageCc Property (AS1Receiver Class)

The value of the Cc header of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageCc();

Unicode (Windows)
LPWSTR GetMailMessageCc();

char* ipworksedi_as1receiver_getmailmessagecc(void* lpObj);

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

Data Type

String

MailMessageCount Property (AS1Receiver Class)

The number of messages waiting in the mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailMessageCount();

Unicode (Windows)
INT GetMailMessageCount();

int ipworksedi_as1receiver_getmailmessagecount(void* lpObj);

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.

Data Type

Integer

MailMessageDate Property (AS1Receiver Class)

The message date for the currently selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageDate();

Unicode (Windows)
LPWSTR GetMailMessageDate();

char* ipworksedi_as1receiver_getmailmessagedate(void* lpObj);

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

Data Type

String

MailMessageFrom Property (AS1Receiver Class)

The sender of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageFrom();

Unicode (Windows)
LPWSTR GetMailMessageFrom();

char* ipworksedi_as1receiver_getmailmessagefrom(void* lpObj);

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

Data Type

String

MailMessageHeaders Property (AS1Receiver Class)

The message headers for the currently selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageHeaders();

Unicode (Windows)
LPWSTR GetMailMessageHeaders();

char* ipworksedi_as1receiver_getmailmessageheaders(void* lpObj);

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

Data Type

String

MailMessageNumber Property (AS1Receiver Class)

The message number on the incoming mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailMessageNumber();
int SetMailMessageNumber(int iMailMessageNumber);

Unicode (Windows)
INT GetMailMessageNumber();
INT SetMailMessageNumber(INT iMailMessageNumber);

int ipworksedi_as1receiver_getmailmessagenumber(void* lpObj);
int ipworksedi_as1receiver_setmailmessagenumber(void* lpObj, int iMailMessageNumber);

int getMailMessageNumber();
int setMailMessageNumber(int iMailMessageNumber);

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.

Data Type

Integer

MailMessageReplyTo Property (AS1Receiver Class)

The value of the ReplyTo header of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageReplyTo();

Unicode (Windows)
LPWSTR GetMailMessageReplyTo();

char* ipworksedi_as1receiver_getmailmessagereplyto(void* lpObj);

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

Data Type

String

MailMessageSubject Property (AS1Receiver Class)

The subject of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageSubject();

Unicode (Windows)
LPWSTR GetMailMessageSubject();

char* ipworksedi_as1receiver_getmailmessagesubject(void* lpObj);

QString getMailMessageSubject();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageText Property (AS1Receiver Class)

The text of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageText();

Unicode (Windows)
LPWSTR GetMailMessageText();

char* ipworksedi_as1receiver_getmailmessagetext(void* lpObj);

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

Data Type

String

MailMessageTo Property (AS1Receiver Class)

The recipient of the mail message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailMessageTo();

Unicode (Windows)
LPWSTR GetMailMessageTo();

char* ipworksedi_as1receiver_getmailmessageto(void* lpObj);

QString getMailMessageTo();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailServer Property (AS1Receiver Class)

The address of your mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailServer();
int SetMailServer(const char* lpszMailServer);

Unicode (Windows)
LPWSTR GetMailServer();
INT SetMailServer(LPCWSTR lpszMailServer);

char* ipworksedi_as1receiver_getmailserver(void* lpObj);
int ipworksedi_as1receiver_setmailserver(void* lpObj, const char* lpszMailServer);

QString getMailServer();
int setMailServer(QString qsMailServer);

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.

Data Type

String

MDNReceipt Property (AS1Receiver Class)

The MDN-based receipt generated by the class.

Syntax

• C++
• C
• Qt

IPWorksEDIMDNReceipt* GetMDNReceipt();
int SetMDNReceipt(IPWorksEDIMDNReceipt* val);

int ipworksedi_as1receiver_getmdnreceiptcontent(void* lpObj, char** lpMDNReceiptContent, int* lenMDNReceiptContent);
int ipworksedi_as1receiver_setmdnreceiptcontent(void* lpObj, const char* lpMDNReceiptContent, int lenMDNReceiptContent);

int ipworksedi_as1receiver_getmdnreceiptheadercount(void* lpObj);

char* ipworksedi_as1receiver_getmdnreceiptheaderfield(void* lpObj);

int ipworksedi_as1receiver_getmdnreceiptheaderindex(void* lpObj);
int ipworksedi_as1receiver_setmdnreceiptheaderindex(void* lpObj, int iMDNReceiptHeaderIndex);

char* ipworksedi_as1receiver_getmdnreceiptheaders(void* lpObj);
int ipworksedi_as1receiver_setmdnreceiptheaders(void* lpObj, const char* lpszMDNReceiptHeaders);

char* ipworksedi_as1receiver_getmdnreceiptheadervalue(void* lpObj);

char* ipworksedi_as1receiver_getmdnreceiptmdn(void* lpObj);

char* ipworksedi_as1receiver_getmdnreceiptmessage(void* lpObj);

char* ipworksedi_as1receiver_getmdnreceiptmicvalue(void* lpObj);

char* ipworksedi_as1receiver_getmdnreceiptsigningprotocol(void* lpObj);

QByteArray getMDNReceiptContent();
int setMDNReceiptContent(QByteArray qbaMDNReceiptContent);

int getMDNReceiptHeaderCount();

QString getMDNReceiptHeaderField();

int getMDNReceiptHeaderIndex();
int setMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex);

QString getMDNReceiptHeaders();
int setMDNReceiptHeaders(QString qsMDNReceiptHeaders);

QString getMDNReceiptHeaderValue();

QString getMDNReceiptMDN();

QString getMDNReceiptMessage();

QString getMDNReceiptMICValue();

QString getMDNReceiptSigningProtocol();

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.

Data Type

IPWorksEDIMDNReceipt

MDNTo Property (AS1Receiver Class)

The recipient for the Message Disposition Notification (MDN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNTo();

Unicode (Windows)
LPWSTR GetMDNTo();

char* ipworksedi_as1receiver_getmdnto(void* lpObj);

QString getMDNTo();

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.

Data Type

String

MessageId Property (AS1Receiver Class)

The message ID of the incoming message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();

Unicode (Windows)
LPWSTR GetMessageId();

char* ipworksedi_as1receiver_getmessageid(void* lpObj);

QString getMessageId();

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.

Data Type

String

Password Property (AS1Receiver Class)

The password for your incoming mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksedi_as1receiver_getpassword(void* lpObj);
int ipworksedi_as1receiver_setpassword(void* lpObj, const char* lpszPassword);

QString getPassword();
int setPassword(QString qsPassword);

Default Value

""

Remarks

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

Data Type

String

Request Property (AS1Receiver Class)

The AS1 request to be processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequest(char* &lpRequest, int &lenRequest);
int SetRequest(const char* lpRequest, int lenRequest);

Unicode (Windows)
INT GetRequest(LPSTR &lpRequest, INT &lenRequest);
INT SetRequest(LPCSTR lpRequest, INT lenRequest);

int ipworksedi_as1receiver_getrequest(void* lpObj, char** lpRequest, int* lenRequest);
int ipworksedi_as1receiver_setrequest(void* lpObj, const char* lpRequest, int lenRequest);

QByteArray getRequest();
int setRequest(QByteArray qbaRequest);

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.

Data Type

Binary String

RequestHeaders Property (AS1Receiver Class)

The headers in the AS1 request.

Syntax

• C++
• C
• Qt

IPWorksEDIList<IPWorksEDIHeader>* GetRequestHeaders();
int SetRequestHeaders(IPWorksEDIList<IPWorksEDIHeader>* val);

int ipworksedi_as1receiver_getrequestheadercount(void* lpObj);
int ipworksedi_as1receiver_setrequestheadercount(void* lpObj, int iRequestHeaderCount);

char* ipworksedi_as1receiver_getrequestheaderfield(void* lpObj, int requestheaderindex);
int ipworksedi_as1receiver_setrequestheaderfield(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderField);

char* ipworksedi_as1receiver_getrequestheadervalue(void* lpObj, int requestheaderindex);
int ipworksedi_as1receiver_setrequestheadervalue(void* lpObj, int requestheaderindex, const char* lpszRequestHeaderValue);

int getRequestHeaderCount();
int setRequestHeaderCount(int iRequestHeaderCount);

QString getRequestHeaderField(int iRequestHeaderIndex);
int setRequestHeaderField(int iRequestHeaderIndex, QString qsRequestHeaderField);

QString getRequestHeaderValue(int iRequestHeaderIndex);
int setRequestHeaderValue(int iRequestHeaderIndex, QString qsRequestHeaderValue);

Remarks

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

Data Type

IPWorksEDIHeader

RequestHeadersString Property (AS1Receiver Class)

The headers in the AS1 request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRequestHeadersString();
int SetRequestHeadersString(const char* lpszRequestHeadersString);

Unicode (Windows)
LPWSTR GetRequestHeadersString();
INT SetRequestHeadersString(LPCWSTR lpszRequestHeadersString);

char* ipworksedi_as1receiver_getrequestheadersstring(void* lpObj);
int ipworksedi_as1receiver_setrequestheadersstring(void* lpObj, const char* lpszRequestHeadersString);

QString getRequestHeadersString();
int setRequestHeadersString(QString qsRequestHeadersString);

Default Value

""

Remarks

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

Data Type

String

ScanResult Property (AS1Receiver Class)

The result of invoking ParseRequest .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetScanResult();

Unicode (Windows)
INT GetScanResult();

int ipworksedi_as1receiver_getscanresult(void* lpObj);

int getScanResult();

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.

Data Type

Integer

SendTo Property (AS1Receiver Class)

The recipient of the original message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSendTo();
int SetSendTo(const char* lpszSendTo);

Unicode (Windows)
LPWSTR GetSendTo();
INT SetSendTo(LPCWSTR lpszSendTo);

char* ipworksedi_as1receiver_getsendto(void* lpObj);
int ipworksedi_as1receiver_setsendto(void* lpObj, const char* lpszSendTo);

QString getSendTo();
int setSendTo(QString qsSendTo);

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.

Data Type

String

SignerCert Property (AS1Receiver Class)

Your trading partner's certificate.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSignerCert();
int SetSignerCert(IPWorksEDICertificate* val);

char* ipworksedi_as1receiver_getsignercerteffectivedate(void* lpObj);

char* ipworksedi_as1receiver_getsignercertexpirationdate(void* lpObj);

char* ipworksedi_as1receiver_getsignercertextendedkeyusage(void* lpObj);

char* ipworksedi_as1receiver_getsignercertfingerprint(void* lpObj);

char* ipworksedi_as1receiver_getsignercertfingerprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsignercertfingerprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsignercertissuer(void* lpObj);

char* ipworksedi_as1receiver_getsignercertprivatekey(void* lpObj);

int ipworksedi_as1receiver_getsignercertprivatekeyavailable(void* lpObj);

char* ipworksedi_as1receiver_getsignercertprivatekeycontainer(void* lpObj);

char* ipworksedi_as1receiver_getsignercertpublickey(void* lpObj);

char* ipworksedi_as1receiver_getsignercertpublickeyalgorithm(void* lpObj);

int ipworksedi_as1receiver_getsignercertpublickeylength(void* lpObj);

char* ipworksedi_as1receiver_getsignercertserialnumber(void* lpObj);

char* ipworksedi_as1receiver_getsignercertsignaturealgorithm(void* lpObj);

int ipworksedi_as1receiver_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksedi_as1receiver_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

char* ipworksedi_as1receiver_getsignercertstorepassword(void* lpObj);
int ipworksedi_as1receiver_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

int ipworksedi_as1receiver_getsignercertstoretype(void* lpObj);
int ipworksedi_as1receiver_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

char* ipworksedi_as1receiver_getsignercertsubjectaltnames(void* lpObj);

char* ipworksedi_as1receiver_getsignercertthumbprintmd5(void* lpObj);

char* ipworksedi_as1receiver_getsignercertthumbprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsignercertthumbprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsignercertusage(void* lpObj);

int ipworksedi_as1receiver_getsignercertusageflags(void* lpObj);

char* ipworksedi_as1receiver_getsignercertversion(void* lpObj);

char* ipworksedi_as1receiver_getsignercertsubject(void* lpObj);
int ipworksedi_as1receiver_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

int ipworksedi_as1receiver_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksedi_as1receiver_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QString getSignerCertEffectiveDate();

QString getSignerCertExpirationDate();

QString getSignerCertExtendedKeyUsage();

QString getSignerCertFingerprint();

QString getSignerCertFingerprintSHA1();

QString getSignerCertFingerprintSHA256();

QString getSignerCertIssuer();

QString getSignerCertPrivateKey();

bool getSignerCertPrivateKeyAvailable();

QString getSignerCertPrivateKeyContainer();

QString getSignerCertPublicKey();

QString getSignerCertPublicKeyAlgorithm();

int getSignerCertPublicKeyLength();

QString getSignerCertSerialNumber();

QString getSignerCertSignatureAlgorithm();

QByteArray getSignerCertStore();
int setSignerCertStore(QByteArray qbaSignerCertStore);

QString getSignerCertStorePassword();
int setSignerCertStorePassword(QString qsSignerCertStorePassword);

int getSignerCertStoreType();
int setSignerCertStoreType(int iSignerCertStoreType);

QString getSignerCertSubjectAltNames();

QString getSignerCertThumbprintMD5();

QString getSignerCertThumbprintSHA1();

QString getSignerCertThumbprintSHA256();

QString getSignerCertUsage();

int getSignerCertUsageFlags();

QString getSignerCertVersion();

QString getSignerCertSubject();
int setSignerCertSubject(QString qsSignerCertSubject);

QByteArray getSignerCertEncoded();
int setSignerCertEncoded(QByteArray qbaSignerCertEncoded);

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

Data Type

IPWorksEDICertificate

SSLAcceptServerCert Property (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksEDICertificate* val);

char* ipworksedi_as1receiver_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertissuer(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertprivatekey(void* lpObj);

int ipworksedi_as1receiver_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertpublickey(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksedi_as1receiver_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksedi_as1receiver_getsslacceptservercertstorepassword(void* lpObj);
int ipworksedi_as1receiver_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksedi_as1receiver_getsslacceptservercertstoretype(void* lpObj);
int ipworksedi_as1receiver_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksedi_as1receiver_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertusage(void* lpObj);

int ipworksedi_as1receiver_getsslacceptservercertusageflags(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertversion(void* lpObj);

char* ipworksedi_as1receiver_getsslacceptservercertsubject(void* lpObj);
int ipworksedi_as1receiver_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksedi_as1receiver_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_as1receiver_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString getSSLAcceptServerCertEffectiveDate();

QString getSSLAcceptServerCertExpirationDate();

QString getSSLAcceptServerCertExtendedKeyUsage();

QString getSSLAcceptServerCertFingerprint();

QString getSSLAcceptServerCertFingerprintSHA1();

QString getSSLAcceptServerCertFingerprintSHA256();

QString getSSLAcceptServerCertIssuer();

QString getSSLAcceptServerCertPrivateKey();

bool getSSLAcceptServerCertPrivateKeyAvailable();

QString getSSLAcceptServerCertPrivateKeyContainer();

QString getSSLAcceptServerCertPublicKey();

QString getSSLAcceptServerCertPublicKeyAlgorithm();

int getSSLAcceptServerCertPublicKeyLength();

QString getSSLAcceptServerCertSerialNumber();

QString getSSLAcceptServerCertSignatureAlgorithm();

QByteArray getSSLAcceptServerCertStore();
int setSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString getSSLAcceptServerCertStorePassword();
int setSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int getSSLAcceptServerCertStoreType();
int setSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString getSSLAcceptServerCertSubjectAltNames();

QString getSSLAcceptServerCertThumbprintMD5();

QString getSSLAcceptServerCertThumbprintSHA1();

QString getSSLAcceptServerCertThumbprintSHA256();

QString getSSLAcceptServerCertUsage();

int getSSLAcceptServerCertUsageFlags();

QString getSSLAcceptServerCertVersion();

QString getSSLAcceptServerCertSubject();
int setSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray getSSLAcceptServerCertEncoded();
int setSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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.

NOTE: This functionality is provided only for cases in which 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.

Data Type

IPWorksEDICertificate

SSLCert Property (AS1Receiver Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLCert();
int SetSSLCert(IPWorksEDICertificate* val);

char* ipworksedi_as1receiver_getsslcerteffectivedate(void* lpObj);

char* ipworksedi_as1receiver_getsslcertexpirationdate(void* lpObj);

char* ipworksedi_as1receiver_getsslcertextendedkeyusage(void* lpObj);

char* ipworksedi_as1receiver_getsslcertfingerprint(void* lpObj);

char* ipworksedi_as1receiver_getsslcertfingerprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslcertfingerprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslcertissuer(void* lpObj);

char* ipworksedi_as1receiver_getsslcertprivatekey(void* lpObj);

int ipworksedi_as1receiver_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksedi_as1receiver_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksedi_as1receiver_getsslcertpublickey(void* lpObj);

char* ipworksedi_as1receiver_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslcertpublickeylength(void* lpObj);

char* ipworksedi_as1receiver_getsslcertserialnumber(void* lpObj);

char* ipworksedi_as1receiver_getsslcertsignaturealgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as1receiver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksedi_as1receiver_getsslcertstorepassword(void* lpObj);
int ipworksedi_as1receiver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksedi_as1receiver_getsslcertstoretype(void* lpObj);
int ipworksedi_as1receiver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksedi_as1receiver_getsslcertsubjectaltnames(void* lpObj);

char* ipworksedi_as1receiver_getsslcertthumbprintmd5(void* lpObj);

char* ipworksedi_as1receiver_getsslcertthumbprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslcertthumbprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslcertusage(void* lpObj);

int ipworksedi_as1receiver_getsslcertusageflags(void* lpObj);

char* ipworksedi_as1receiver_getsslcertversion(void* lpObj);

char* ipworksedi_as1receiver_getsslcertsubject(void* lpObj);
int ipworksedi_as1receiver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksedi_as1receiver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as1receiver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString getSSLCertEffectiveDate();

QString getSSLCertExpirationDate();

QString getSSLCertExtendedKeyUsage();

QString getSSLCertFingerprint();

QString getSSLCertFingerprintSHA1();

QString getSSLCertFingerprintSHA256();

QString getSSLCertIssuer();

QString getSSLCertPrivateKey();

bool getSSLCertPrivateKeyAvailable();

QString getSSLCertPrivateKeyContainer();

QString getSSLCertPublicKey();

QString getSSLCertPublicKeyAlgorithm();

int getSSLCertPublicKeyLength();

QString getSSLCertSerialNumber();

QString getSSLCertSignatureAlgorithm();

QByteArray getSSLCertStore();
int setSSLCertStore(QByteArray qbaSSLCertStore);

QString getSSLCertStorePassword();
int setSSLCertStorePassword(QString qsSSLCertStorePassword);

int getSSLCertStoreType();
int setSSLCertStoreType(int iSSLCertStoreType);

QString getSSLCertSubjectAltNames();

QString getSSLCertThumbprintMD5();

QString getSSLCertThumbprintSHA1();

QString getSSLCertThumbprintSHA256();

QString getSSLCertUsage();

int getSSLCertUsageFlags();

QString getSSLCertVersion();

QString getSSLCertSubject();
int setSSLCertSubject(QString qsSSLCertSubject);

QByteArray getSSLCertEncoded();
int setSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes 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.

Data Type

IPWorksEDICertificate

SSLProvider Property (AS1Receiver Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksedi_as1receiver_getsslprovider(void* lpObj);
int ipworksedi_as1receiver_setsslprovider(void* lpObj, int iSSLProvider);

int getSSLProvider();
int setSSLProvider(int iSSLProvider);

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 as follows:

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AS1Receiver Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLServerCert();

char* ipworksedi_as1receiver_getsslservercerteffectivedate(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertexpirationdate(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertfingerprint(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertissuer(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertprivatekey(void* lpObj);

int ipworksedi_as1receiver_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertpublickey(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslservercertpublickeylength(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertserialnumber(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksedi_as1receiver_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksedi_as1receiver_getsslservercertstorepassword(void* lpObj);

int ipworksedi_as1receiver_getsslservercertstoretype(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertusage(void* lpObj);

int ipworksedi_as1receiver_getsslservercertusageflags(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertversion(void* lpObj);

char* ipworksedi_as1receiver_getsslservercertsubject(void* lpObj);

int ipworksedi_as1receiver_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString getSSLServerCertEffectiveDate();

QString getSSLServerCertExpirationDate();

QString getSSLServerCertExtendedKeyUsage();

QString getSSLServerCertFingerprint();

QString getSSLServerCertFingerprintSHA1();

QString getSSLServerCertFingerprintSHA256();

QString getSSLServerCertIssuer();

QString getSSLServerCertPrivateKey();

bool getSSLServerCertPrivateKeyAvailable();

QString getSSLServerCertPrivateKeyContainer();

QString getSSLServerCertPublicKey();

QString getSSLServerCertPublicKeyAlgorithm();

int getSSLServerCertPublicKeyLength();

QString getSSLServerCertSerialNumber();

QString getSSLServerCertSignatureAlgorithm();

QByteArray getSSLServerCertStore();

QString getSSLServerCertStorePassword();

int getSSLServerCertStoreType();

QString getSSLServerCertSubjectAltNames();

QString getSSLServerCertThumbprintMD5();

QString getSSLServerCertThumbprintSHA1();

QString getSSLServerCertThumbprintSHA256();

QString getSSLServerCertUsage();

int getSSLServerCertUsageFlags();

QString getSSLServerCertVersion();

QString getSSLServerCertSubject();

QByteArray getSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksEDICertificate

SSLStartMode Property (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworksedi_as1receiver_getsslstartmode(void* lpObj);
int ipworksedi_as1receiver_setsslstartmode(void* lpObj, int iSSLStartMode);

int getSSLStartMode();
int setSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

User Property (AS1Receiver Class)

The username for your incoming mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksedi_as1receiver_getuser(void* lpObj);
int ipworksedi_as1receiver_setuser(void* lpObj, const char* lpszUser);

QString getUser();
int setUser(QString qsUser);

Default Value

""

Remarks

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

Data Type

String

Config Method (AS1Receiver Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksedi_as1receiver_config(void* lpObj, const char* lpszConfigurationString);

QString config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (AS1Receiver Class)

Connects to the incoming mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksedi_as1receiver_connect(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateMDNReceipt Method (AS1Receiver Class)

Creates MDNReceipt .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateMDNReceipt(const char* lpszHeaders, const char* lpszMDN, const char* lpszMessage);

Unicode (Windows)
INT CreateMDNReceipt(LPCWSTR lpszHeaders, LPCWSTR lpszMDN, LPCWSTR lpszMessage);

int ipworksedi_as1receiver_createmdnreceipt(void* lpObj, const char* lpszHeaders, const char* lpszMDN, const char* lpszMessage);

int createMDNReceipt(const QString& qsHeaders, const QString& qsMDN, const QString& qsMessage);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteMessage Method (AS1Receiver Class)

Deletes the message specified by MailMessageNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteMessage();

Unicode (Windows)
INT DeleteMessage();

int ipworksedi_as1receiver_deletemessage(void* lpObj);

int deleteMessage();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (AS1Receiver Class)

Disconnects from the incoming mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksedi_as1receiver_disconnect(void* lpObj);

int disconnect();

Remarks

Disconnects from the incoming mail server specified by MailServer.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ParseRequest Method (AS1Receiver Class)

Parses the EDI message and determines the EDIData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseRequest();

Unicode (Windows)
INT ParseRequest();

int ipworksedi_as1receiver_parserequest(void* lpObj);

int parseRequest();

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessQueue Method (AS1Receiver Class)

Send the messages queued for sending.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessQueue(const char* lpszDirectory);

Unicode (Windows)
INT ProcessQueue(LPCWSTR lpszDirectory);

int ipworksedi_as1receiver_processqueue(void* lpObj, const char* lpszDirectory);

int processQueue(const QString& qsDirectory);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProcessRequest Method (AS1Receiver Class)

Processes the EDI data, and generates the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessRequest();

Unicode (Windows)
INT ProcessRequest();

int ipworksedi_as1receiver_processrequest(void* lpObj);

int processRequest();

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 class will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

QueryMessageSize Method (AS1Receiver Class)

Returns the size in bytes of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueryMessageSize();

Unicode (Windows)
INT QueryMessageSize();

int ipworksedi_as1receiver_querymessagesize(void* lpObj);

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.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

QueryMessageUID Method (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* QueryMessageUID();

Unicode (Windows)
LPWSTR QueryMessageUID();

char* ipworksedi_as1receiver_querymessageuid(void* lpObj);

QString queryMessageUID();

Remarks

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Queue Method (AS1Receiver Class)

Prepares and queues the message to the specified directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Queue(const char* lpszDirectory);

Unicode (Windows)
INT Queue(LPCWSTR lpszDirectory);

int ipworksedi_as1receiver_queue(void* lpObj, const char* lpszDirectory);

int queue(const QString& qsDirectory);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadRequest Method (AS1Receiver Class)

Reads the AS1 request from the mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadRequest();

Unicode (Windows)
INT ReadRequest();

int ipworksedi_as1receiver_readrequest(void* lpObj);

int readRequest();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (AS1Receiver Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_as1receiver_reset(void* lpObj);

int reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SelectMailMessage Method (AS1Receiver Class)

Selects and obtains information about the specified message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SelectMailMessage();

Unicode (Windows)
INT SelectMailMessage();

int ipworksedi_as1receiver_selectmailmessage(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendResponse Method (AS1Receiver Class)

Sends the MDN receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendResponse();

Unicode (Windows)
INT SendResponse();

int ipworksedi_as1receiver_sendresponse(void* lpObj);

int sendResponse();

Remarks

Sends the MDN receipt specified by MDNReceipt. The receipt will be created when invoking ProcessRequest or CreateMDNReceipt.

By default, the class will assume that the SMTP server is located at the same address as the incoming mail server. The SMTPServer and SMTPPort settings can be used to set a different address or to use a non default port.

A response will only be sent if requested by the client. The MDN will be directed to the From address that sent the request, regardless of the MDNTo value. If MDNTo is empty, this method will do nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectionStatus Event (AS1Receiver Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(AS1ReceiverConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} AS1ReceiverConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(AS1ReceiverConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AS1ReceiverConnectionStatusEventParams;

#define EID_AS1RECEIVER_CONNECTIONSTATUS 1

virtual INT IPWORKSEDI_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class AS1ReceiverConnectionStatusEventParams {
public:
  const QString &connectionEvent();

  int statusCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireConnectionStatus(AS1ReceiverConnectionStatusEventParams *e) {...}
// Or, connect one or more slots to this signal.
void connectionStatus(AS1ReceiverConnectionStatusEventParams *e);

Remarks

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

Fired when the message text completes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(AS1ReceiverEndTransferEventParams *e);

typedef struct {
  int reserved;
} AS1ReceiverEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(AS1ReceiverEndTransferEventParams *e);

typedef struct {
  INT reserved;
} AS1ReceiverEndTransferEventParams;

#define EID_AS1RECEIVER_ENDTRANSFER 2

virtual INT IPWORKSEDI_CALL FireEndTransfer();

class AS1ReceiverEndTransferEventParams {
public:
  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireEndTransfer(AS1ReceiverEndTransferEventParams *e) {...}
// Or, connect one or more slots to this signal.
void endTransfer(AS1ReceiverEndTransferEventParams *e);

Remarks

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

Error Event (AS1Receiver Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AS1ReceiverErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AS1ReceiverErrorEventParams;


Unicode (Windows)
virtual INT FireError(AS1ReceiverErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AS1ReceiverErrorEventParams;

#define EID_AS1RECEIVER_ERROR 3

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AS1ReceiverErrorEventParams {
public:
  int errorCode();

  const QString &description();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireError(AS1ReceiverErrorEventParams *e) {...}
// Or, connect one or more slots to this signal.
void error(AS1ReceiverErrorEventParams *e);

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

This event is fired for every message header being retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AS1ReceiverHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AS1ReceiverHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AS1ReceiverHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AS1ReceiverHeaderEventParams;

#define EID_AS1RECEIVER_HEADER 4

virtual INT IPWORKSEDI_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AS1ReceiverHeaderEventParams {
public:
  const QString &field();

  const QString &value();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireHeader(AS1ReceiverHeaderEventParams *e) {...}
// Or, connect one or more slots to this signal.
void header(AS1ReceiverHeaderEventParams *e);

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

Fired with log information while processing a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AS1ReceiverLogEventParams *e);

typedef struct {
  const char *LogType;
  const char *LogMessage;
  int lenLogMessage;
  int reserved;
} AS1ReceiverLogEventParams;


Unicode (Windows)
virtual INT FireLog(AS1ReceiverLogEventParams *e);

typedef struct {
  LPCWSTR LogType;
  LPCSTR LogMessage;
  INT lenLogMessage;
  INT reserved;
} AS1ReceiverLogEventParams;

#define EID_AS1RECEIVER_LOG 5

virtual INT IPWORKSEDI_CALL FireLog(LPSTR &lpszLogType, LPSTR &lpLogMessage, INT &lenLogMessage);

class AS1ReceiverLogEventParams {
public:
  const QString &logType();

  const QByteArray &logMessage();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireLog(AS1ReceiverLogEventParams *e) {...}
// Or, connect one or more slots to this signal.
void log(AS1ReceiverLogEventParams *e);

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

This event traces the commands sent to the mail server, and the respective replies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(AS1ReceiverPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Message;
  int reserved;
} AS1ReceiverPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(AS1ReceiverPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} AS1ReceiverPITrailEventParams;

#define EID_AS1RECEIVER_PITRAIL 6

virtual INT IPWORKSEDI_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);

class AS1ReceiverPITrailEventParams {
public:
  int direction();

  const QString &message();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int firePITrail(AS1ReceiverPITrailEventParams *e) {...}
// Or, connect one or more slots to this signal.
void PITrail(AS1ReceiverPITrailEventParams *e);

Remarks

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

This event is fired during verification of the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignerCertInfo(AS1ReceiverSignerCertInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  const char *CertEncoded;
  int lenCertEncoded;
  int reserved;
} AS1ReceiverSignerCertInfoEventParams;


Unicode (Windows)
virtual INT FireSignerCertInfo(AS1ReceiverSignerCertInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  INT reserved;
} AS1ReceiverSignerCertInfoEventParams;

#define EID_AS1RECEIVER_SIGNERCERTINFO 7

virtual INT IPWORKSEDI_CALL FireSignerCertInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, LPSTR &lpCertEncoded, INT &lenCertEncoded);

class AS1ReceiverSignerCertInfoEventParams {
public:
  const QString &issuer();

  const QString &serialNumber();

  const QString &subjectKeyIdentifier();

  const QByteArray &certEncoded();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireSignerCertInfo(AS1ReceiverSignerCertInfoEventParams *e) {...}
// Or, connect one or more slots to this signal.
void signerCertInfo(AS1ReceiverSignerCertInfoEventParams *e);

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AS1ReceiverSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AS1ReceiverSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AS1ReceiverSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AS1ReceiverSSLServerAuthenticationEventParams;

#define EID_AS1RECEIVER_SSLSERVERAUTHENTICATION 8

virtual INT IPWORKSEDI_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AS1ReceiverSSLServerAuthenticationEventParams {
public:
  const QByteArray &certEncoded();

  const QString &certSubject();

  const QString &certIssuer();

  const QString &status();

  bool accept();
  void setAccept(bool bAccept);

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireSSLServerAuthentication(AS1ReceiverSSLServerAuthenticationEventParams *e) {...}
// Or, connect one or more slots to this signal.
void SSLServerAuthentication(AS1ReceiverSSLServerAuthenticationEventParams *e);

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AS1ReceiverSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AS1ReceiverSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AS1ReceiverSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AS1ReceiverSSLStatusEventParams;

#define EID_AS1RECEIVER_SSLSTATUS 9

virtual INT IPWORKSEDI_CALL FireSSLStatus(LPSTR &lpszMessage);

class AS1ReceiverSSLStatusEventParams {
public:
  const QString &message();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireSSLStatus(AS1ReceiverSSLStatusEventParams *e) {...}
// Or, connect one or more slots to this signal.
void SSLStatus(AS1ReceiverSSLStatusEventParams *e);

Remarks

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

StartTransfer Event (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(AS1ReceiverStartTransferEventParams *e);

typedef struct {
  int reserved;
} AS1ReceiverStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(AS1ReceiverStartTransferEventParams *e);

typedef struct {
  INT reserved;
} AS1ReceiverStartTransferEventParams;

#define EID_AS1RECEIVER_STARTTRANSFER 10

virtual INT IPWORKSEDI_CALL FireStartTransfer();

class AS1ReceiverStartTransferEventParams {
public:
  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireStartTransfer(AS1ReceiverStartTransferEventParams *e) {...}
// Or, connect one or more slots to this signal.
void startTransfer(AS1ReceiverStartTransferEventParams *e);

Remarks

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

Transfer Event (AS1Receiver Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(AS1ReceiverTransferEventParams *e);

typedef struct {
  int64 BytesTransferred;
  int reserved;
} AS1ReceiverTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(AS1ReceiverTransferEventParams *e);

typedef struct {
  LONG64 BytesTransferred;
  INT reserved;
} AS1ReceiverTransferEventParams;

#define EID_AS1RECEIVER_TRANSFER 11

virtual INT IPWORKSEDI_CALL FireTransfer(LONG64 &lBytesTransferred);

class AS1ReceiverTransferEventParams {
public:
  qint64 bytesTransferred();

  int eventRetVal();
  void setEventRetVal(int iRetVal);
};

// To handle, subclass AS1Receiver and override this emitter function.
virtual int fireTransfer(AS1ReceiverTransferEventParams *e) {...}
// Or, connect one or more slots to this signal.
void transfer(AS1ReceiverTransferEventParams *e);

Remarks

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

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.h)

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.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

EDIAttachment Type

This describes the file being attached.

Syntax

IPWorksEDIEDIAttachment (declared in ipworksedi.h)

Remarks

Information about the file's location that is being attached to the message is contained here.

• ContentType
• Data
• FileName
• Headers
• Name

Fields

Constructors

EDIAttachment()

EDIAttachment(const char* lpszFileName)

EDIAttachment(const char* lpszFileName, const char* lpszContentType)

EDIAttachment(const char* lpszFileName, const char* lpszContentType, const char* lpszHeaders)

EDIData Type

The EDI payload of the AS2 message.

Syntax

IPWorksEDIEDIData (declared in ipworksedi.h)

Remarks

The EDI payload of the AS2 message.

• Data
• EDIType
• Name
• FileName

Fields

Constructors

EDIData()

EDIData(const char* lpData, int lenData, const char* lpszEDIType)

EDIData(const char* lpszFileName, const char* lpszEDIType)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksEDIFirewall (declared in ipworksedi.h)

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.

• AutoDetect
• FirewallType
• Host
• Password
• Port
• User

Fields

Constructors

Firewall()

Header Type

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

Syntax

IPWorksEDIHeader (declared in ipworksedi.h)

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.

• Field
• Value

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

MDNReceipt Type

The complete MDN Receipt returned by the receiver.

Syntax

IPWorksEDIMDNReceipt (declared in ipworksedi.h)

Remarks

The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.

• Content
• HeaderCount
• HeaderField
• HeaderIndex
• Headers
• HeaderValue
• MDN
• Message
• MICValue
• SigningProtocol

Fields

Constructors

MDNReceipt()

MDNReceipt(const char* lpszHeaders, const char* lpContent, int lenContent)

IPWorksEDIList Type

Syntax

IPWorksEDIList<T> (declared in ipworksedi.h)

Remarks

IPWorksEDIList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AS1Receiver class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (AS1Receiver Class)

AS1Receiver Config Settings

AS1 Config Settings

SSL Config Settings

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

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

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

Base Config Settings

Trappable Errors (AS1Receiver Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AS1Receiver Errors

POP Errors

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

TCPClient Errors

TCP/IP Errors

SMTP Errors

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

TCPClient Errors

TCP/IP Errors

SMIME Errors