AS2Sender Class

Properties   Methods   Events   Config Settings   Errors  

The AS2Sender class implements an AS2 / EDI-INT client.

Syntax

AS2Sender

Remarks

The AS2Sender component may be used to send EDI or other messages over HTTP/S, using the AS2 protocol. It may also be used to verify synchronous or asynchronous server responses.

A typical AS2 transaction is as follows:

(1) The sender sends an EDI document to the receiver using HTTP or HTTPS. Typically the document will be signed and encrypted (particularly if SSL is not used). A signed receipt will also be requested.

(2) The receiver decrypts the message and verifies the signature.

(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.

When sending an EDI message, the client should specify, at a minimum, AS2From and AS2To, URL, and EDIData. The Post method should then be invoked.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCerts. If the recipient uses different certificates for signing and encryption it will also be necessary to set ReceiptSignerCert.

SSL will also be used if the scheme in URL is "https". If your trading partner is using a self-signed certificate, it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.

The message may also be compressed by setting CompressionFormat.

To request a receipt, or Message Disposition Notification (MDN), simply set the MDNTo property. The MDNOptions property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash.

The class supports both synchronous and asynchronous MDN receipt delivery. By default, the class requests synchronous MDN receipt delivery, and the MDN will be returned in the HTTP reply. To request asynchronous MDN delivery, set the MDNDeliveryOption to the URL where MDN's are to be delivered.

The HTTP reply will automatically be processed by the class. If an MDN was requested, Post will validate the MDN and (if signed) establish non-repudiation of receipt. Any errors or warnings will cause the class to throw an exception.

In either case, after the EDI transaction is processed successfully, the MDNReceipt will be populated with the appropriate values.

Validating Asynchronous MDNs

The class may also be used to process and verify asynchronous MDNs. To do this, you should invoke ReadAsyncReceipt. This will read the receipt from the current HTTP context (or from MDNReceipt, if set manually), and allow you to determine your trading partner's identity and the message ID. You should then set ReceiptSignerCert and OriginalContentMIC, and finally invoke VerifyReceipt.

Property List

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

Method List

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

Event List

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

Config Settings

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

AS2From Property (AS2Sender Class)

The AS2 Identifier of the sending system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS2From();
int SetAS2From(const char* lpszAS2From);

Unicode (Windows)
LPWSTR GetAS2From();
INT SetAS2From(LPCWSTR lpszAS2From);

char* ipworksedi_as2sender_getas2from(void* lpObj);
int ipworksedi_as2sender_setas2from(void* lpObj, const char* lpszAS2From);

QString GetAS2From();
int SetAS2From(QString qsAS2From);

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

Data Type

String

AS2To Property (AS2Sender Class)

The AS2 Identifier of the receiving system.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS2To();
int SetAS2To(const char* lpszAS2To);

Unicode (Windows)
LPWSTR GetAS2To();
INT SetAS2To(LPCWSTR lpszAS2To);

char* ipworksedi_as2sender_getas2to(void* lpObj);
int ipworksedi_as2sender_setas2to(void* lpObj, const char* lpszAS2To);

QString GetAS2To();
int SetAS2To(QString qsAS2To);

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

Data Type

String

AS2Version Property (AS2Sender Class)

The version of AS2 being used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAS2Version();

Unicode (Windows)
LPWSTR GetAS2Version();

char* ipworksedi_as2sender_getas2version(void* lpObj);

QString GetAS2Version();

Default Value

"1.2"

Remarks

The version of AS2 being used.

This property is read-only.

Data Type

String

AsyncMDNInfoDir Property (AS2Sender Class)

Path to a directory to store data used in verifying AsyncMDNs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAsyncMDNInfoDir();
int SetAsyncMDNInfoDir(const char* lpszAsyncMDNInfoDir);

Unicode (Windows)
LPWSTR GetAsyncMDNInfoDir();
INT SetAsyncMDNInfoDir(LPCWSTR lpszAsyncMDNInfoDir);

char* ipworksedi_as2sender_getasyncmdninfodir(void* lpObj);
int ipworksedi_as2sender_setasyncmdninfodir(void* lpObj, const char* lpszAsyncMDNInfoDir);

QString GetAsyncMDNInfoDir();
int SetAsyncMDNInfoDir(QString qsAsyncMDNInfoDir);

Default Value

""

Remarks

If Post is invoked after setting AsyncMDNInfoDir and an asynchronous MDN is requested, the class stores the data required to verify AsyncMDNs in a file in the specified directory. The name of the file is the MessageId of the outgoing message.

AsyncMDNInfoDir is also used while verifying asynchronous MDNs using VerifyReceipt. The properties required to process AsyncMDNs, namely OriginalContentMIC and MDNOptions, are automatically read from the file saved at the time of sending the original message.

Data Type

String

AttachmentCount Property (AS2Sender Class)

The number of records in the Attachment arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

Unicode (Windows)
INT GetAttachmentCount();
INT SetAttachmentCount(INT iAttachmentCount);

int ipworksedi_as2sender_getattachmentcount(void* lpObj);
int ipworksedi_as2sender_setattachmentcount(void* lpObj, int iAttachmentCount);

int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFilename
• AttachmentHeaders
• AttachmentName

The array indices start at 0 and end at AttachmentCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (AS2Sender Class)

The MIME content-type of this ediattachment .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentContentType(int iAttachmentIndex);
int SetAttachmentContentType(int iAttachmentIndex, const char* lpszAttachmentContentType);

Unicode (Windows)
LPWSTR GetAttachmentContentType(INT iAttachmentIndex);
INT SetAttachmentContentType(INT iAttachmentIndex, LPCWSTR lpszAttachmentContentType);

char* ipworksedi_as2sender_getattachmentcontenttype(void* lpObj, int attachmentindex);
int ipworksedi_as2sender_setattachmentcontenttype(void* lpObj, int attachmentindex, const char* lpszAttachmentContentType);

QString GetAttachmentContentType(int iAttachmentIndex);
int SetAttachmentContentType(int iAttachmentIndex, QString qsAttachmentContentType);

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentData Property (AS2Sender Class)

This property contains the attachment data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachmentData(int iAttachmentIndex, char* &lpAttachmentData, int &lenAttachmentData);
int SetAttachmentData(int iAttachmentIndex, const char* lpAttachmentData, int lenAttachmentData);

Unicode (Windows)
INT GetAttachmentData(INT iAttachmentIndex, LPSTR &lpAttachmentData, INT &lenAttachmentData);
INT SetAttachmentData(INT iAttachmentIndex, LPCSTR lpAttachmentData, INT lenAttachmentData);

int ipworksedi_as2sender_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int ipworksedi_as2sender_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);

Default Value

""

Remarks

This property contains the attachment data.

In a receiver, the class decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Binary String

AttachmentFilename Property (AS2Sender Class)

The file name of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentFilename(int iAttachmentIndex);
int SetAttachmentFilename(int iAttachmentIndex, const char* lpszAttachmentFilename);

