AS1Sender Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AS1Sender

Remarks

The AS1Sender component is used to send EDI or other messages over SMTP/S, using the AS1 protocol specified in RFC 3335. The class is also used to retrieve and verify server responses.

A typical AS1 transaction is as follows:

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

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

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

When sending an EDI message, the client should specify, at a minimum, From and SendTo, MailServer, and Data and EDIType. The Send method should then be invoked.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data set SigningCert. To encrypt, set RecipientCerts.

TLS/SSL will also be used if SSLStartMode is set. In case your trading partner is using a self-signed certificate with their mail server it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.

The message may also be compressed by setting CompressionFormat.

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

Validating AS1 MDNs

AS1 MDNs are returned asynchronously in a separate email. Generally MDNs will not be returned immediately.

The class supports the use of the POP/S protocol for receiving e-mail. To receive an MDN, set the MailServer, User, and Password properties, and call Connect. At this point you may search your mailbox using the MailMessage properties; when you have found the appropriate message you should invoke ReadReceipt, which will set MDNReceipt. If the receipt is indeed an MDN it will also be parsed (although not verified) and MessageId will be set. If the message is not an MDN an exception will be thrown.

You should then use the values of From and MessageId to look up your trading partner's certificates, the MDNOptions requested, and the OriginalContentMIC calculated when you sent the original message (you must store this value externally to verify signed receipts). Finally, invoke VerifyReceipt.

Property List


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

AttachmentsCollection of files attached to the current message.
CompressionFormatThe compression format (if any) to use.
ConnectedWhether the class is connected.
EDIDataThe EDI or other data to be sent.
EncryptionAlgorithmThe algorithm used to encrypt the EDI data.
FirewallA set of properties related to firewall access.
FromThe sender of the original message.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LogDirectoryThe path to a directory for logging.
LogFileThe log file written.
MailMessageCcThe value of the Cc header of the mail message.
MailMessageCountThe number of messages waiting in the mailbox.
MailMessageDateThe message date for the currently selected message.
MailMessageFromThe sender of the mail message.
MailMessageHeadersThe message headers for the currently selected message.
MailMessageNumberThe message number on the incoming mail server.
MailMessageReplyToThe value of the ReplyTo header of the mail message.
MailMessageSubjectThe subject of the mail message.
MailMessageTextThe text of the mail message.
MailMessageToThe recipient of the mail message.
MailServerThe address of your mail server.
MDNOptionsUsed to indicate the options requested for the MDN receipt.
MDNReceiptThe MDN receipt returned from the server.
MDNToThe system to which an MDN should be directed.
MessageIdThe Id of the message.
OriginalContentMICThe Message Integrity Check(s) (one-way hash) of the outgoing message.
PasswordThe password for your incoming mail server.
ReceiptSignerCertThe public key certificate for the MDN receipt signature.
RecipientCertsThe public key certificates of the recipients for this message.
SendToThe recipient of the message.
SignatureAlgorithmSignature algorithm to be used in outgoing messages.
SigningCertContains the certificate to use when signing messages.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProviderThe Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeDetermines how the class starts the SSL negotiation. By default, SSL will not be used.
SubjectThe subject of the message.
UserThe username for your incoming mail server.

Method List


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

ConfigSets or retrieves a configuration setting.
ConnectConnects to the incoming mail server.
DeleteMessageDeletes the message specified by MailMessageNumber .
DisconnectDisconnects from the incoming mail server.
ProcessQueueSend the messages queued for sending.
QueryMessageSizeReturns the size in bytes of the current message.
QueryMessageUIDReturns the unique identifier of the message as specified by the server.
QueuePrepares and queues the message to the specified directory.
ReadReceiptReads and parses (but does not verify) an MDN receipt.
ResetResets the state of the control.
SelectMailMessageSelects and obtains information about the specified message.
SendPrepares and sends the AS1 message.
SetRequestHeaderAllows the user to set or add arbitrary HTTP request headers.
VerifyReceiptVerifies an MDN receipt.

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.

ConnectionStatusFired to indicate changes in the connection state.
EndTransferFired when the message text completes transferring.
ErrorFired when information is available about errors during data delivery.
HeaderThis event is fired for every message header being retrieved.
LogFired with log information while processing a message.
PITrailThis event traces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferFired when the message text starts transferring (on either a send or receive).
TransferFired while the message text gets transferred to or from MailServer .

Config Settings


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

LogFilenameThe base name of the log file.
POPPortThe POP mail port to be used, if different than MailServer.
POPServerThe POP server to be used, if different than MailServer.
SMTPAuthMechanismThe authentication mechanism used to connect to the SMTP server.
SMTPPasswordThe password used for authentication.
SMTPPortThe SMTP mail port to be used, if different than MailServer.
SMTPServerThe SMTP server to be used, if different than MailServer.
SMTPSSLStartModeDetermines how SSL negotiation starts with the SMTP server.
SMTPUserThe user name used for authentication.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Attachments Property (AS1Sender Class)

Collection of files attached to the current message.

Syntax

IPWorksEDIList<IPWorksEDIEDIAttachment>* GetAttachments();
int SetAttachments(IPWorksEDIList<IPWorksEDIEDIAttachment>* val);
int ipworksedi_as1sender_getattachmentcount(void* lpObj);
int ipworksedi_as1sender_setattachmentcount(void* lpObj, int iAttachmentCount);
char* ipworksedi_as1sender_getattachmentcontenttype(void* lpObj, int attachmentindex);
int ipworksedi_as1sender_setattachmentcontenttype(void* lpObj, int attachmentindex, const char* lpszAttachmentContentType);
int ipworksedi_as1sender_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int ipworksedi_as1sender_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);
char* ipworksedi_as1sender_getattachmentfilename(void* lpObj, int attachmentindex);
int ipworksedi_as1sender_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);
char* ipworksedi_as1sender_getattachmentheaders(void* lpObj, int attachmentindex);
int ipworksedi_as1sender_setattachmentheaders(void* lpObj, int attachmentindex, const char* lpszAttachmentHeaders);
char* ipworksedi_as1sender_getattachmentname(void* lpObj, int attachmentindex);
int ipworksedi_as1sender_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);
int getAttachmentCount();
int setAttachmentCount(int iAttachmentCount); QString getAttachmentContentType(int iAttachmentIndex);
int setAttachmentContentType(int iAttachmentIndex, QString qsAttachmentContentType); QByteArray getAttachmentData(int iAttachmentIndex);
int setAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData); QString getAttachmentFileName(int iAttachmentIndex);
int setAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName); QString getAttachmentHeaders(int iAttachmentIndex);
int setAttachmentHeaders(int iAttachmentIndex, QString qsAttachmentHeaders); QString getAttachmentName(int iAttachmentIndex);
int setAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

Remarks

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

This property is not available at design time.

Data Type

IPWorksEDIEDIAttachment

CompressionFormat Property (AS1Sender Class)

The compression format (if any) to use.

Syntax

ANSI (Cross Platform)
int GetCompressionFormat();
int SetCompressionFormat(int iCompressionFormat); Unicode (Windows) INT GetCompressionFormat();
INT SetCompressionFormat(INT iCompressionFormat);

Possible Values

CF_NONE(0), 
CF_ZLIB(1)
int ipworksedi_as1sender_getcompressionformat(void* lpObj);
int ipworksedi_as1sender_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

Connected Property (AS1Sender Class)

Whether the class is connected.

Syntax

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();
int ipworksedi_as1sender_getconnected(void* lpObj);
bool getConnected();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

EDIData Property (AS1Sender Class)

The EDI or other data to be sent.

Syntax

IPWorksEDIEDIData* GetEDIData();
int SetEDIData(IPWorksEDIEDIData* val);
int ipworksedi_as1sender_getedidata(void* lpObj, char** lpEDIData, int* lenEDIData);
int ipworksedi_as1sender_setedidata(void* lpObj, const char* lpEDIData, int lenEDIData);
char* ipworksedi_as1sender_geteditype(void* lpObj);
int ipworksedi_as1sender_seteditype(void* lpObj, const char* lpszEDIType);
char* ipworksedi_as1sender_getediname(void* lpObj);
int ipworksedi_as1sender_setediname(void* lpObj, const char* lpszEDIName);
char* ipworksedi_as1sender_getedifilename(void* lpObj);
int ipworksedi_as1sender_setedifilename(void* lpObj, const char* lpszEDIFileName);
QByteArray getEDIData();
int setEDIData(QByteArray qbaEDIData); QString getEDIType();
int setEDIType(QString qsEDIType); QString getEDIName();
int setEDIName(QString qsEDIName); QString getEDIFileName();
int setEDIFileName(QString qsEDIFileName);