Unicode (Windows)
LPWSTR GetAttachmentFilename(INT iAttachmentIndex);
INT SetAttachmentFilename(INT iAttachmentIndex, LPCWSTR lpszAttachmentFilename);

char* ipworksedi_as2sender_getattachmentfilename(void* lpObj, int attachmentindex);
int ipworksedi_as2sender_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFilename);

QString GetAttachmentFilename(int iAttachmentIndex);
int SetAttachmentFilename(int iAttachmentIndex, QString qsAttachmentFilename);

Default Value

""

Remarks

The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentHeaders Property (AS2Sender Class)

The class fills out Headers each time any of the other properties for that ediattachment are changed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentHeaders(int iAttachmentIndex);
int SetAttachmentHeaders(int iAttachmentIndex, const char* lpszAttachmentHeaders);

Unicode (Windows)
LPWSTR GetAttachmentHeaders(INT iAttachmentIndex);
INT SetAttachmentHeaders(INT iAttachmentIndex, LPCWSTR lpszAttachmentHeaders);

char* ipworksedi_as2sender_getattachmentheaders(void* lpObj, int attachmentindex);
int ipworksedi_as2sender_setattachmentheaders(void* lpObj, int attachmentindex, const char* lpszAttachmentHeaders);

QString GetAttachmentHeaders(int iAttachmentIndex);
int SetAttachmentHeaders(int iAttachmentIndex, QString qsAttachmentHeaders);

Default Value

""

Remarks

The class fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (AS2Sender Class)

Name is the final name to be associated with the contents of either the Data or Filename properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, const char* lpszAttachmentName);

Unicode (Windows)
LPWSTR GetAttachmentName(INT iAttachmentIndex);
INT SetAttachmentName(INT iAttachmentIndex, LPCWSTR lpszAttachmentName);

char* ipworksedi_as2sender_getattachmentname(void* lpObj, int attachmentindex);
int ipworksedi_as2sender_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

Default Value

""

Remarks

AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFilename properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

CEMCount Property (AS2Sender Class)

The number of records in the CEM arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCount();
int SetCEMCount(int iCEMCount);

Unicode (Windows)
INT GetCEMCount();
INT SetCEMCount(INT iCEMCount);

int ipworksedi_as2sender_getcemcount(void* lpObj);
int ipworksedi_as2sender_setcemcount(void* lpObj, int iCEMCount);