Remarks

The EDI message to send.

This property is not available at design time.

Data Type

IPWorksEDIEDIData

EncryptionAlgorithm Property (AS1Sender Class)

The algorithm used to encrypt the EDI data.

Syntax

ANSI (Cross Platform)
char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm); Unicode (Windows) LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);
char* ipworksedi_as1sender_getencryptionalgorithm(void* lpObj);
int ipworksedi_as1sender_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

Firewall Property (AS1Sender Class)

A set of properties related to firewall access.

Syntax

IPWorksEDIFirewall* GetFirewall();
int SetFirewall(IPWorksEDIFirewall* val);
int ipworksedi_as1sender_getfirewallautodetect(void* lpObj);
int ipworksedi_as1sender_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksedi_as1sender_getfirewalltype(void* lpObj);
int ipworksedi_as1sender_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksedi_as1sender_getfirewallhost(void* lpObj);
int ipworksedi_as1sender_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksedi_as1sender_getfirewallpassword(void* lpObj);
int ipworksedi_as1sender_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksedi_as1sender_getfirewallport(void* lpObj);
int ipworksedi_as1sender_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksedi_as1sender_getfirewalluser(void* lpObj);
int ipworksedi_as1sender_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool getFirewallAutoDetect();
int setFirewallAutoDetect(bool bFirewallAutoDetect); int getFirewallType();
int setFirewallType(int iFirewallType); QString getFirewallHost();
int setFirewallHost(QString qsFirewallHost); QString getFirewallPassword();
int setFirewallPassword(QString qsFirewallPassword); int getFirewallPort();
int setFirewallPort(int iFirewallPort); QString getFirewallUser();
int setFirewallUser(QString qsFirewallUser);

Remarks

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

Data Type

IPWorksEDIFirewall

From Property (AS1Sender Class)

The sender of the original message.

Syntax

ANSI (Cross Platform)
char* GetFrom();
int SetFrom(const char* lpszFrom); Unicode (Windows) LPWSTR GetFrom();
INT SetFrom(LPCWSTR lpszFrom);
char* ipworksedi_as1sender_getfrom(void* lpObj);
int ipworksedi_as1sender_setfrom(void* lpObj, const char* lpszFrom);
QString getFrom();
int setFrom(QString qsFrom);

Default Value

""

Remarks

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

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

Data Type

String

LocalHost Property (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksedi_as1sender_getlocalhost(void* lpObj);
int ipworksedi_as1sender_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString getLocalHost();
int setLocalHost(QString qsLocalHost);

Default Value

""

Remarks

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

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

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

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

Data Type

String

LogDirectory Property (AS1Sender Class)

The path to a directory for logging.

Syntax

ANSI (Cross Platform)
char* GetLogDirectory();
int SetLogDirectory(const char* lpszLogDirectory); Unicode (Windows) LPWSTR GetLogDirectory();
INT SetLogDirectory(LPCWSTR lpszLogDirectory);
char* ipworksedi_as1sender_getlogdirectory(void* lpObj);
int ipworksedi_as1sender_setlogdirectory(void* lpObj, const char* lpszLogDirectory);
QString getLogDirectory();
int setLogDirectory(QString qsLogDirectory);

Default Value

""

Remarks

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

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

The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS1Sender Class)

The log file written.

Syntax

ANSI (Cross Platform)
char* GetLogFile();

Unicode (Windows)
LPWSTR GetLogFile();
char* ipworksedi_as1sender_getlogfile(void* lpObj);
QString getLogFile();

Default Value

""

Remarks

In case LogDirectory is specified two log files will be written in the specified directory and LogFile will contain the path.

LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS1 messages and MDNs will also be written with extensions ".as1" and ".as1-mdn".

This property is read-only.

Data Type

String

MailMessageCc Property (AS1Sender Class)

The value of the Cc header of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageCc();

Unicode (Windows)
LPWSTR GetMailMessageCc();
char* ipworksedi_as1sender_getmailmessagecc(void* lpObj);
QString getMailMessageCc();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageCount Property (AS1Sender Class)

The number of messages waiting in the mailbox.

Syntax

ANSI (Cross Platform)
int GetMailMessageCount();

Unicode (Windows)
INT GetMailMessageCount();
int ipworksedi_as1sender_getmailmessagecount(void* lpObj);
int getMailMessageCount();

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

MailMessageDate Property (AS1Sender Class)

The message date for the currently selected message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageDate();

Unicode (Windows)
LPWSTR GetMailMessageDate();
char* ipworksedi_as1sender_getmailmessagedate(void* lpObj);
QString getMailMessageDate();

Default Value

""

Remarks

The date will be formatted like the following example:

Wed, 29 Dec 2004 11:58:02 +0700

This property is read-only.

Data Type

String

MailMessageFrom Property (AS1Sender Class)

The sender of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageFrom();

Unicode (Windows)
LPWSTR GetMailMessageFrom();
char* ipworksedi_as1sender_getmailmessagefrom(void* lpObj);
QString getMailMessageFrom();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageHeaders Property (AS1Sender Class)

The message headers for the currently selected message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageHeaders();

Unicode (Windows)
LPWSTR GetMailMessageHeaders();
char* ipworksedi_as1sender_getmailmessageheaders(void* lpObj);
QString getMailMessageHeaders();

Default Value

""

Remarks

After calling SelectMailMessage this property will contain the full headers of the mail message as reported by the mail server.

This property is read-only.

Data Type

String

MailMessageNumber Property (AS1Sender Class)

The message number on the incoming mail server.

Syntax

ANSI (Cross Platform)
int GetMailMessageNumber();
int SetMailMessageNumber(int iMailMessageNumber); Unicode (Windows) INT GetMailMessageNumber();
INT SetMailMessageNumber(INT iMailMessageNumber);
int ipworksedi_as1sender_getmailmessagenumber(void* lpObj);
int ipworksedi_as1sender_setmailmessagenumber(void* lpObj, int iMailMessageNumber);
int getMailMessageNumber();
int setMailMessageNumber(int iMailMessageNumber);

Default Value

0

Remarks

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

Set this property before calling SelectMailMessage, QueryMessageSize or QueryMessageUID.

This property is not available at design time.

Data Type

Integer

MailMessageReplyTo Property (AS1Sender Class)

The value of the ReplyTo header of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageReplyTo();

Unicode (Windows)
LPWSTR GetMailMessageReplyTo();
char* ipworksedi_as1sender_getmailmessagereplyto(void* lpObj);
QString getMailMessageReplyTo();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageSubject Property (AS1Sender Class)

The subject of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageSubject();

Unicode (Windows)
LPWSTR GetMailMessageSubject();
char* ipworksedi_as1sender_getmailmessagesubject(void* lpObj);
QString getMailMessageSubject();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageText Property (AS1Sender Class)

The text of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageText();

Unicode (Windows)
LPWSTR GetMailMessageText();
char* ipworksedi_as1sender_getmailmessagetext(void* lpObj);
QString getMailMessageText();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailMessageTo Property (AS1Sender Class)

The recipient of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMailMessageTo();

Unicode (Windows)
LPWSTR GetMailMessageTo();
char* ipworksedi_as1sender_getmailmessageto(void* lpObj);
QString getMailMessageTo();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MailServer Property (AS1Sender Class)

The address of your mail server.

Syntax

ANSI (Cross Platform)
char* GetMailServer();
int SetMailServer(const char* lpszMailServer); Unicode (Windows) LPWSTR GetMailServer();
INT SetMailServer(LPCWSTR lpszMailServer);
char* ipworksedi_as1sender_getmailserver(void* lpObj);
int ipworksedi_as1sender_setmailserver(void* lpObj, const char* lpszMailServer);
QString getMailServer();
int setMailServer(QString qsMailServer);

Default Value

""

Remarks

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

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

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

Data Type

String

MDNOptions Property (AS1Sender Class)

Used to indicate the options requested for the MDN receipt.

Syntax

ANSI (Cross Platform)
char* GetMDNOptions();
int SetMDNOptions(const char* lpszMDNOptions); Unicode (Windows) LPWSTR GetMDNOptions();
INT SetMDNOptions(LPCWSTR lpszMDNOptions);
char* ipworksedi_as1sender_getmdnoptions(void* lpObj);
int ipworksedi_as1sender_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