int GetCEMCount();
int SetCEMCount(int iCEMCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CEMAccepted
• CEMCertId
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertStore
• CEMCertStorePassword
• CEMCertStoreType
• CEMCertSubject
• CEMCertUsage
• CEMRejectionReason
• CEMRespondByDate
• CEMResponseURL

The array indices start at 0 and end at CEMCount - 1.

This property is not available at design time.

Data Type

Integer

CEMAccepted Property (AS2Sender Class)

Whether the CEM request is accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMAccepted(int iCEMIndex);
int SetCEMAccepted(int iCEMIndex, int bCEMAccepted);

Unicode (Windows)
BOOL GetCEMAccepted(INT iCEMIndex);
INT SetCEMAccepted(INT iCEMIndex, BOOL bCEMAccepted);

int ipworksedi_as2sender_getcemaccepted(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemaccepted(void* lpObj, int cemindex, int bCEMAccepted);

bool GetCEMAccepted(int iCEMIndex);
int SetCEMAccepted(int iCEMIndex, bool bCEMAccepted);

Default Value

FALSE

Remarks

Whether the CEM request is accepted.

Before calling SendCEMResponse set this to True to accept the CEM request.

When processing a CEM response check this property to determine if the request was accepted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Boolean

CEMCertId Property (AS2Sender Class)

A user defined identifier for the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertId(int iCEMIndex);
int SetCEMCertId(int iCEMIndex, const char* lpszCEMCertId);

Unicode (Windows)
LPWSTR GetCEMCertId(INT iCEMIndex);
INT SetCEMCertId(INT iCEMIndex, LPCWSTR lpszCEMCertId);

char* ipworksedi_as2sender_getcemcertid(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertid(void* lpObj, int cemindex, const char* lpszCEMCertId);

QString GetCEMCertId(int iCEMIndex);
int SetCEMCertId(int iCEMIndex, QString qsCEMCertId);

Default Value

""

Remarks

A user defined identifier for the certificate.

This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".

This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.

This property may be queried when received a CEM request or response with AS2Receiver.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertIssuer Property (AS2Sender Class)

This property holds the issuer of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertIssuer(int iCEMIndex);
int SetCEMCertIssuer(int iCEMIndex, const char* lpszCEMCertIssuer);

Unicode (Windows)
LPWSTR GetCEMCertIssuer(INT iCEMIndex);
INT SetCEMCertIssuer(INT iCEMIndex, LPCWSTR lpszCEMCertIssuer);

char* ipworksedi_as2sender_getcemcertissuer(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertissuer(void* lpObj, int cemindex, const char* lpszCEMCertIssuer);

QString GetCEMCertIssuer(int iCEMIndex);
int SetCEMCertIssuer(int iCEMIndex, QString qsCEMCertIssuer);

Default Value

""

Remarks

This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertSerialNumber Property (AS2Sender Class)

This property holds the serial number of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertSerialNumber(int iCEMIndex);
int SetCEMCertSerialNumber(int iCEMIndex, const char* lpszCEMCertSerialNumber);

Unicode (Windows)
LPWSTR GetCEMCertSerialNumber(INT iCEMIndex);
INT SetCEMCertSerialNumber(INT iCEMIndex, LPCWSTR lpszCEMCertSerialNumber);

char* ipworksedi_as2sender_getcemcertserialnumber(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertserialnumber(void* lpObj, int cemindex, const char* lpszCEMCertSerialNumber);

QString GetCEMCertSerialNumber(int iCEMIndex);
int SetCEMCertSerialNumber(int iCEMIndex, QString qsCEMCertSerialNumber);

Default Value

""

Remarks

This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStore Property (AS2Sender Class)

The name of the certificate store for the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertStore(int iCEMIndex, char* &lpCEMCertStore, int &lenCEMCertStore);
int SetCEMCertStore(int iCEMIndex, const char* lpCEMCertStore, int lenCEMCertStore);

Unicode (Windows)
INT GetCEMCertStore(INT iCEMIndex, LPSTR &lpCEMCertStore, INT &lenCEMCertStore);
INT SetCEMCertStore(INT iCEMIndex, LPCSTR lpCEMCertStore, INT lenCEMCertStore);

int ipworksedi_as2sender_getcemcertstore(void* lpObj, int cemindex, char** lpCEMCertStore, int* lenCEMCertStore);
int ipworksedi_as2sender_setcemcertstore(void* lpObj, int cemindex, const char* lpCEMCertStore, int lenCEMCertStore);

QByteArray GetCEMCertStore(int iCEMIndex);
int SetCEMCertStore(int iCEMIndex, QByteArray qbaCEMCertStore);

Default Value

"MY"

Remarks

The name of the certificate store for the certificate.

This property defines the store location for the type specified by CEMCertStoreType.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Binary String

CEMCertStorePassword Property (AS2Sender Class)

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertStorePassword(int iCEMIndex);
int SetCEMCertStorePassword(int iCEMIndex, const char* lpszCEMCertStorePassword);

Unicode (Windows)
LPWSTR GetCEMCertStorePassword(INT iCEMIndex);
INT SetCEMCertStorePassword(INT iCEMIndex, LPCWSTR lpszCEMCertStorePassword);

char* ipworksedi_as2sender_getcemcertstorepassword(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertstorepassword(void* lpObj, int cemindex, const char* lpszCEMCertStorePassword);

QString GetCEMCertStorePassword(int iCEMIndex);
int SetCEMCertStorePassword(int iCEMIndex, QString qsCEMCertStorePassword);

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStoreType Property (AS2Sender Class)

The type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertStoreType(int iCEMIndex);
int SetCEMCertStoreType(int iCEMIndex, int iCEMCertStoreType);

Unicode (Windows)
INT GetCEMCertStoreType(INT iCEMIndex);
INT SetCEMCertStoreType(INT iCEMIndex, INT iCEMCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getcemcertstoretype(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertstoretype(void* lpObj, int cemindex, int iCEMCertStoreType);

int GetCEMCertStoreType(int iCEMIndex);
int SetCEMCertStoreType(int iCEMIndex, int iCEMCertStoreType);

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMCertSubject Property (AS2Sender Class)

The subject of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMCertSubject(int iCEMIndex);
int SetCEMCertSubject(int iCEMIndex, const char* lpszCEMCertSubject);

Unicode (Windows)
LPWSTR GetCEMCertSubject(INT iCEMIndex);
INT SetCEMCertSubject(INT iCEMIndex, LPCWSTR lpszCEMCertSubject);

char* ipworksedi_as2sender_getcemcertsubject(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertsubject(void* lpObj, int cemindex, const char* lpszCEMCertSubject);

QString GetCEMCertSubject(int iCEMIndex);
int SetCEMCertSubject(int iCEMIndex, QString qsCEMCertSubject);

Default Value

""

Remarks

The subject of the certificate.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertUsage Property (AS2Sender Class)

This property defines which usages are applicable to the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCEMCertUsage(int iCEMIndex);
int SetCEMCertUsage(int iCEMIndex, int iCEMCertUsage);

Unicode (Windows)
INT GetCEMCertUsage(INT iCEMIndex);
INT SetCEMCertUsage(INT iCEMIndex, INT iCEMCertUsage);

int ipworksedi_as2sender_getcemcertusage(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemcertusage(void* lpObj, int cemindex, int iCEMCertUsage);

int GetCEMCertUsage(int iCEMIndex);
int SetCEMCertUsage(int iCEMIndex, int iCEMCertUsage);

Default Value

15

Remarks

This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:

• 1 (TLS Client)
• 2 (TLS Server)
• 4 (Encryption)
• 8 (Signature)

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMRejectionReason Property (AS2Sender Class)

If Accepted is False this property specifies the reason a request was rejected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMRejectionReason(int iCEMIndex);
int SetCEMRejectionReason(int iCEMIndex, const char* lpszCEMRejectionReason);

Unicode (Windows)
LPWSTR GetCEMRejectionReason(INT iCEMIndex);
INT SetCEMRejectionReason(INT iCEMIndex, LPCWSTR lpszCEMRejectionReason);

char* ipworksedi_as2sender_getcemrejectionreason(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemrejectionreason(void* lpObj, int cemindex, const char* lpszCEMRejectionReason);

QString GetCEMRejectionReason(int iCEMIndex);
int SetCEMRejectionReason(int iCEMIndex, QString qsCEMRejectionReason);

Default Value

""

Remarks

If CEMAccepted is False this property specifies the reason a request was rejected.

When using AS2Sender this may be set to a string value which the recipient will see.

When using AS2Receiver query this property for details on why the request was rejected.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMRespondByDate Property (AS2Sender Class)

This property specifies the date by which the other party should respond.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMRespondByDate(int iCEMIndex);
int SetCEMRespondByDate(int iCEMIndex, const char* lpszCEMRespondByDate);

Unicode (Windows)
LPWSTR GetCEMRespondByDate(INT iCEMIndex);
INT SetCEMRespondByDate(INT iCEMIndex, LPCWSTR lpszCEMRespondByDate);

char* ipworksedi_as2sender_getcemrespondbydate(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemrespondbydate(void* lpObj, int cemindex, const char* lpszCEMRespondByDate);

QString GetCEMRespondByDate(int iCEMIndex);
int SetCEMRespondByDate(int iCEMIndex, QString qsCEMRespondByDate);

Default Value

""

Remarks

This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.

The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

When using AS2Sender set this before calling SendCEMRequest.

When using AS2Receiver this property may be queried.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMResponseURL Property (AS2Sender Class)

This property defines the URL to which the response should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCEMResponseURL(int iCEMIndex);
int SetCEMResponseURL(int iCEMIndex, const char* lpszCEMResponseURL);

Unicode (Windows)
LPWSTR GetCEMResponseURL(INT iCEMIndex);
INT SetCEMResponseURL(INT iCEMIndex, LPCWSTR lpszCEMResponseURL);

char* ipworksedi_as2sender_getcemresponseurl(void* lpObj, int cemindex);
int ipworksedi_as2sender_setcemresponseurl(void* lpObj, int cemindex, const char* lpszCEMResponseURL);

QString GetCEMResponseURL(int iCEMIndex);
int SetCEMResponseURL(int iCEMIndex, QString qsCEMResponseURL);

Default Value

""

Remarks

This property defines the URL to which the response should be sent.

When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.

When using AS2Receiver query this property to determine the URL where the response should be sent.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CompressionFormat Property (AS2Sender Class)

The compression format (if any) to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCompressionFormat();
int SetCompressionFormat(int iCompressionFormat);

Unicode (Windows)
INT GetCompressionFormat();
INT SetCompressionFormat(INT iCompressionFormat);

CF_NONE(0), 
CF_ZLIB(1)

int ipworksedi_as2sender_getcompressionformat(void* lpObj);
int ipworksedi_as2sender_setcompressionformat(void* lpObj, int iCompressionFormat);

int GetCompressionFormat();
int SetCompressionFormat(int iCompressionFormat);

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the class to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

Data Type

Integer

CookieCount Property (AS2Sender Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Unicode (Windows)
INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);

int ipworksedi_as2sender_getcookiecount(void* lpObj);
int ipworksedi_as2sender_setcookiecount(void* lpObj, int iCookieCount);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (AS2Sender Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

char* ipworksedi_as2sender_getcookiedomain(void* lpObj, int cookieindex);

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (AS2Sender Class)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

char* ipworksedi_as2sender_getcookieexpiration(void* lpObj, int cookieindex);

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (AS2Sender Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName);

Unicode (Windows)
LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);

char* ipworksedi_as2sender_getcookiename(void* lpObj, int cookieindex);
int ipworksedi_as2sender_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (AS2Sender Class)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

char* ipworksedi_as2sender_getcookiepath(void* lpObj, int cookieindex);

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (AS2Sender Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworksedi_as2sender_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (AS2Sender Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue);

Unicode (Windows)
LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);

char* ipworksedi_as2sender_getcookievalue(void* lpObj, int cookieindex);
int ipworksedi_as2sender_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

EDIData Property (AS2Sender Class)

This property contains the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEDIData(char* &lpEDIData, int &lenEDIData);
int SetEDIData(const char* lpEDIData, int lenEDIData);

Unicode (Windows)
INT GetEDIData(LPSTR &lpEDIData, INT &lenEDIData);
INT SetEDIData(LPCSTR lpEDIData, INT lenEDIData);

int ipworksedi_as2sender_getedidata(void* lpObj, char** lpEDIData, int* lenEDIData);
int ipworksedi_as2sender_setedidata(void* lpObj, const char* lpEDIData, int lenEDIData);

QByteArray GetEDIData();
int SetEDIData(QByteArray qbaEDIData);

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.

The EDI message to send.

This property is not available at design time.

Data Type

Binary String

EDIType Property (AS2Sender Class)

The Content-Type of the EDI message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIType();
int SetEDIType(const char* lpszEDIType);

Unicode (Windows)
LPWSTR GetEDIType();
INT SetEDIType(LPCWSTR lpszEDIType);

char* ipworksedi_as2sender_geteditype(void* lpObj);
int ipworksedi_as2sender_seteditype(void* lpObj, const char* lpszEDIType);

QString GetEDIType();
int SetEDIType(QString qsEDIType);

Default Value

""

Remarks

The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".

This property is not available at design time.

Data Type

String

EDIFilename Property (AS2Sender Class)

In a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIFilename();
int SetEDIFilename(const char* lpszEDIFilename);

Unicode (Windows)
LPWSTR GetEDIFilename();
INT SetEDIFilename(LPCWSTR lpszEDIFilename);

char* ipworksedi_as2sender_getedifilename(void* lpObj);
int ipworksedi_as2sender_setedifilename(void* lpObj, const char* lpszEDIFilename);

QString GetEDIFilename();
int SetEDIFilename(QString qsEDIFilename);

Default Value

""

Remarks

In a sender, if EDIFilename is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

This property is not available at design time.

Data Type

String

EDIName Property (AS2Sender Class)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEDIName();
int SetEDIName(const char* lpszEDIName);

Unicode (Windows)
LPWSTR GetEDIName();
INT SetEDIName(LPCWSTR lpszEDIName);

char* ipworksedi_as2sender_getediname(void* lpObj);
int ipworksedi_as2sender_setediname(void* lpObj, const char* lpszEDIName);

QString GetEDIName();
int SetEDIName(QString qsEDIName);

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AS2Sender Class)

The algorithm used to encrypt the EDI data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm);

Unicode (Windows)
LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);

char* ipworksedi_as2sender_getencryptionalgorithm(void* lpObj);
int ipworksedi_as2sender_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);

QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);

Default Value

"3DES"

Remarks

If RecipientCerts contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The class supports "3DES", or industry-standard 168-bit Triple-DES encryption.

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

Possible values are:

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

Data Type

String

Etag Property (AS2Sender Class)

The Etag of the file being sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEtag();
int SetEtag(const char* lpszEtag);

Unicode (Windows)
LPWSTR GetEtag();
INT SetEtag(LPCWSTR lpszEtag);

char* ipworksedi_as2sender_getetag(void* lpObj);
int ipworksedi_as2sender_setetag(void* lpObj, const char* lpszEtag);

QString GetEtag();
int SetEtag(QString qsEtag);

Default Value

""

Remarks

This specifies the Etag for the file. This value should be set to an empty string the first time a file is sent using the Restart command. The class will generate a unique Etag based on the processed contents of the file and set this property when sending begins.

If a file is interrupted, this value must be set when Restart is called to resume transfer of the already processed file.

Data Type

String

FirewallAutoDetect Property (AS2Sender Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksedi_as2sender_getfirewallautodetect(void* lpObj);
int ipworksedi_as2sender_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AS2Sender Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksedi_as2sender_getfirewalltype(void* lpObj);
int ipworksedi_as2sender_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AS2Sender Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksedi_as2sender_getfirewallhost(void* lpObj);
int ipworksedi_as2sender_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (AS2Sender Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksedi_as2sender_getfirewallpassword(void* lpObj);
int ipworksedi_as2sender_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AS2Sender Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksedi_as2sender_getfirewallport(void* lpObj);
int ipworksedi_as2sender_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AS2Sender Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksedi_as2sender_getfirewalluser(void* lpObj);
int ipworksedi_as2sender_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

From Property (AS2Sender Class)

The email address of the HTTP agent (optional).

Syntax

• C++
• C
• Qt

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

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

char* ipworksedi_as2sender_getfrom(void* lpObj);
int ipworksedi_as2sender_setfrom(void* lpObj, const char* lpszFrom);

QString GetFrom();
int SetFrom(QString qsFrom);

Default Value

""

Remarks

If the From property contains a non-empty string, an HTTP From: header is added to the request. This header generally gives the email address of the requester of the document.

This property is not available at design time.

Data Type

String

LocalHost Property (AS2Sender 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_as2sender_getlocalhost(void* lpObj);
int ipworksedi_as2sender_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LogDirectory Property (AS2Sender 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_as2sender_getlogdirectory(void* lpObj);
int ipworksedi_as2sender_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 complete text of the outgoing request and the incoming response.

The class will write multiple log file for each transmission, with separate extensions for each type of data:

One or more of these logs may be disabled by setting the LogOptions configuration setting.

LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the class will attempt to create the directory. The following macros are supported:

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.

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS2Sender Class)

The log file written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();

char* ipworksedi_as2sender_getlogfile(void* lpObj);

QString GetLogFile();

Default Value

""

Remarks

If LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension.

The class will write multiple log files for each transmission, with separate extensions for each type of data:

This property is read-only.

Data Type

String

MDNDeliveryOption Property (AS2Sender Class)

A URL indicating how the receipt is to be delivered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNDeliveryOption();
int SetMDNDeliveryOption(const char* lpszMDNDeliveryOption);

Unicode (Windows)
LPWSTR GetMDNDeliveryOption();
INT SetMDNDeliveryOption(LPCWSTR lpszMDNDeliveryOption);

char* ipworksedi_as2sender_getmdndeliveryoption(void* lpObj);
int ipworksedi_as2sender_setmdndeliveryoption(void* lpObj, const char* lpszMDNDeliveryOption);

QString GetMDNDeliveryOption();
int SetMDNDeliveryOption(QString qsMDNDeliveryOption);

Default Value

""

Remarks

The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "http", "https", or "mailto".

If MDNDeliveryOption is set to an empty string, the receipt will be returned synchronously, and will be processed automatically by the class. Clients requesting asynchronous delivery should provide their own processing for reading receipts.

Data Type

String

MDNOptions Property (AS2Sender Class)

Used to indicate the options requested for the MDN receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNOptions();
int SetMDNOptions(const char* lpszMDNOptions);

Unicode (Windows)
LPWSTR GetMDNOptions();
INT SetMDNOptions(LPCWSTR lpszMDNOptions);

char* ipworksedi_as2sender_getmdnoptions(void* lpObj);
int ipworksedi_as2sender_setmdnoptions(void* lpObj, const char* lpszMDNOptions);

QString GetMDNOptions();
int SetMDNOptions(QString qsMDNOptions);

Default Value

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

Remarks

By default, the class will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard.

Set MDNOptions to an empty string to request an unsigned receipt.

This property will automatically be updated when SignatureAlgorithm is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value.

The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

Data Type

String

MDNReceiptContent Property (AS2Sender Class)

This contains the entire content of the MDN Receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptContent(char* &lpMDNReceiptContent, int &lenMDNReceiptContent);
int SetMDNReceiptContent(const char* lpMDNReceiptContent, int lenMDNReceiptContent);

Unicode (Windows)
INT GetMDNReceiptContent(LPSTR &lpMDNReceiptContent, INT &lenMDNReceiptContent);
INT SetMDNReceiptContent(LPCSTR lpMDNReceiptContent, INT lenMDNReceiptContent);

int ipworksedi_as2sender_getmdnreceiptcontent(void* lpObj, char** lpMDNReceiptContent, int* lenMDNReceiptContent);
int ipworksedi_as2sender_setmdnreceiptcontent(void* lpObj, const char* lpMDNReceiptContent, int lenMDNReceiptContent);

QByteArray GetMDNReceiptContent();
int SetMDNReceiptContent(QByteArray qbaMDNReceiptContent);

Default Value

""

Remarks

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

Data Type

Binary String

MDNReceiptHeaderCount Property (AS2Sender Class)

The number of headers in the MDN.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptHeaderCount();

Unicode (Windows)
INT GetMDNReceiptHeaderCount();

int ipworksedi_as2sender_getmdnreceiptheadercount(void* lpObj);

int GetMDNReceiptHeaderCount();

Default Value

0

Remarks

The number of headers in the MDN.

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

Data Type

Integer

MDNReceiptHeaderField Property (AS2Sender Class)

The property name of the MDN header currently selected by HeaderIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaderField();

Unicode (Windows)
LPWSTR GetMDNReceiptHeaderField();

char* ipworksedi_as2sender_getmdnreceiptheaderfield(void* lpObj);

QString GetMDNReceiptHeaderField();

Default Value

""

Remarks

The field name of the MDN header currently selected by MDNReceiptHeaderIndex.

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

Data Type

String

MDNReceiptHeaderIndex Property (AS2Sender Class)

Which MDN header is currently selected to populate HeaderField and HeaderValue .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMDNReceiptHeaderIndex();
int SetMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex);

Unicode (Windows)
INT GetMDNReceiptHeaderIndex();
INT SetMDNReceiptHeaderIndex(INT iMDNReceiptHeaderIndex);

int ipworksedi_as2sender_getmdnreceiptheaderindex(void* lpObj);
int ipworksedi_as2sender_setmdnreceiptheaderindex(void* lpObj, int iMDNReceiptHeaderIndex);

int GetMDNReceiptHeaderIndex();
int SetMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex);

Default Value

0

Remarks

Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.

Valid values are 0 to MDNReceiptHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MDNReceiptHeaders Property (AS2Sender Class)

Headers contains all of the headers of the AS2 MDN Receipt as a single string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaders();
int SetMDNReceiptHeaders(const char* lpszMDNReceiptHeaders);

Unicode (Windows)
LPWSTR GetMDNReceiptHeaders();
INT SetMDNReceiptHeaders(LPCWSTR lpszMDNReceiptHeaders);

char* ipworksedi_as2sender_getmdnreceiptheaders(void* lpObj);
int ipworksedi_as2sender_setmdnreceiptheaders(void* lpObj, const char* lpszMDNReceiptHeaders);

QString GetMDNReceiptHeaders();
int SetMDNReceiptHeaders(QString qsMDNReceiptHeaders);

Default Value

""

Remarks

Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).

You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.

Data Type

String

MDNReceiptHeaderValue Property (AS2Sender Class)

The value of the MDN header currently selected by HeaderIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptHeaderValue();

Unicode (Windows)
LPWSTR GetMDNReceiptHeaderValue();

char* ipworksedi_as2sender_getmdnreceiptheadervalue(void* lpObj);

QString GetMDNReceiptHeaderValue();

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

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

Data Type

String

MDNReceiptMDN Property (AS2Sender Class)

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMDN();

Unicode (Windows)
LPWSTR GetMDNReceiptMDN();

char* ipworksedi_as2sender_getmdnreceiptmdn(void* lpObj);

QString GetMDNReceiptMDN();

Default Value

""

Remarks

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.

This property is read-only.

Data Type

String

MDNReceiptMessage Property (AS2Sender Class)

The human-readable portion of the MDN receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMessage();

Unicode (Windows)
LPWSTR GetMDNReceiptMessage();

char* ipworksedi_as2sender_getmdnreceiptmessage(void* lpObj);

QString GetMDNReceiptMessage();

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.

This property is read-only.

Data Type

String

MDNReceiptMICValue Property (AS2Sender Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptMICValue();

Unicode (Windows)
LPWSTR GetMDNReceiptMICValue();

char* ipworksedi_as2sender_getmdnreceiptmicvalue(void* lpObj);

QString GetMDNReceiptMICValue();

Default Value

""

Remarks

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

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".

This property is read-only.

Data Type

String

MDNReceiptSigningProtocol Property (AS2Sender Class)

This property contains the MIME type of the signature used, if any (i.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNReceiptSigningProtocol();

Unicode (Windows)
LPWSTR GetMDNReceiptSigningProtocol();

char* ipworksedi_as2sender_getmdnreceiptsigningprotocol(void* lpObj);

QString GetMDNReceiptSigningProtocol();

Default Value

""

Remarks

This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

String

MDNTo Property (AS2Sender Class)

Used to indicate that a message disposition notification is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMDNTo();
int SetMDNTo(const char* lpszMDNTo);

Unicode (Windows)
LPWSTR GetMDNTo();
INT SetMDNTo(LPCWSTR lpszMDNTo);

char* ipworksedi_as2sender_getmdnto(void* lpObj);
int ipworksedi_as2sender_setmdnto(void* lpObj, const char* lpszMDNTo);

QString GetMDNTo();
int SetMDNTo(QString qsMDNTo);

Default Value

""

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. The value may be an email address, URL, etc., and while its presence is used to determine whether or not an MDN is sent, the value itself will typically be ignored by the server.

By default, the class will request a PKCS#7 signature and synchronous delivery. You may set MDNDeliveryOption to request an asynchronous MDN, and you may set MDNOptions to request a different type of signature, or no signature at all.

Data Type

String

MessageId Property (AS2Sender Class)

The Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();
int SetMessageId(const char* lpszMessageId);

Unicode (Windows)
LPWSTR GetMessageId();
INT SetMessageId(LPCWSTR lpszMessageId);

char* ipworksedi_as2sender_getmessageid(void* lpObj);
int ipworksedi_as2sender_setmessageid(void* lpObj, const char* lpszMessageId);

QString GetMessageId();
int SetMessageId(QString qsMessageId);

Default Value

""

Remarks

The Id format is as in RFC 2822: id-left@id-right .

A unique Id will automatically be generated on startup. Sending a message will reset id-left if the MessageId has been used in the previous message.

If you set MessageId to a string of the form "@(id-right)" a unique id-left will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same id-right.

After an MDNReceipt is returned or set, MessageId will contain the Original-Message-ID found in the MDN Receipt.

This property is not available at design time.

Data Type

String

OriginalContentMIC Property (AS2Sender Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginalContentMIC();
int SetOriginalContentMIC(const char* lpszOriginalContentMIC);

Unicode (Windows)
LPWSTR GetOriginalContentMIC();
INT SetOriginalContentMIC(LPCWSTR lpszOriginalContentMIC);

char* ipworksedi_as2sender_getoriginalcontentmic(void* lpObj);
int ipworksedi_as2sender_setoriginalcontentmic(void* lpObj, const char* lpszOriginalContentMIC);

QString GetOriginalContentMIC();
int SetOriginalContentMIC(QString qsOriginalContentMIC);

Default Value

""

Remarks

A MIC will be calculated over the outgoing message using the same algorithm in the SignatureAlgorithm configuration used to sign the message. The property will be set when Post (in AS3, Send) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs.

The format is in RFC 3335, i.e. "w7AguNJEmhF/qIjJw6LnnA==, md5", with a newline at the end.

If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use AsyncMDNInfoDir).

Data Type

String

ProxyAuthScheme Property (AS2Sender Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int ipworksedi_as2sender_getproxyauthscheme(void* lpObj);
int ipworksedi_as2sender_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AS2Sender Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int ipworksedi_as2sender_getproxyautodetect(void* lpObj);
int ipworksedi_as2sender_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AS2Sender Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* ipworksedi_as2sender_getproxypassword(void* lpObj);
int ipworksedi_as2sender_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AS2Sender Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int ipworksedi_as2sender_getproxyport(void* lpObj);
int ipworksedi_as2sender_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AS2Sender Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* ipworksedi_as2sender_getproxyserver(void* lpObj);
int ipworksedi_as2sender_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AS2Sender Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int ipworksedi_as2sender_getproxyssl(void* lpObj);
int ipworksedi_as2sender_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AS2Sender Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* ipworksedi_as2sender_getproxyuser(void* lpObj);
int ipworksedi_as2sender_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReceiptSignerCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceiptSignerCertEncoded(char* &lpReceiptSignerCertEncoded, int &lenReceiptSignerCertEncoded);
int SetReceiptSignerCertEncoded(const char* lpReceiptSignerCertEncoded, int lenReceiptSignerCertEncoded);

Unicode (Windows)
INT GetReceiptSignerCertEncoded(LPSTR &lpReceiptSignerCertEncoded, INT &lenReceiptSignerCertEncoded);
INT SetReceiptSignerCertEncoded(LPCSTR lpReceiptSignerCertEncoded, INT lenReceiptSignerCertEncoded);

int ipworksedi_as2sender_getreceiptsignercertencoded(void* lpObj, char** lpReceiptSignerCertEncoded, int* lenReceiptSignerCertEncoded);
int ipworksedi_as2sender_setreceiptsignercertencoded(void* lpObj, const char* lpReceiptSignerCertEncoded, int lenReceiptSignerCertEncoded);

QByteArray GetReceiptSignerCertEncoded();
int SetReceiptSignerCertEncoded(QByteArray qbaReceiptSignerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ReceiptSignerCertStore and ReceiptSignerCertSubject properties also may be used to specify a certificate.

When ReceiptSignerCertEncoded is set, a search is initiated in the current ReceiptSignerCertStore for the private key of the certificate. If the key is found, ReceiptSignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, ReceiptSignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

ReceiptSignerCertStore Property (AS2Sender Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceiptSignerCertStore(char* &lpReceiptSignerCertStore, int &lenReceiptSignerCertStore);
int SetReceiptSignerCertStore(const char* lpReceiptSignerCertStore, int lenReceiptSignerCertStore);

Unicode (Windows)
INT GetReceiptSignerCertStore(LPSTR &lpReceiptSignerCertStore, INT &lenReceiptSignerCertStore);
INT SetReceiptSignerCertStore(LPCSTR lpReceiptSignerCertStore, INT lenReceiptSignerCertStore);

int ipworksedi_as2sender_getreceiptsignercertstore(void* lpObj, char** lpReceiptSignerCertStore, int* lenReceiptSignerCertStore);
int ipworksedi_as2sender_setreceiptsignercertstore(void* lpObj, const char* lpReceiptSignerCertStore, int lenReceiptSignerCertStore);

QByteArray GetReceiptSignerCertStore();
int SetReceiptSignerCertStore(QByteArray qbaReceiptSignerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ReceiptSignerCertStoreType property denotes the type of the certificate store specified by ReceiptSignerCertStore. If the store is password protected, specify the password in ReceiptSignerCertStorePassword.

ReceiptSignerCertStore is used in conjunction with the ReceiptSignerCertSubject property to specify client certificates. If ReceiptSignerCertStore has a value, and ReceiptSignerCertSubject or ReceiptSignerCertEncoded is set, a search for a certificate is initiated. Please see the ReceiptSignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

ReceiptSignerCertStorePassword Property (AS2Sender Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceiptSignerCertStorePassword();
int SetReceiptSignerCertStorePassword(const char* lpszReceiptSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetReceiptSignerCertStorePassword();
INT SetReceiptSignerCertStorePassword(LPCWSTR lpszReceiptSignerCertStorePassword);

char* ipworksedi_as2sender_getreceiptsignercertstorepassword(void* lpObj);
int ipworksedi_as2sender_setreceiptsignercertstorepassword(void* lpObj, const char* lpszReceiptSignerCertStorePassword);

QString GetReceiptSignerCertStorePassword();
int SetReceiptSignerCertStorePassword(QString qsReceiptSignerCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ReceiptSignerCertStoreType Property (AS2Sender Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceiptSignerCertStoreType();
int SetReceiptSignerCertStoreType(int iReceiptSignerCertStoreType);

Unicode (Windows)
INT GetReceiptSignerCertStoreType();
INT SetReceiptSignerCertStoreType(INT iReceiptSignerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getreceiptsignercertstoretype(void* lpObj);
int ipworksedi_as2sender_setreceiptsignercertstoretype(void* lpObj, int iReceiptSignerCertStoreType);

int GetReceiptSignerCertStoreType();
int SetReceiptSignerCertStoreType(int iReceiptSignerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

ReceiptSignerCertSubject Property (AS2Sender Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceiptSignerCertSubject();
int SetReceiptSignerCertSubject(const char* lpszReceiptSignerCertSubject);

Unicode (Windows)
LPWSTR GetReceiptSignerCertSubject();
INT SetReceiptSignerCertSubject(LPCWSTR lpszReceiptSignerCertSubject);

char* ipworksedi_as2sender_getreceiptsignercertsubject(void* lpObj);
int ipworksedi_as2sender_setreceiptsignercertsubject(void* lpObj, const char* lpszReceiptSignerCertSubject);

QString GetReceiptSignerCertSubject();
int SetReceiptSignerCertSubject(QString qsReceiptSignerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

RecipientCertCount Property (AS2Sender Class)

The number of records in the RecipientCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

Unicode (Windows)
INT GetRecipientCertCount();
INT SetRecipientCertCount(INT iRecipientCertCount);

int ipworksedi_as2sender_getrecipientcertcount(void* lpObj);
int ipworksedi_as2sender_setrecipientcertcount(void* lpObj, int iRecipientCertCount);

int GetRecipientCertCount();
int SetRecipientCertCount(int iRecipientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject

The array indices start at 0 and end at RecipientCertCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertEncoded(int iRecipientCertIndex, char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(int iRecipientCertIndex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

Unicode (Windows)
INT GetRecipientCertEncoded(INT iRecipientCertIndex, LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(INT iRecipientCertIndex, LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);

int ipworksedi_as2sender_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksedi_as2sender_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);

QByteArray GetRecipientCertEncoded(int iRecipientCertIndex);
int SetRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (AS2Sender Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStore(int iRecipientCertIndex, char* &lpRecipientCertStore, int &lenRecipientCertStore);
int SetRecipientCertStore(int iRecipientCertIndex, const char* lpRecipientCertStore, int lenRecipientCertStore);

Unicode (Windows)
INT GetRecipientCertStore(INT iRecipientCertIndex, LPSTR &lpRecipientCertStore, INT &lenRecipientCertStore);
INT SetRecipientCertStore(INT iRecipientCertIndex, LPCSTR lpRecipientCertStore, INT lenRecipientCertStore);

int ipworksedi_as2sender_getrecipientcertstore(void* lpObj, int recipientcertindex, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksedi_as2sender_setrecipientcertstore(void* lpObj, int recipientcertindex, const char* lpRecipientCertStore, int lenRecipientCertStore);

QByteArray GetRecipientCertStore(int iRecipientCertIndex);
int SetRecipientCertStore(int iRecipientCertIndex, QByteArray qbaRecipientCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (AS2Sender Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, const char* lpszRecipientCertStorePassword);

Unicode (Windows)
LPWSTR GetRecipientCertStorePassword(INT iRecipientCertIndex);
INT SetRecipientCertStorePassword(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertStorePassword);

char* ipworksedi_as2sender_getrecipientcertstorepassword(void* lpObj, int recipientcertindex);
int ipworksedi_as2sender_setrecipientcertstorepassword(void* lpObj, int recipientcertindex, const char* lpszRecipientCertStorePassword);

QString GetRecipientCertStorePassword(int iRecipientCertIndex);
int SetRecipientCertStorePassword(int iRecipientCertIndex, QString qsRecipientCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (AS2Sender Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);

Unicode (Windows)
INT GetRecipientCertStoreType(INT iRecipientCertIndex);
INT SetRecipientCertStoreType(INT iRecipientCertIndex, INT iRecipientCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getrecipientcertstoretype(void* lpObj, int recipientcertindex);
int ipworksedi_as2sender_setrecipientcertstoretype(void* lpObj, int recipientcertindex, int iRecipientCertStoreType);

int GetRecipientCertStoreType(int iRecipientCertIndex);
int SetRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (AS2Sender Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, const char* lpszRecipientCertSubject);

Unicode (Windows)
LPWSTR GetRecipientCertSubject(INT iRecipientCertIndex);
INT SetRecipientCertSubject(INT iRecipientCertIndex, LPCWSTR lpszRecipientCertSubject);

char* ipworksedi_as2sender_getrecipientcertsubject(void* lpObj, int recipientcertindex);
int ipworksedi_as2sender_setrecipientcertsubject(void* lpObj, int recipientcertindex, const char* lpszRecipientCertSubject);

QString GetRecipientCertSubject(int iRecipientCertIndex);
int SetRecipientCertSubject(int iRecipientCertIndex, QString qsRecipientCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.

This property is not available at design time.

Data Type

String

RestartDirectory Property (AS2Sender Class)

The directory to log cached files when using AS2 restart functionality.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRestartDirectory();
int SetRestartDirectory(const char* lpszRestartDirectory);

Unicode (Windows)
LPWSTR GetRestartDirectory();
INT SetRestartDirectory(LPCWSTR lpszRestartDirectory);

char* ipworksedi_as2sender_getrestartdirectory(void* lpObj);
int ipworksedi_as2sender_setrestartdirectory(void* lpObj, const char* lpszRestartDirectory);

QString GetRestartDirectory();
int SetRestartDirectory(QString qsRestartDirectory);

Default Value

""

Remarks

If this property is set, the class will cache all data to the RestartDirectory. Thus, when sending a file is interrupted, the class can restart the transmission of the file starting where it was interrupted.

To use this functionality, simply set the RestartDirectory and call Restart.

When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.

NOTE: This directory will not automatically be cleaned up.

Data Type

String

RolloverSigningCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverSigningCertEncoded(char* &lpRolloverSigningCertEncoded, int &lenRolloverSigningCertEncoded);
int SetRolloverSigningCertEncoded(const char* lpRolloverSigningCertEncoded, int lenRolloverSigningCertEncoded);

Unicode (Windows)
INT GetRolloverSigningCertEncoded(LPSTR &lpRolloverSigningCertEncoded, INT &lenRolloverSigningCertEncoded);
INT SetRolloverSigningCertEncoded(LPCSTR lpRolloverSigningCertEncoded, INT lenRolloverSigningCertEncoded);

int ipworksedi_as2sender_getrolloversigningcertencoded(void* lpObj, char** lpRolloverSigningCertEncoded, int* lenRolloverSigningCertEncoded);
int ipworksedi_as2sender_setrolloversigningcertencoded(void* lpObj, const char* lpRolloverSigningCertEncoded, int lenRolloverSigningCertEncoded);

QByteArray GetRolloverSigningCertEncoded();
int SetRolloverSigningCertEncoded(QByteArray qbaRolloverSigningCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RolloverSigningCertStore and RolloverSigningCertSubject properties also may be used to specify a certificate.

When RolloverSigningCertEncoded is set, a search is initiated in the current RolloverSigningCertStore for the private key of the certificate. If the key is found, RolloverSigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RolloverSigningCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

RolloverSigningCertStore Property (AS2Sender Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverSigningCertStore(char* &lpRolloverSigningCertStore, int &lenRolloverSigningCertStore);
int SetRolloverSigningCertStore(const char* lpRolloverSigningCertStore, int lenRolloverSigningCertStore);

Unicode (Windows)
INT GetRolloverSigningCertStore(LPSTR &lpRolloverSigningCertStore, INT &lenRolloverSigningCertStore);
INT SetRolloverSigningCertStore(LPCSTR lpRolloverSigningCertStore, INT lenRolloverSigningCertStore);

int ipworksedi_as2sender_getrolloversigningcertstore(void* lpObj, char** lpRolloverSigningCertStore, int* lenRolloverSigningCertStore);
int ipworksedi_as2sender_setrolloversigningcertstore(void* lpObj, const char* lpRolloverSigningCertStore, int lenRolloverSigningCertStore);

QByteArray GetRolloverSigningCertStore();
int SetRolloverSigningCertStore(QByteArray qbaRolloverSigningCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RolloverSigningCertStoreType property denotes the type of the certificate store specified by RolloverSigningCertStore. If the store is password protected, specify the password in RolloverSigningCertStorePassword.

RolloverSigningCertStore is used in conjunction with the RolloverSigningCertSubject property to specify client certificates. If RolloverSigningCertStore has a value, and RolloverSigningCertSubject or RolloverSigningCertEncoded is set, a search for a certificate is initiated. Please see the RolloverSigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

RolloverSigningCertStorePassword Property (AS2Sender Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRolloverSigningCertStorePassword();
int SetRolloverSigningCertStorePassword(const char* lpszRolloverSigningCertStorePassword);

Unicode (Windows)
LPWSTR GetRolloverSigningCertStorePassword();
INT SetRolloverSigningCertStorePassword(LPCWSTR lpszRolloverSigningCertStorePassword);

char* ipworksedi_as2sender_getrolloversigningcertstorepassword(void* lpObj);
int ipworksedi_as2sender_setrolloversigningcertstorepassword(void* lpObj, const char* lpszRolloverSigningCertStorePassword);

QString GetRolloverSigningCertStorePassword();
int SetRolloverSigningCertStorePassword(QString qsRolloverSigningCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

RolloverSigningCertStoreType Property (AS2Sender Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRolloverSigningCertStoreType();
int SetRolloverSigningCertStoreType(int iRolloverSigningCertStoreType);

Unicode (Windows)
INT GetRolloverSigningCertStoreType();
INT SetRolloverSigningCertStoreType(INT iRolloverSigningCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getrolloversigningcertstoretype(void* lpObj);
int ipworksedi_as2sender_setrolloversigningcertstoretype(void* lpObj, int iRolloverSigningCertStoreType);

int GetRolloverSigningCertStoreType();
int SetRolloverSigningCertStoreType(int iRolloverSigningCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

RolloverSigningCertSubject Property (AS2Sender Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRolloverSigningCertSubject();
int SetRolloverSigningCertSubject(const char* lpszRolloverSigningCertSubject);

Unicode (Windows)
LPWSTR GetRolloverSigningCertSubject();
INT SetRolloverSigningCertSubject(LPCWSTR lpszRolloverSigningCertSubject);

char* ipworksedi_as2sender_getrolloversigningcertsubject(void* lpObj);
int ipworksedi_as2sender_setrolloversigningcertsubject(void* lpObj, const char* lpszRolloverSigningCertSubject);

QString GetRolloverSigningCertSubject();
int SetRolloverSigningCertSubject(QString qsRolloverSigningCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SignatureAlgorithm Property (AS2Sender Class)

Signature algorithm to be used in outgoing messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignatureAlgorithm();
int SetSignatureAlgorithm(const char* lpszSignatureAlgorithm);

Unicode (Windows)
LPWSTR GetSignatureAlgorithm();
INT SetSignatureAlgorithm(LPCWSTR lpszSignatureAlgorithm);

char* ipworksedi_as2sender_getsignaturealgorithm(void* lpObj);
int ipworksedi_as2sender_setsignaturealgorithm(void* lpObj, const char* lpszSignatureAlgorithm);

QString GetSignatureAlgorithm();
int SetSignatureAlgorithm(QString qsSignatureAlgorithm);

Default Value

"sha-256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

• sha1
• md5
• sha-256 (or sha256) (default)
• sha-384 (or sha384)
• sha-512 (or sha512)
• sha-224 (or sha224)

The default value is "sha-256". When this property is set the MDNOptions property is automatically updated to request the MDN receipt be signed with the same algorithm.

Data Type

String

SigningCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertEncoded(char* &lpSigningCertEncoded, int &lenSigningCertEncoded);
int SetSigningCertEncoded(const char* lpSigningCertEncoded, int lenSigningCertEncoded);

Unicode (Windows)
INT GetSigningCertEncoded(LPSTR &lpSigningCertEncoded, INT &lenSigningCertEncoded);
INT SetSigningCertEncoded(LPCSTR lpSigningCertEncoded, INT lenSigningCertEncoded);

int ipworksedi_as2sender_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as2sender_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);

QByteArray GetSigningCertEncoded();
int SetSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SigningCertStore Property (AS2Sender Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertStore(char* &lpSigningCertStore, int &lenSigningCertStore);
int SetSigningCertStore(const char* lpSigningCertStore, int lenSigningCertStore);

Unicode (Windows)
INT GetSigningCertStore(LPSTR &lpSigningCertStore, INT &lenSigningCertStore);
INT SetSigningCertStore(LPCSTR lpSigningCertStore, INT lenSigningCertStore);

int ipworksedi_as2sender_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as2sender_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);

QByteArray GetSigningCertStore();
int SetSigningCertStore(QByteArray qbaSigningCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SigningCertStorePassword Property (AS2Sender Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertStorePassword();
int SetSigningCertStorePassword(const char* lpszSigningCertStorePassword);

Unicode (Windows)
LPWSTR GetSigningCertStorePassword();
INT SetSigningCertStorePassword(LPCWSTR lpszSigningCertStorePassword);

char* ipworksedi_as2sender_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as2sender_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);

QString GetSigningCertStorePassword();
int SetSigningCertStorePassword(QString qsSigningCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SigningCertStoreType Property (AS2Sender Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

Unicode (Windows)
INT GetSigningCertStoreType();
INT SetSigningCertStoreType(INT iSigningCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getsigningcertstoretype(void* lpObj);
int ipworksedi_as2sender_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);

int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SigningCertSubject Property (AS2Sender Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningCertSubject();
int SetSigningCertSubject(const char* lpszSigningCertSubject);

Unicode (Windows)
LPWSTR GetSigningCertSubject();
INT SetSigningCertSubject(LPCWSTR lpszSigningCertSubject);

char* ipworksedi_as2sender_getsigningcertsubject(void* lpObj);
int ipworksedi_as2sender_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);

QString GetSigningCertSubject();
int SetSigningCertSubject(QString qsSigningCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksedi_as2sender_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_as2sender_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AS2Sender Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksedi_as2sender_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as2sender_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AS2Sender Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksedi_as2sender_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as2sender_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AS2Sender Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksedi_as2sender_getsslcertstorepassword(void* lpObj);
int ipworksedi_as2sender_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AS2Sender Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_as2sender_getsslcertstoretype(void* lpObj);
int ipworksedi_as2sender_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.