MDNReceipt Property (AS1Sender Class)

The MDN receipt returned from the server.

Syntax

IPWorksEDIMDNReceipt* GetMDNReceipt();
int SetMDNReceipt(IPWorksEDIMDNReceipt* val);
int ipworksedi_as1sender_getmdnreceiptcontent(void* lpObj, char** lpMDNReceiptContent, int* lenMDNReceiptContent);
int ipworksedi_as1sender_setmdnreceiptcontent(void* lpObj, const char* lpMDNReceiptContent, int lenMDNReceiptContent);
int ipworksedi_as1sender_getmdnreceiptheadercount(void* lpObj);
char* ipworksedi_as1sender_getmdnreceiptheaderfield(void* lpObj);
int ipworksedi_as1sender_getmdnreceiptheaderindex(void* lpObj);
int ipworksedi_as1sender_setmdnreceiptheaderindex(void* lpObj, int iMDNReceiptHeaderIndex);
char* ipworksedi_as1sender_getmdnreceiptheaders(void* lpObj);
int ipworksedi_as1sender_setmdnreceiptheaders(void* lpObj, const char* lpszMDNReceiptHeaders);
char* ipworksedi_as1sender_getmdnreceiptheadervalue(void* lpObj);
char* ipworksedi_as1sender_getmdnreceiptmdn(void* lpObj);
char* ipworksedi_as1sender_getmdnreceiptmessage(void* lpObj);
char* ipworksedi_as1sender_getmdnreceiptmicvalue(void* lpObj);
char* ipworksedi_as1sender_getmdnreceiptsigningprotocol(void* lpObj);
QByteArray getMDNReceiptContent();
int setMDNReceiptContent(QByteArray qbaMDNReceiptContent); int getMDNReceiptHeaderCount(); QString getMDNReceiptHeaderField(); int getMDNReceiptHeaderIndex();
int setMDNReceiptHeaderIndex(int iMDNReceiptHeaderIndex); QString getMDNReceiptHeaders();
int setMDNReceiptHeaders(QString qsMDNReceiptHeaders); QString getMDNReceiptHeaderValue(); QString getMDNReceiptMDN(); QString getMDNReceiptMessage(); QString getMDNReceiptMICValue(); QString getMDNReceiptSigningProtocol();

Remarks

This property will contain an instance of MDNReceipt with the complete MDN receipt returned from the AS2 receiver. The receipt will be a signed or unsigned multipart/report in MIME format. For synchronous MDN requests, this property is populated automatically after the call to Post. If an asynchronous MDN is sent over HTTP, it may be read from the HTTP context by calling ReadAsyncReceipt, or it may be set manually.

When MDNReceipt is set to a valid MDN receipt, the originator of the receipt will be stored in AS2To, the intended recipient (presumably your system) will be stored in AS2From, and the original message ID will be stored in MessageId.

If you are processing a MDN receipt asynchronously, you can use the values to look up the original message and validate the receipt. Set the OriginalContentMIC, MDNOptions, and ReceiptSignerCert to the values originally computed when the message was sent (if you are requesting async MDNs you must save this information externally.). You can then validate the asynchronous receipt by invoking VerifyReceipt.

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

NOTE: MDNReceipt must be populated prior to calling VerifyReceipt.

Data Type

IPWorksEDIMDNReceipt

MDNTo Property (AS1Sender Class)

The system to which an MDN should be directed.

Syntax

ANSI (Cross Platform)
char* GetMDNTo();
int SetMDNTo(const char* lpszMDNTo); Unicode (Windows) LPWSTR GetMDNTo();
INT SetMDNTo(LPCWSTR lpszMDNTo);
char* ipworksedi_as1sender_getmdnto(void* lpObj);
int ipworksedi_as1sender_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. This should be set to a valid email address, and would typically be the same as the From address.

By default, the class will request a PKCS#7 signature signed over SHA-256. This can be customized by specifying MDNOptions.

Data Type

String

MessageId Property (AS1Sender Class)

The Id of the message.

Syntax

ANSI (Cross Platform)
char* GetMessageId();
int SetMessageId(const char* lpszMessageId); Unicode (Windows) LPWSTR GetMessageId();
INT SetMessageId(LPCWSTR lpszMessageId);
char* ipworksedi_as1sender_getmessageid(void* lpObj);
int ipworksedi_as1sender_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.

In AS1, customizing the MessageId is not supported. An appropriate MessageId will be generated by the class for each outgoing message. You should record this value after sending this value, and set it again when you verify the receipt.

This property is not available at design time.

Data Type

String

OriginalContentMIC Property (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
char* GetOriginalContentMIC();
int SetOriginalContentMIC(const char* lpszOriginalContentMIC); Unicode (Windows) LPWSTR GetOriginalContentMIC();
INT SetOriginalContentMIC(LPCWSTR lpszOriginalContentMIC);
char* ipworksedi_as1sender_getoriginalcontentmic(void* lpObj);
int ipworksedi_as1sender_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

Password Property (AS1Sender Class)

The password for your incoming mail server.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* ipworksedi_as1sender_getpassword(void* lpObj);
int ipworksedi_as1sender_setpassword(void* lpObj, const char* lpszPassword);
QString getPassword();
int setPassword(QString qsPassword);

Default Value

""

Remarks

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

Data Type

String

ReceiptSignerCert Property (AS1Sender Class)

The public key certificate for the MDN receipt signature.

Syntax

IPWorksEDICertificate* GetReceiptSignerCert();
int SetReceiptSignerCert(IPWorksEDICertificate* val);
char* ipworksedi_as1sender_getreceiptsignercerteffectivedate(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertexpirationdate(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertextendedkeyusage(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertfingerprint(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertfingerprintsha1(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertfingerprintsha256(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertissuer(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertprivatekey(void* lpObj);
int ipworksedi_as1sender_getreceiptsignercertprivatekeyavailable(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertprivatekeycontainer(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertpublickey(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertpublickeyalgorithm(void* lpObj);
int ipworksedi_as1sender_getreceiptsignercertpublickeylength(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertserialnumber(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_getreceiptsignercertstore(void* lpObj, char** lpReceiptSignerCertStore, int* lenReceiptSignerCertStore);
int ipworksedi_as1sender_setreceiptsignercertstore(void* lpObj, const char* lpReceiptSignerCertStore, int lenReceiptSignerCertStore);
char* ipworksedi_as1sender_getreceiptsignercertstorepassword(void* lpObj);
int ipworksedi_as1sender_setreceiptsignercertstorepassword(void* lpObj, const char* lpszReceiptSignerCertStorePassword);
int ipworksedi_as1sender_getreceiptsignercertstoretype(void* lpObj);
int ipworksedi_as1sender_setreceiptsignercertstoretype(void* lpObj, int iReceiptSignerCertStoreType);
char* ipworksedi_as1sender_getreceiptsignercertsubjectaltnames(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertthumbprintmd5(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertthumbprintsha1(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertthumbprintsha256(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertusage(void* lpObj);
int ipworksedi_as1sender_getreceiptsignercertusageflags(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertversion(void* lpObj);
char* ipworksedi_as1sender_getreceiptsignercertsubject(void* lpObj);
int ipworksedi_as1sender_setreceiptsignercertsubject(void* lpObj, const char* lpszReceiptSignerCertSubject);
int ipworksedi_as1sender_getreceiptsignercertencoded(void* lpObj, char** lpReceiptSignerCertEncoded, int* lenReceiptSignerCertEncoded);
int ipworksedi_as1sender_setreceiptsignercertencoded(void* lpObj, const char* lpReceiptSignerCertEncoded, int lenReceiptSignerCertEncoded);
QString getReceiptSignerCertEffectiveDate();

QString getReceiptSignerCertExpirationDate();

QString getReceiptSignerCertExtendedKeyUsage();

QString getReceiptSignerCertFingerprint();

QString getReceiptSignerCertFingerprintSHA1();

QString getReceiptSignerCertFingerprintSHA256();

QString getReceiptSignerCertIssuer();

QString getReceiptSignerCertPrivateKey();

bool getReceiptSignerCertPrivateKeyAvailable();

QString getReceiptSignerCertPrivateKeyContainer();

QString getReceiptSignerCertPublicKey();

QString getReceiptSignerCertPublicKeyAlgorithm();

int getReceiptSignerCertPublicKeyLength();

QString getReceiptSignerCertSerialNumber();

QString getReceiptSignerCertSignatureAlgorithm();

QByteArray getReceiptSignerCertStore();
int setReceiptSignerCertStore(QByteArray qbaReceiptSignerCertStore); QString getReceiptSignerCertStorePassword();
int setReceiptSignerCertStorePassword(QString qsReceiptSignerCertStorePassword); int getReceiptSignerCertStoreType();
int setReceiptSignerCertStoreType(int iReceiptSignerCertStoreType); QString getReceiptSignerCertSubjectAltNames(); QString getReceiptSignerCertThumbprintMD5(); QString getReceiptSignerCertThumbprintSHA1(); QString getReceiptSignerCertThumbprintSHA256(); QString getReceiptSignerCertUsage(); int getReceiptSignerCertUsageFlags(); QString getReceiptSignerCertVersion(); QString getReceiptSignerCertSubject();
int setReceiptSignerCertSubject(QString qsReceiptSignerCertSubject); QByteArray getReceiptSignerCertEncoded();
int setReceiptSignerCertEncoded(QByteArray qbaReceiptSignerCertEncoded);

Remarks

Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in RecipientCert is used for both encryption and verifying the receipt signature.

If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking Post.

After invoking Post or VerifyReceipt, this will contain the certificate used to sign the receipt, if the receipt is signed.

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

Data Type

IPWorksEDICertificate

RecipientCerts Property (AS1Sender Class)

The public key certificates of the recipients for this message.

Syntax

IPWorksEDIList<IPWorksEDICertificate>* GetRecipientCerts();
int SetRecipientCerts(IPWorksEDIList<IPWorksEDICertificate>* val);
int ipworksedi_as1sender_getrecipientcertcount(void* lpObj);
int ipworksedi_as1sender_setrecipientcertcount(void* lpObj, int iRecipientCertCount);
char* ipworksedi_as1sender_getrecipientcerteffectivedate(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertexpirationdate(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertextendedkeyusage(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertfingerprint(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertfingerprintsha1(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertfingerprintsha256(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertissuer(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertprivatekey(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_getrecipientcertprivatekeyavailable(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertprivatekeycontainer(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertpublickey(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertpublickeyalgorithm(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_getrecipientcertpublickeylength(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertserialnumber(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertsignaturealgorithm(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_getrecipientcertstore(void* lpObj, int recipientcertindex, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksedi_as1sender_setrecipientcertstore(void* lpObj, int recipientcertindex, const char* lpRecipientCertStore, int lenRecipientCertStore);
char* ipworksedi_as1sender_getrecipientcertstorepassword(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_setrecipientcertstorepassword(void* lpObj, int recipientcertindex, const char* lpszRecipientCertStorePassword);
int ipworksedi_as1sender_getrecipientcertstoretype(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_setrecipientcertstoretype(void* lpObj, int recipientcertindex, int iRecipientCertStoreType);
char* ipworksedi_as1sender_getrecipientcertsubjectaltnames(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertthumbprintmd5(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertthumbprintsha1(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertthumbprintsha256(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertusage(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_getrecipientcertusageflags(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertversion(void* lpObj, int recipientcertindex);
char* ipworksedi_as1sender_getrecipientcertsubject(void* lpObj, int recipientcertindex);
int ipworksedi_as1sender_setrecipientcertsubject(void* lpObj, int recipientcertindex, const char* lpszRecipientCertSubject);
int ipworksedi_as1sender_getrecipientcertencoded(void* lpObj, int recipientcertindex, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksedi_as1sender_setrecipientcertencoded(void* lpObj, int recipientcertindex, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);
int getRecipientCertCount();
int setRecipientCertCount(int iRecipientCertCount); QString getRecipientCertEffectiveDate(int iRecipientCertIndex); QString getRecipientCertExpirationDate(int iRecipientCertIndex); QString getRecipientCertExtendedKeyUsage(int iRecipientCertIndex); QString getRecipientCertFingerprint(int iRecipientCertIndex); QString getRecipientCertFingerprintSHA1(int iRecipientCertIndex); QString getRecipientCertFingerprintSHA256(int iRecipientCertIndex); QString getRecipientCertIssuer(int iRecipientCertIndex); QString getRecipientCertPrivateKey(int iRecipientCertIndex); bool getRecipientCertPrivateKeyAvailable(int iRecipientCertIndex); QString getRecipientCertPrivateKeyContainer(int iRecipientCertIndex); QString getRecipientCertPublicKey(int iRecipientCertIndex); QString getRecipientCertPublicKeyAlgorithm(int iRecipientCertIndex); int getRecipientCertPublicKeyLength(int iRecipientCertIndex); QString getRecipientCertSerialNumber(int iRecipientCertIndex); QString getRecipientCertSignatureAlgorithm(int iRecipientCertIndex); QByteArray getRecipientCertStore(int iRecipientCertIndex);
int setRecipientCertStore(int iRecipientCertIndex, QByteArray qbaRecipientCertStore); QString getRecipientCertStorePassword(int iRecipientCertIndex);
int setRecipientCertStorePassword(int iRecipientCertIndex, QString qsRecipientCertStorePassword); int getRecipientCertStoreType(int iRecipientCertIndex);
int setRecipientCertStoreType(int iRecipientCertIndex, int iRecipientCertStoreType); QString getRecipientCertSubjectAltNames(int iRecipientCertIndex); QString getRecipientCertThumbprintMD5(int iRecipientCertIndex); QString getRecipientCertThumbprintSHA1(int iRecipientCertIndex); QString getRecipientCertThumbprintSHA256(int iRecipientCertIndex); QString getRecipientCertUsage(int iRecipientCertIndex); int getRecipientCertUsageFlags(int iRecipientCertIndex); QString getRecipientCertVersion(int iRecipientCertIndex); QString getRecipientCertSubject(int iRecipientCertIndex);
int setRecipientCertSubject(int iRecipientCertIndex, QString qsRecipientCertSubject); QByteArray getRecipientCertEncoded(int iRecipientCertIndex);
int setRecipientCertEncoded(int iRecipientCertIndex, QByteArray qbaRecipientCertEncoded);

Remarks

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

This property will also be used to verify signed receipts if ReceiptSignerCert is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and ReceiptSignerCert to the signing certificate.

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

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

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

This property will also be used to verify signed receipts if ReceiptSignerCert is not specified. In this case, it will use the first certificate found in the collection, if one exists. If your trading partner uses different certificates for signing and encryption, you should set RecipientCerts to the encryption certificate(s) and ReceiptSignerCert to the signing certificate.

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

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

This property is not available at design time.

Data Type

IPWorksEDICertificate

SendTo Property (AS1Sender Class)

The recipient of the message.

Syntax

ANSI (Cross Platform)
char* GetSendTo();
int SetSendTo(const char* lpszSendTo); Unicode (Windows) LPWSTR GetSendTo();
INT SetSendTo(LPCWSTR lpszSendTo);
char* ipworksedi_as1sender_getsendto(void* lpObj);
int ipworksedi_as1sender_setsendto(void* lpObj, const char* lpszSendTo);
QString getSendTo();
int setSendTo(QString qsSendTo);

Default Value

""

Remarks

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

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

Data Type

String

SignatureAlgorithm Property (AS1Sender Class)

Signature algorithm to be used in outgoing messages.

Syntax

ANSI (Cross Platform)
char* GetSignatureAlgorithm();
int SetSignatureAlgorithm(const char* lpszSignatureAlgorithm); Unicode (Windows) LPWSTR GetSignatureAlgorithm();
INT SetSignatureAlgorithm(LPCWSTR lpszSignatureAlgorithm);
char* ipworksedi_as1sender_getsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_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

SigningCert Property (AS1Sender Class)

Contains the certificate to use when signing messages.

Syntax

IPWorksEDICertificate* GetSigningCert();
int SetSigningCert(IPWorksEDICertificate* val);
char* ipworksedi_as1sender_getsigningcerteffectivedate(void* lpObj);
char* ipworksedi_as1sender_getsigningcertexpirationdate(void* lpObj);
char* ipworksedi_as1sender_getsigningcertextendedkeyusage(void* lpObj);
char* ipworksedi_as1sender_getsigningcertfingerprint(void* lpObj);
char* ipworksedi_as1sender_getsigningcertfingerprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsigningcertfingerprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsigningcertissuer(void* lpObj);
char* ipworksedi_as1sender_getsigningcertprivatekey(void* lpObj);
int ipworksedi_as1sender_getsigningcertprivatekeyavailable(void* lpObj);
char* ipworksedi_as1sender_getsigningcertprivatekeycontainer(void* lpObj);
char* ipworksedi_as1sender_getsigningcertpublickey(void* lpObj);
char* ipworksedi_as1sender_getsigningcertpublickeyalgorithm(void* lpObj);
int ipworksedi_as1sender_getsigningcertpublickeylength(void* lpObj);
char* ipworksedi_as1sender_getsigningcertserialnumber(void* lpObj);
char* ipworksedi_as1sender_getsigningcertsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as1sender_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);
char* ipworksedi_as1sender_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as1sender_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);
int ipworksedi_as1sender_getsigningcertstoretype(void* lpObj);
int ipworksedi_as1sender_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);
char* ipworksedi_as1sender_getsigningcertsubjectaltnames(void* lpObj);
char* ipworksedi_as1sender_getsigningcertthumbprintmd5(void* lpObj);
char* ipworksedi_as1sender_getsigningcertthumbprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsigningcertthumbprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsigningcertusage(void* lpObj);
int ipworksedi_as1sender_getsigningcertusageflags(void* lpObj);
char* ipworksedi_as1sender_getsigningcertversion(void* lpObj);
char* ipworksedi_as1sender_getsigningcertsubject(void* lpObj);
int ipworksedi_as1sender_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);
int ipworksedi_as1sender_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as1sender_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);
QString getSigningCertEffectiveDate();

QString getSigningCertExpirationDate();

QString getSigningCertExtendedKeyUsage();

QString getSigningCertFingerprint();

QString getSigningCertFingerprintSHA1();

QString getSigningCertFingerprintSHA256();

QString getSigningCertIssuer();

QString getSigningCertPrivateKey();

bool getSigningCertPrivateKeyAvailable();

QString getSigningCertPrivateKeyContainer();

QString getSigningCertPublicKey();

QString getSigningCertPublicKeyAlgorithm();

int getSigningCertPublicKeyLength();

QString getSigningCertSerialNumber();

QString getSigningCertSignatureAlgorithm();

QByteArray getSigningCertStore();
int setSigningCertStore(QByteArray qbaSigningCertStore); QString getSigningCertStorePassword();
int setSigningCertStorePassword(QString qsSigningCertStorePassword); int getSigningCertStoreType();
int setSigningCertStoreType(int iSigningCertStoreType); QString getSigningCertSubjectAltNames(); QString getSigningCertThumbprintMD5(); QString getSigningCertThumbprintSHA1(); QString getSigningCertThumbprintSHA256(); QString getSigningCertUsage(); int getSigningCertUsageFlags(); QString getSigningCertVersion(); QString getSigningCertSubject();
int setSigningCertSubject(QString qsSigningCertSubject); QByteArray getSigningCertEncoded();
int setSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Remarks

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

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

Data Type

IPWorksEDICertificate

SSLAcceptServerCert Property (AS1Sender Class)

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

Syntax

IPWorksEDICertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksEDICertificate* val);
char* ipworksedi_as1sender_getsslacceptservercerteffectivedate(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertexpirationdate(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertextendedkeyusage(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertfingerprint(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertfingerprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertfingerprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertissuer(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertprivatekey(void* lpObj);
int ipworksedi_as1sender_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertpublickey(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int ipworksedi_as1sender_getsslacceptservercertpublickeylength(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertserialnumber(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksedi_as1sender_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* ipworksedi_as1sender_getsslacceptservercertstorepassword(void* lpObj);
int ipworksedi_as1sender_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int ipworksedi_as1sender_getsslacceptservercertstoretype(void* lpObj);
int ipworksedi_as1sender_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* ipworksedi_as1sender_getsslacceptservercertsubjectaltnames(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertthumbprintmd5(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertthumbprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertthumbprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertusage(void* lpObj);
int ipworksedi_as1sender_getsslacceptservercertusageflags(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertversion(void* lpObj);
char* ipworksedi_as1sender_getsslacceptservercertsubject(void* lpObj);
int ipworksedi_as1sender_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int ipworksedi_as1sender_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksedi_as1sender_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString getSSLAcceptServerCertEffectiveDate();

QString getSSLAcceptServerCertExpirationDate();

QString getSSLAcceptServerCertExtendedKeyUsage();

QString getSSLAcceptServerCertFingerprint();

QString getSSLAcceptServerCertFingerprintSHA1();

QString getSSLAcceptServerCertFingerprintSHA256();

QString getSSLAcceptServerCertIssuer();

QString getSSLAcceptServerCertPrivateKey();

bool getSSLAcceptServerCertPrivateKeyAvailable();

QString getSSLAcceptServerCertPrivateKeyContainer();

QString getSSLAcceptServerCertPublicKey();

QString getSSLAcceptServerCertPublicKeyAlgorithm();

int getSSLAcceptServerCertPublicKeyLength();

QString getSSLAcceptServerCertSerialNumber();

QString getSSLAcceptServerCertSignatureAlgorithm();

QByteArray getSSLAcceptServerCertStore();
int setSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString getSSLAcceptServerCertStorePassword();
int setSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int getSSLAcceptServerCertStoreType();
int setSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString getSSLAcceptServerCertSubjectAltNames(); QString getSSLAcceptServerCertThumbprintMD5(); QString getSSLAcceptServerCertThumbprintSHA1(); QString getSSLAcceptServerCertThumbprintSHA256(); QString getSSLAcceptServerCertUsage(); int getSSLAcceptServerCertUsageFlags(); QString getSSLAcceptServerCertVersion(); QString getSSLAcceptServerCertSubject();
int setSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray getSSLAcceptServerCertEncoded();
int setSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

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

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

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

Data Type

IPWorksEDICertificate

SSLCert Property (AS1Sender Class)

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

Syntax

IPWorksEDICertificate* GetSSLCert();
int SetSSLCert(IPWorksEDICertificate* val);
char* ipworksedi_as1sender_getsslcerteffectivedate(void* lpObj);
char* ipworksedi_as1sender_getsslcertexpirationdate(void* lpObj);
char* ipworksedi_as1sender_getsslcertextendedkeyusage(void* lpObj);
char* ipworksedi_as1sender_getsslcertfingerprint(void* lpObj);
char* ipworksedi_as1sender_getsslcertfingerprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslcertfingerprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslcertissuer(void* lpObj);
char* ipworksedi_as1sender_getsslcertprivatekey(void* lpObj);
int ipworksedi_as1sender_getsslcertprivatekeyavailable(void* lpObj);
char* ipworksedi_as1sender_getsslcertprivatekeycontainer(void* lpObj);
char* ipworksedi_as1sender_getsslcertpublickey(void* lpObj);
char* ipworksedi_as1sender_getsslcertpublickeyalgorithm(void* lpObj);
int ipworksedi_as1sender_getsslcertpublickeylength(void* lpObj);
char* ipworksedi_as1sender_getsslcertserialnumber(void* lpObj);
char* ipworksedi_as1sender_getsslcertsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as1sender_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* ipworksedi_as1sender_getsslcertstorepassword(void* lpObj);
int ipworksedi_as1sender_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int ipworksedi_as1sender_getsslcertstoretype(void* lpObj);
int ipworksedi_as1sender_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* ipworksedi_as1sender_getsslcertsubjectaltnames(void* lpObj);
char* ipworksedi_as1sender_getsslcertthumbprintmd5(void* lpObj);
char* ipworksedi_as1sender_getsslcertthumbprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslcertthumbprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslcertusage(void* lpObj);
int ipworksedi_as1sender_getsslcertusageflags(void* lpObj);
char* ipworksedi_as1sender_getsslcertversion(void* lpObj);
char* ipworksedi_as1sender_getsslcertsubject(void* lpObj);
int ipworksedi_as1sender_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int ipworksedi_as1sender_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as1sender_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString getSSLCertEffectiveDate();

QString getSSLCertExpirationDate();

QString getSSLCertExtendedKeyUsage();

QString getSSLCertFingerprint();

QString getSSLCertFingerprintSHA1();

QString getSSLCertFingerprintSHA256();

QString getSSLCertIssuer();

QString getSSLCertPrivateKey();

bool getSSLCertPrivateKeyAvailable();

QString getSSLCertPrivateKeyContainer();

QString getSSLCertPublicKey();

QString getSSLCertPublicKeyAlgorithm();

int getSSLCertPublicKeyLength();

QString getSSLCertSerialNumber();

QString getSSLCertSignatureAlgorithm();

QByteArray getSSLCertStore();
int setSSLCertStore(QByteArray qbaSSLCertStore); QString getSSLCertStorePassword();
int setSSLCertStorePassword(QString qsSSLCertStorePassword); int getSSLCertStoreType();
int setSSLCertStoreType(int iSSLCertStoreType); QString getSSLCertSubjectAltNames(); QString getSSLCertThumbprintMD5(); QString getSSLCertThumbprintSHA1(); QString getSSLCertThumbprintSHA256(); QString getSSLCertUsage(); int getSSLCertUsageFlags(); QString getSSLCertVersion(); QString getSSLCertSubject();
int setSSLCertSubject(QString qsSSLCertSubject); QByteArray getSSLCertEncoded();
int setSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

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

Data Type

IPWorksEDICertificate

SSLProvider Property (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksedi_as1sender_getsslprovider(void* lpObj);
int ipworksedi_as1sender_setsslprovider(void* lpObj, int iSSLProvider);
int getSSLProvider();
int setSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are as follows:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AS1Sender Class)

The server certificate for the last established connection.

Syntax

IPWorksEDICertificate* GetSSLServerCert();

char* ipworksedi_as1sender_getsslservercerteffectivedate(void* lpObj);
char* ipworksedi_as1sender_getsslservercertexpirationdate(void* lpObj);
char* ipworksedi_as1sender_getsslservercertextendedkeyusage(void* lpObj);
char* ipworksedi_as1sender_getsslservercertfingerprint(void* lpObj);
char* ipworksedi_as1sender_getsslservercertfingerprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslservercertfingerprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslservercertissuer(void* lpObj);
char* ipworksedi_as1sender_getsslservercertprivatekey(void* lpObj);
int ipworksedi_as1sender_getsslservercertprivatekeyavailable(void* lpObj);
char* ipworksedi_as1sender_getsslservercertprivatekeycontainer(void* lpObj);
char* ipworksedi_as1sender_getsslservercertpublickey(void* lpObj);
char* ipworksedi_as1sender_getsslservercertpublickeyalgorithm(void* lpObj);
int ipworksedi_as1sender_getsslservercertpublickeylength(void* lpObj);
char* ipworksedi_as1sender_getsslservercertserialnumber(void* lpObj);
char* ipworksedi_as1sender_getsslservercertsignaturealgorithm(void* lpObj);
int ipworksedi_as1sender_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* ipworksedi_as1sender_getsslservercertstorepassword(void* lpObj);
int ipworksedi_as1sender_getsslservercertstoretype(void* lpObj);
char* ipworksedi_as1sender_getsslservercertsubjectaltnames(void* lpObj);
char* ipworksedi_as1sender_getsslservercertthumbprintmd5(void* lpObj);
char* ipworksedi_as1sender_getsslservercertthumbprintsha1(void* lpObj);
char* ipworksedi_as1sender_getsslservercertthumbprintsha256(void* lpObj);
char* ipworksedi_as1sender_getsslservercertusage(void* lpObj);
int ipworksedi_as1sender_getsslservercertusageflags(void* lpObj);
char* ipworksedi_as1sender_getsslservercertversion(void* lpObj);
char* ipworksedi_as1sender_getsslservercertsubject(void* lpObj);
int ipworksedi_as1sender_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString getSSLServerCertEffectiveDate();

QString getSSLServerCertExpirationDate();

QString getSSLServerCertExtendedKeyUsage();

QString getSSLServerCertFingerprint();

QString getSSLServerCertFingerprintSHA1();

QString getSSLServerCertFingerprintSHA256();

QString getSSLServerCertIssuer();

QString getSSLServerCertPrivateKey();

bool getSSLServerCertPrivateKeyAvailable();

QString getSSLServerCertPrivateKeyContainer();

QString getSSLServerCertPublicKey();

QString getSSLServerCertPublicKeyAlgorithm();

int getSSLServerCertPublicKeyLength();

QString getSSLServerCertSerialNumber();

QString getSSLServerCertSignatureAlgorithm();

QByteArray getSSLServerCertStore();

QString getSSLServerCertStorePassword();

int getSSLServerCertStoreType();

QString getSSLServerCertSubjectAltNames();

QString getSSLServerCertThumbprintMD5();

QString getSSLServerCertThumbprintSHA1();

QString getSSLServerCertThumbprintSHA256();

QString getSSLServerCertUsage();

int getSSLServerCertUsageFlags();

QString getSSLServerCertVersion();

QString getSSLServerCertSubject();

QByteArray getSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksEDICertificate

SSLStartMode Property (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode); Unicode (Windows) INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

Possible Values

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1),
SSL_EXPLICIT(2),
SSL_NONE(3)
int ipworksedi_as1sender_getsslstartmode(void* lpObj);
int ipworksedi_as1sender_setsslstartmode(void* lpObj, int iSSLStartMode);
int getSSLStartMode();
int setSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic - default)If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone)No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer

Subject Property (AS1Sender Class)

The subject of the message.

Syntax

ANSI (Cross Platform)
char* GetSubject();
int SetSubject(const char* lpszSubject); Unicode (Windows) LPWSTR GetSubject();
INT SetSubject(LPCWSTR lpszSubject);
char* ipworksedi_as1sender_getsubject(void* lpObj);
int ipworksedi_as1sender_setsubject(void* lpObj, const char* lpszSubject);
QString getSubject();
int setSubject(QString qsSubject);

Default Value

"AS1 Message"

Remarks

The human-readable subject of the outgoing message.

Data Type

String

User Property (AS1Sender Class)

The username for your incoming mail server.

Syntax

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
char* ipworksedi_as1sender_getuser(void* lpObj);
int ipworksedi_as1sender_setuser(void* lpObj, const char* lpszUser);
QString getUser();
int setUser(QString qsUser);

Default Value

""

Remarks

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

Data Type

String

Config Method (AS1Sender Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksedi_as1sender_config(void* lpObj, const char* lpszConfigurationString);
QString config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

Connect Method (AS1Sender Class)

Connects to the incoming mail server.

Syntax

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();
int ipworksedi_as1sender_connect(void* lpObj);
int connect();

Remarks

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

If you wish to connect in SSL you should first set the SSLStartMode property. Note that it is not necessary to explicitly connect to an SMTP server for outgoing mail; a connection will be created and destroyed each time a mail is sent.

Error Handling (C++)

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

DeleteMessage Method (AS1Sender Class)

Deletes the message specified by MailMessageNumber .

Syntax

ANSI (Cross Platform)
int DeleteMessage();

Unicode (Windows)
INT DeleteMessage();
int ipworksedi_as1sender_deletemessage(void* lpObj);
int deleteMessage();

Remarks

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

Error Handling (C++)

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

Disconnect Method (AS1Sender Class)

Disconnects from the incoming mail server.

Syntax

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();
int ipworksedi_as1sender_disconnect(void* lpObj);
int disconnect();

Remarks

Disconnects from the incoming mail server specified by MailServer.

Error Handling (C++)

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

ProcessQueue Method (AS1Sender Class)

Send the messages queued for sending.

Syntax

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

Unicode (Windows)
INT ProcessQueue(LPCWSTR lpszDirectory);
int ipworksedi_as1sender_processqueue(void* lpObj, const char* lpszDirectory);
int processQueue(const QString& qsDirectory);

Remarks

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

Error Handling (C++)

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

QueryMessageSize Method (AS1Sender Class)

Returns the size in bytes of the current message.

Syntax

ANSI (Cross Platform)
int QueryMessageSize();

Unicode (Windows)
INT QueryMessageSize();
int ipworksedi_as1sender_querymessagesize(void* lpObj);
int queryMessageSize();

Remarks

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

Error Handling (C++)

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

QueryMessageUID Method (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
char* QueryMessageUID();

Unicode (Windows)
LPWSTR QueryMessageUID();
char* ipworksedi_as1sender_querymessageuid(void* lpObj);
QString queryMessageUID();

Remarks

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

Error Handling (C++)

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

Queue Method (AS1Sender Class)

Prepares and queues the message to the specified directory.

Syntax

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

Unicode (Windows)
INT Queue(LPCWSTR lpszDirectory);
int ipworksedi_as1sender_queue(void* lpObj, const char* lpszDirectory);
int queue(const QString& qsDirectory);

Remarks

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

Error Handling (C++)

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

ReadReceipt Method (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
int ReadReceipt();

Unicode (Windows)
INT ReadReceipt();
int ipworksedi_as1sender_readreceipt(void* lpObj);
int readReceipt();

Remarks

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

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

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

Finally, VerifyReceipt should be used to verify the receipt.

Error Handling (C++)

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

Reset Method (AS1Sender Class)

Resets the state of the control.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksedi_as1sender_reset(void* lpObj);
int reset();

Remarks

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

Error Handling (C++)

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

SelectMailMessage Method (AS1Sender Class)

Selects and obtains information about the specified message.

Syntax

ANSI (Cross Platform)
int SelectMailMessage();

Unicode (Windows)
INT SelectMailMessage();
int ipworksedi_as1sender_selectmailmessage(void* lpObj);
int selectMailMessage();

Remarks

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

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

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

Error Handling (C++)

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

Send Method (AS1Sender Class)

Prepares and sends the AS1 message.

Syntax

ANSI (Cross Platform)
int Send();

Unicode (Windows)
INT Send();
int ipworksedi_as1sender_send(void* lpObj);
int send();

Remarks

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

You should set MailServer prior to sending.

Error Handling (C++)

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

SetRequestHeader Method (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
int SetRequestHeader(const char* lpszHeaderName, const char* lpszHeaderValue);

Unicode (Windows)
INT SetRequestHeader(LPCWSTR lpszHeaderName, LPCWSTR lpszHeaderValue);
int ipworksedi_as1sender_setrequestheader(void* lpObj, const char* lpszHeaderName, const char* lpszHeaderValue);
int setRequestHeader(const QString& qsHeaderName, const QString& qsHeaderValue);

Remarks

HeaderName should contain the header name, and HeaderValue should contain its value. Use this to set headers such as To, Date, etc. Note that a default value for Date will automatically be determined and this method may be used to override the default.

SetRequestHeader may be used to set any header except for the following: AS2-To, AS2-From, AS2-Version, Subject, Message-Id, Disposition-Notification-To, Disposition-Notification-Options, Receipt-Delivery-Option, Host, Content-Length.

Error Handling (C++)

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

VerifyReceipt Method (AS1Sender Class)

Verifies an MDN receipt.

Syntax

ANSI (Cross Platform)
int VerifyReceipt();

Unicode (Windows)
INT VerifyReceipt();
int ipworksedi_as1sender_verifyreceipt(void* lpObj);
int verifyReceipt();

Remarks

VerifyReceipt verifies the receipt in MDNReceipt against the values of OriginalContentMIC and MessageId and the preferences specified in MDNOptions. The method operates similarly to Post: After the method finishes, the MDNReceipt, ReceiptSigningProtocol, and ReceiptSignerCert properties will be populated with the appropriate values.

The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN.

If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal.

You should first invoke ReadReceipt when it is not known which message the receipt is in response to. This will allow you to determine the original MessageId and originator of the receipt before trying to verify it.

Error Handling (C++)

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

ConnectionStatus Event (AS1Sender Class)

Fired to indicate changes in the connection state.

Syntax

ANSI (Cross Platform)
virtual int FireConnectionStatus(AS1SenderConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } AS1SenderConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(AS1SenderConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } AS1SenderConnectionStatusEventParams;
#define EID_AS1SENDER_CONNECTIONSTATUS 1

virtual INT IPWORKSEDI_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class AS1SenderConnectionStatusEventParams {
public:
  const QString &connectionEvent();

  int statusCode();

  const QString &description();

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

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.
StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (AS1Sender Class)

Fired when the message text completes transferring.

Syntax

ANSI (Cross Platform)
virtual int FireEndTransfer(AS1SenderEndTransferEventParams *e);
typedef struct { int reserved; } AS1SenderEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(AS1SenderEndTransferEventParams *e);
typedef struct { INT reserved; } AS1SenderEndTransferEventParams;
#define EID_AS1SENDER_ENDTRANSFER 2

virtual INT IPWORKSEDI_CALL FireEndTransfer();
class AS1SenderEndTransferEventParams {
public:
  int eventRetVal();
  void setEventRetVal(int iRetVal);
};
// To handle, subclass AS1Sender and override this emitter function. virtual int fireEndTransfer(AS1SenderEndTransferEventParams *e) {...} // Or, connect one or more slots to this signal. void endTransfer(AS1SenderEndTransferEventParams *e);

Remarks

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

Error Event (AS1Sender Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(AS1SenderErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AS1SenderErrorEventParams;
Unicode (Windows) virtual INT FireError(AS1SenderErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AS1SenderErrorEventParams;
#define EID_AS1SENDER_ERROR 3

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AS1SenderErrorEventParams {
public:
  int errorCode();

  const QString &description();

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

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AS1Sender Class)

This event is fired for every message header being retrieved.

Syntax

ANSI (Cross Platform)
virtual int FireHeader(AS1SenderHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } AS1SenderHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(AS1SenderHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } AS1SenderHeaderEventParams;
#define EID_AS1SENDER_HEADER 4

virtual INT IPWORKSEDI_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class AS1SenderHeaderEventParams {
public:
  const QString &field();

  const QString &value();

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

Remarks

The Field parameter contains the name of the header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AS1Sender Class)

Fired with log information while processing a message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(AS1SenderLogEventParams *e);
typedef struct {
const char *LogType;
const char *LogMessage; int lenLogMessage; int reserved; } AS1SenderLogEventParams;
Unicode (Windows) virtual INT FireLog(AS1SenderLogEventParams *e);
typedef struct {
LPCWSTR LogType;
LPCSTR LogMessage; INT lenLogMessage; INT reserved; } AS1SenderLogEventParams;
#define EID_AS1SENDER_LOG 5

virtual INT IPWORKSEDI_CALL FireLog(LPSTR &lpszLogType, LPSTR &lpLogMessage, INT &lenLogMessage);
class AS1SenderLogEventParams {
public:
  const QString &logType();

  const QByteArray &logMessage();

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

Remarks

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

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:

"LOG" Information about the status of the process.
"ERR" An error was encountered.
"DAT" The EDI payload.
"REQ" The raw request
"MDN" The MDN response.
"DEBUG" Debug information.
"DAT.INPUT" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.ENCRYPT" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.COMPRESS" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.SIGN" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECRYPT" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECOMPRESS" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.VERIFY" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DEBUG" Debug information when processing payload. Only applicable when LogDebug is True.

PITrail Event (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
virtual int FirePITrail(AS1SenderPITrailEventParams *e);
typedef struct {
int Direction;
const char *Message; int reserved; } AS1SenderPITrailEventParams;
Unicode (Windows) virtual INT FirePITrail(AS1SenderPITrailEventParams *e);
typedef struct {
INT Direction;
LPCWSTR Message; INT reserved; } AS1SenderPITrailEventParams;
#define EID_AS1SENDER_PITRAIL 6

virtual INT IPWORKSEDI_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);
class AS1SenderPITrailEventParams {
public:
  int direction();

  const QString &message();

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

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

0 (Client)The Message originates from the client.
1 (Server)The Message originates from the server.
2 (Info)The Message is an informative message originating from the client software (the class code).

SSLServerAuthentication Event (AS1Sender Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AS1SenderSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } AS1SenderSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(AS1SenderSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } AS1SenderSSLServerAuthenticationEventParams;
#define EID_AS1SENDER_SSLSERVERAUTHENTICATION 7

virtual INT IPWORKSEDI_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class AS1SenderSSLServerAuthenticationEventParams {
public:
  const QByteArray &certEncoded();

  const QString &certSubject();

  const QString &certIssuer();

  const QString &status();

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

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

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AS1Sender Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(AS1SenderSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AS1SenderSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(AS1SenderSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AS1SenderSSLStatusEventParams;
#define EID_AS1SENDER_SSLSTATUS 8

virtual INT IPWORKSEDI_CALL FireSSLStatus(LPSTR &lpszMessage);
class AS1SenderSSLStatusEventParams {
public:
  const QString &message();

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

Remarks

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

StartTransfer Event (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartTransfer(AS1SenderStartTransferEventParams *e);
typedef struct { int reserved; } AS1SenderStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(AS1SenderStartTransferEventParams *e);
typedef struct { INT reserved; } AS1SenderStartTransferEventParams;
#define EID_AS1SENDER_STARTTRANSFER 9

virtual INT IPWORKSEDI_CALL FireStartTransfer();
class AS1SenderStartTransferEventParams {
public:
  int eventRetVal();
  void setEventRetVal(int iRetVal);
};
// To handle, subclass AS1Sender and override this emitter function. virtual int fireStartTransfer(AS1SenderStartTransferEventParams *e) {...} // Or, connect one or more slots to this signal. void startTransfer(AS1SenderStartTransferEventParams *e);

Remarks

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

Transfer Event (AS1Sender Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireTransfer(AS1SenderTransferEventParams *e);
typedef struct {
int64 BytesTransferred; int reserved; } AS1SenderTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(AS1SenderTransferEventParams *e);
typedef struct {
LONG64 BytesTransferred; INT reserved; } AS1SenderTransferEventParams;
#define EID_AS1SENDER_TRANSFER 10

virtual INT IPWORKSEDI_CALL FireTransfer(LONG64 &lBytesTransferred);
class AS1SenderTransferEventParams {
public:
  qint64 bytesTransferred();

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

Remarks

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

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)

Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)

Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)

Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)

Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)

Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)

Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)

Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)

Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)

Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)

Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)

Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)

Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)

Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)

Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)

Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*

Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

StorePassword
char*

Default Value: ""

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

StoreType
int

Default Value: 0

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 field can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

NOTE: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

NOTE: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

NOTE: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

NOTE: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

NOTE: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

NOTE: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)

Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)

Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)

Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)

Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)

Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

  • Digital Signature
  • Non-Repudiation
  • Key Encipherment
  • Data Encipherment
  • Key Agreement
  • Certificate Signing
  • CRL Signing
  • Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)

Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)

Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*

Default Value: ""

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 field 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=example@email.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Encoded
char*

Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

EDIAttachment Type

This describes the file being attached.

Syntax

IPWorksEDIEDIAttachment (declared in ipworksedi.h)

Remarks

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

The following fields are available:

Fields

ContentType
char*

Default Value: ""

The MIME content-type of this EDIAttachment.

Data
char*

Default Value: ""

This field contains the attachment data.

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

FileName
char*

Default Value: ""

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 field. Otherwise, this will contain the name of the attachment as described in the Headers.

Headers
char*

Default Value: ""

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

Name
char*

Default Value: ""

Name is the final name to be associated with the contents of either the Data or FileName fields. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

Constructors

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

EDIData Type

The EDI payload of the AS2 message.

Syntax

IPWorksEDIEDIData (declared in ipworksedi.h)

Remarks

The EDI payload of the AS2 message.

The following fields are available:

Fields

Data
char*

Default Value: ""

This field contains the EDI payload of the transmission.

In a receiver, this field will only be populated if IncomingDirectory and OutputStream 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.

EDIType
char*

Default Value: ""

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

Name
char*

Default Value: "rfc1767.edi"

Name is the final name to be associated with the contents of either the Data or FileName fields. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

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

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

FileName
char*

Default Value: ""

In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission. Name 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 OutputStream is set, the data will be written to the stream and this field will not be populated.

Constructors

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

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksEDIFirewall (declared in ipworksedi.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
int

Default Value: FALSE

Whether to automatically detect and use firewall system settings, if available.

FirewallType
int

Default Value: 0

The type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*

Default Value: ""

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

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

Password
char*

Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int

Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

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

User
char*

Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Constructors

Firewall()

MDNReceipt Type

The complete MDN Receipt returned by the receiver.

Syntax

IPWorksEDIMDNReceipt (declared in ipworksedi.h)

Remarks

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

The following fields are available:

Fields

Content
char*

Default Value: ""

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

HeaderCount
int (read-only)

Default Value: 0

The number of headers in the MDN.

HeaderField
char* (read-only)

Default Value: ""

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

HeaderIndex
int

Default Value: 0

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

Valid values are 0 to HeaderCount - 1.

Headers
char*

Default Value: ""

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 HeaderCount, HeaderIndex, HeaderField, and HeaderValue to easily iterate through each individual header.

HeaderValue
char* (read-only)

Default Value: ""

The value of the MDN header currently selected by HeaderIndex.

MDN
char* (read-only)

Default Value: ""

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.

Message
char* (read-only)

Default Value: ""

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.

MICValue
char* (read-only)

Default Value: ""

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

SigningProtocol
char* (read-only)

Default Value: ""

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

Constructors

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

IPWorksEDIList Type

Syntax

IPWorksEDIList<T> (declared in ipworksedi.h)

Remarks

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

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

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

Config Settings (AS1Sender Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

AS1 Config Settings

LogFilename:   The base name of the log file.

If set, this will be used as for the filename of the log file.

Note that only the base name should be specified as the component will append the appropriate file extension.

POPPort:   The POP mail port to be used, if different than MailServer.

The mail port to be used for POP (or POP/S). For implicit SSL, use port 995.

POPServer:   The POP server to be used, if different than MailServer.

The mail server to be used for POP (or POP/S), in case different than MailServer.

SMTPAuthMechanism:   The authentication mechanism used to connect to the SMTP server.

By default, SMTPAuthMechanism is set to 0, which sends the AUTH command is SMTPUser and SMTPPassword are set. SMTPAuthMechanism can be set to 1 to use the more secure CRAM-MD5 authentication command.

SMTPPassword:   The password used for authentication.

If SMTPPassword is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication.

SMTPPort:   The SMTP mail port to be used, if different than MailServer.

The mail port to be used for SMTP (or POP/S). For implicit SSL, use port 465.

SMTPServer:   The SMTP server to be used, if different than MailServer.

The mail server to be used for SMTP (or SMTP/S), in case different than MailServer.

SMTPSSLStartMode:   Determines how SSL negotiation starts with the SMTP server.

0 ssl Automatic 1 ssl Implicit 2 ssl Explicit 3 ssl None Default These modes have the same interpretation as defined by the property SSLStartMode.

SMTPUser:   The user name used for authentication.

If SMTPUser is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication.

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts:   A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internalinclude the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include the following:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (Hex 300) (Default - Client)
TLS1 192 (Hex C0) (Default - Client)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

  • The platform provider is available only on Windows 11/Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown certificate authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown certificate authority revocation status.
0x00000800Ignore unknown root revocation status.
0x00008000Allow test root certificate.
0x00004000Trust test root certificate.
0x80000000Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (AS1Sender Class)

Error Handling (C++)

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

AS1Sender Errors

501   Unable to parse the receipt.
502   The receipt is signed with an unsupported signature format (details follow).
511   Unsupported compression algorithm requested.
521   A Message Integrity Check was requested, but not provided in the MDN.
522   The Message Integrity Check returned in the MDN is incorrect.
523   Unable to parse Message Integrity Check.
524   Unrequested hashing algorithm used (check MDNOptions).
525   The Message ID returned in the MDN does not match.
531   The receipt was unsigned, and a signed receipt was expected.
532   The receipt signature could not be verified.
533   An MDN was expected, but was not returned.
600   Failure reported in MDN: Unsupported signing protocol.
601   Failure reported in MDN: Unsupported MIC algorithms.
602   Failure reported in MDN: Other (details follow).
611   Error reported in MDN: Decryption failed.
612   Error reported in MDN: Authentication failed.
613   Error reported in MDN: Could not verify content integrity.
614   Error reported in MDN: Unexpected processing error.
615   Error reported in MDN: Other (details follow).
621   Warning reported in MDN: Authentication failed, processing continued by receiver.
622   Warning reported in MDN: Other (details follow).
831   I/O Error (details follow).

POP Errors

116   MailPort cannot be zero. Please specify a valid service port number.
118   Firewall error. Error message contains detailed description.
171   POP protocol error. Description contains the server reply.
172   Error communicating with server. Error text is attached.
173   Please specify a valid MailServer.
174   Busy executing current method.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

SMTP Errors

118   Firewall Error. Error message contains detailed description.
161   SMTP protocol error. Description contains the server reply.
162   Error communicating with server. Error text is attached.
163   Please specify a MailServer.
164   Please specify a sender (From).
165   Please specify a recipient.
166   Busy executing current method.
301   Operation interrupted.
302   Cannot open AttachedFile.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

SMIME Errors

10191   Invalid index (RecipientIndex).
10192   Message decoding error (code).
10193   Unexpected message type.
10194   Unsupported hashing/signing algorithm.
10195   The message does not have any signers.
10196   The message signature could not be verified.
10197   Could not locate a suitable decryption certificate.
10198   The signer certificate could not be found.
10199   No signing certificate was supplied for signing the message.
10201   The specified certificate was not the one required.
10202   The specified certificate could not be found.
10221   Could not acquire CSP.
10222   Type validation error.
10223   Unsupported key size.
10224   Unrecognized Content-Type object identifier.
10225   Unrecognized public key format.
10226   No choices specified.
10228   Must specify output stream.
10280   Invalid part index.
10281   Unknown MIME type.
10283   No MIME-boundary found.
10280   Error decoding certificate.