AS1Sender Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TibeAS1Sender

Remarks

The AS1Sender component is used to send EDI or other messages over SMTP/S, using the AS1 protocol specified in RFC 3335. The component 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 EDIData and EDIEDIType. 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AttachmentCount Property (AS1Sender Component)

The number of records in the Attachment arrays.

Syntax

__property int AttachmentCount = { read=FAttachmentCount, write=FSetAttachmentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentHeaders
• AttachmentName

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

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (AS1Sender Component)

The MIME content-type of this ediattachment .

Syntax

__property String AttachmentContentType[int AttachmentIndex] = { read=FAttachmentContentType, write=FSetAttachmentContentType };

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

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

This property is not available at design time.

Data Type

String

AttachmentData Property (AS1Sender Component)

This property contains the attachment data.

Syntax

__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData, write=FSetAttachmentData };
__property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB, write=FSetAttachmentDataB };

Default Value

""

Remarks

This property contains the attachment data.

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

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

This property is not available at design time.

Data Type

Byte Array

AttachmentFileName Property (AS1Sender Component)

The file name of the attachment.

Syntax

__property String AttachmentFileName[int AttachmentIndex] = { read=FAttachmentFileName, write=FSetAttachmentFileName };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentHeaders Property (AS1Sender Component)

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

Syntax

__property String AttachmentHeaders[int AttachmentIndex] = { read=FAttachmentHeaders, write=FSetAttachmentHeaders };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentName Property (AS1Sender Component)

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

Syntax

__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName, write=FSetAttachmentName };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

CompressionFormat Property (AS1Sender Component)

The compression format (if any) to use.

Syntax

__property TibeAS1SenderCompressionFormats CompressionFormat = { read=FCompressionFormat, write=FSetCompressionFormat };

enum TibeAS1SenderCompressionFormats {
  cfNone=0,
  cfZLIB=1
};

Default Value

cfNone

Remarks

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

Whether the component is connected.

Syntax

__property bool Connected = { read=FConnected };

Default Value

False

Remarks

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

This property contains the EDI payload of the transmission.

Syntax

__property String EDIData = { read=FEDIData, write=FSetEDIData };
__property DynamicArray<Byte> EDIDataB = { read=FEDIDataB, write=FSetEDIDataB };

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

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

The EDI message to send.

This property is not available at design time.

Data Type

Byte Array

EDIType Property (AS1Sender Component)

The Content-Type of the EDI message.

Syntax

__property String EDIType = { read=FEDIType, write=FSetEDIType };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EDIName Property (AS1Sender Component)

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

Syntax

__property String EDIName = { read=FEDIName, write=FSetEDIName };

Default Value

"rfc1767.edi"

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EDIFileName Property (AS1Sender Component)

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

Syntax

__property String EDIFileName = { read=FEDIFileName, write=FSetEDIFileName };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AS1Sender Component)

The algorithm used to encrypt the EDI data.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

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

The component 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

FirewallAutoDetect Property (AS1Sender Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (AS1Sender Component)

The type of firewall to connect through.

Syntax

__property TibeAS1SenderFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TibeAS1SenderFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (AS1Sender Component)

The name or IP address of the firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (AS1Sender Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (AS1Sender Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (AS1Sender Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

From Property (AS1Sender Component)

The sender of the original message.

Syntax

__property String From = { read=FFrom, write=FSetFrom };

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

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

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 component initiate connections (or accept in the case of server components) 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 component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for 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 Component)

The path to a directory for logging.

Syntax

__property String LogDirectory = { read=FLogDirectory, write=FSetLogDirectory };

Default Value

""

Remarks

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

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

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

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS1Sender Component)

The log file written.

Syntax

__property String LogFile = { read=FLogFile };

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

The value of the Cc header of the mail message.

Syntax

__property String MailMessageCc = { read=FMailMessageCc };

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

The number of messages waiting in the mailbox.

Syntax

__property int MailMessageCount = { read=FMailMessageCount };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

MailMessageDate Property (AS1Sender Component)

The message date for the currently selected message.

Syntax

__property String MailMessageDate = { read=FMailMessageDate };

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

The sender of the mail message.

Syntax

__property String MailMessageFrom = { read=FMailMessageFrom };

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

The message headers for the currently selected message.

Syntax

__property String MailMessageHeaders = { read=FMailMessageHeaders };

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

The message number on the incoming mail server.

Syntax

__property int MailMessageNumber = { read=FMailMessageNumber, write=FSetMailMessageNumber };

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

The value of the ReplyTo header of the mail message.

Syntax

__property String MailMessageReplyTo = { read=FMailMessageReplyTo };

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

The subject of the mail message.

Syntax

__property String MailMessageSubject = { read=FMailMessageSubject };

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

The text of the mail message.

Syntax

__property String MailMessageText = { read=FMailMessageText };

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

The recipient of the mail message.

Syntax

__property String MailMessageTo = { read=FMailMessageTo };

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

The address of your mail server.

Syntax

__property String MailServer = { read=FMailServer, write=FSetMailServer };

Default Value

""

Remarks

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

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

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

Data Type

String

MDNOptions Property (AS1Sender Component)

Used to indicate the options requested for the MDN receipt.

Syntax

__property String MDNOptions = { read=FMDNOptions, write=FSetMDNOptions };

Default Value

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

Remarks

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

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

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

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

Data Type

String

MDNReceiptContent Property (AS1Sender Component)

This contains the entire content of the MDN Receipt.

Syntax

__property String MDNReceiptContent = { read=FMDNReceiptContent, write=FSetMDNReceiptContent };
__property DynamicArray<Byte> MDNReceiptContentB = { read=FMDNReceiptContentB, write=FSetMDNReceiptContentB };

Default Value

""

Remarks

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

Data Type

Byte Array

MDNReceiptHeaderCount Property (AS1Sender Component)

The number of headers in the MDN.

Syntax

__property int MDNReceiptHeaderCount = { read=FMDNReceiptHeaderCount };

Default Value

0

Remarks

The number of headers in the MDN.

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

Data Type

Integer

MDNReceiptHeaderField Property (AS1Sender Component)

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

Syntax

__property String MDNReceiptHeaderField = { read=FMDNReceiptHeaderField };

Default Value

""

Remarks

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

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

Data Type

String

MDNReceiptHeaderIndex Property (AS1Sender Component)

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

Syntax

__property int MDNReceiptHeaderIndex = { read=FMDNReceiptHeaderIndex, write=FSetMDNReceiptHeaderIndex };

Default Value

0

Remarks

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

Valid values are 0 to MDNReceiptHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MDNReceiptHeaders Property (AS1Sender Component)

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

Syntax

__property String MDNReceiptHeaders = { read=FMDNReceiptHeaders, write=FSetMDNReceiptHeaders };

Default Value

""

Remarks

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

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

Data Type

String

MDNReceiptHeaderValue Property (AS1Sender Component)

The value of the MDN header currently selected by HeaderIndex .

Syntax

__property String MDNReceiptHeaderValue = { read=FMDNReceiptHeaderValue };

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

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

Data Type

String

MDNReceiptMDN Property (AS1Sender Component)

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

Syntax

__property String MDNReceiptMDN = { read=FMDNReceiptMDN };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MDNReceiptMessage Property (AS1Sender Component)

The human-readable portion of the MDN receipt.

Syntax

__property String MDNReceiptMessage = { read=FMDNReceiptMessage };

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

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

This property is read-only.

Data Type

String

MDNReceiptMICValue Property (AS1Sender Component)

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

Syntax

__property String MDNReceiptMICValue = { read=FMDNReceiptMICValue };

Default Value

""

Remarks

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

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

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

This property is read-only.

Data Type

String

MDNReceiptSigningProtocol Property (AS1Sender Component)

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

Syntax

__property String MDNReceiptSigningProtocol = { read=FMDNReceiptSigningProtocol };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

MDNTo Property (AS1Sender Component)

The system to which an MDN should be directed.

Syntax

__property String MDNTo = { read=FMDNTo, write=FSetMDNTo };

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 component will request a PKCS#7 signature signed over SHA-256. This can be customized by specifying MDNOptions.

Data Type

String

MessageId Property (AS1Sender Component)

The Id of the message.

Syntax

__property String MessageId = { read=FMessageId, write=FSetMessageId };

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 component 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 Component)

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

Syntax

__property String OriginalContentMIC = { read=FOriginalContentMIC, write=FSetOriginalContentMIC };

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

The password for your incoming mail server.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

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

Data Type

String

ReceiptSignerCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String ReceiptSignerCertEffectiveDate = { read=FReceiptSignerCertEffectiveDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String ReceiptSignerCertExpirationDate = { read=FReceiptSignerCertExpirationDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String ReceiptSignerCertExtendedKeyUsage = { read=FReceiptSignerCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String ReceiptSignerCertFingerprint = { read=FReceiptSignerCertFingerprint };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String ReceiptSignerCertFingerprintSHA1 = { read=FReceiptSignerCertFingerprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String ReceiptSignerCertFingerprintSHA256 = { read=FReceiptSignerCertFingerprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String ReceiptSignerCertIssuer = { read=FReceiptSignerCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String ReceiptSignerCertPrivateKey = { read=FReceiptSignerCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ReceiptSignerCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool ReceiptSignerCertPrivateKeyAvailable = { read=FReceiptSignerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

ReceiptSignerCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String ReceiptSignerCertPrivateKeyContainer = { read=FReceiptSignerCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String ReceiptSignerCertPublicKey = { read=FReceiptSignerCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String ReceiptSignerCertPublicKeyAlgorithm = { read=FReceiptSignerCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int ReceiptSignerCertPublicKeyLength = { read=FReceiptSignerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

ReceiptSignerCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String ReceiptSignerCertSerialNumber = { read=FReceiptSignerCertSerialNumber };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String ReceiptSignerCertSignatureAlgorithm = { read=FReceiptSignerCertSignatureAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String ReceiptSignerCertStore = { read=FReceiptSignerCertStore, write=FSetReceiptSignerCertStore };
__property DynamicArray<Byte> ReceiptSignerCertStoreB = { read=FReceiptSignerCertStoreB, write=FSetReceiptSignerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Byte Array

ReceiptSignerCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String ReceiptSignerCertStorePassword = { read=FReceiptSignerCertStorePassword, write=FSetReceiptSignerCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

ReceiptSignerCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderReceiptSignerCertStoreTypes ReceiptSignerCertStoreType = { read=FReceiptSignerCertStoreType, write=FSetReceiptSignerCertStoreType };

enum TibeAS1SenderReceiptSignerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

ReceiptSignerCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String ReceiptSignerCertSubjectAltNames = { read=FReceiptSignerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String ReceiptSignerCertThumbprintMD5 = { read=FReceiptSignerCertThumbprintMD5 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String ReceiptSignerCertThumbprintSHA1 = { read=FReceiptSignerCertThumbprintSHA1 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String ReceiptSignerCertThumbprintSHA256 = { read=FReceiptSignerCertThumbprintSHA256 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

ReceiptSignerCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String ReceiptSignerCertUsage = { read=FReceiptSignerCertUsage };

Default Value

""

Remarks

The text description of ReceiptSignerCertUsageFlags.

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.

This property is read-only.

Data Type

String

ReceiptSignerCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int ReceiptSignerCertUsageFlags = { read=FReceiptSignerCertUsageFlags };

Default Value

0

Remarks

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

Please see the ReceiptSignerCertUsage property for a text representation of ReceiptSignerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

ReceiptSignerCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String ReceiptSignerCertVersion = { read=FReceiptSignerCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String ReceiptSignerCertSubject = { read=FReceiptSignerCertSubject, write=FSetReceiptSignerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

ReceiptSignerCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String ReceiptSignerCertEncoded = { read=FReceiptSignerCertEncoded, write=FSetReceiptSignerCertEncoded };
__property DynamicArray<Byte> ReceiptSignerCertEncodedB = { read=FReceiptSignerCertEncodedB, write=FSetReceiptSignerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

RecipientCertCount Property (AS1Sender Component)

The number of records in the RecipientCert arrays.

Syntax

__property int RecipientCertCount = { read=FRecipientCertCount, write=FSetRecipientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEffectiveDate
• RecipientCertEncoded
• RecipientCertExpirationDate
• RecipientCertExtendedKeyUsage
• RecipientCertFingerprint
• RecipientCertFingerprintSHA1
• RecipientCertFingerprintSHA256
• RecipientCertIssuer
• RecipientCertPrivateKey
• RecipientCertPrivateKeyAvailable
• RecipientCertPrivateKeyContainer
• RecipientCertPublicKey
• RecipientCertPublicKeyAlgorithm
• RecipientCertPublicKeyLength
• RecipientCertSerialNumber
• RecipientCertSignatureAlgorithm
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject
• RecipientCertSubjectAltNames
• RecipientCertThumbprintMD5
• RecipientCertThumbprintSHA1
• RecipientCertThumbprintSHA256
• RecipientCertUsage
• RecipientCertUsageFlags
• RecipientCertVersion

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

This property is not available at design time.

Data Type

Integer

RecipientCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String RecipientCertEffectiveDate[int RecipientCertIndex] = { read=FRecipientCertEffectiveDate };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String RecipientCertExpirationDate[int RecipientCertIndex] = { read=FRecipientCertExpirationDate };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String RecipientCertExtendedKeyUsage[int RecipientCertIndex] = { read=FRecipientCertExtendedKeyUsage };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprint[int RecipientCertIndex] = { read=FRecipientCertFingerprint };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprintSHA1[int RecipientCertIndex] = { read=FRecipientCertFingerprintSHA1 };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprintSHA256[int RecipientCertIndex] = { read=FRecipientCertFingerprintSHA256 };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String RecipientCertIssuer[int RecipientCertIndex] = { read=FRecipientCertIssuer };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String RecipientCertPrivateKey[int RecipientCertIndex] = { read=FRecipientCertPrivateKey };

Default Value

""

Remarks

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

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

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

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

Data Type

String

RecipientCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool RecipientCertPrivateKeyAvailable[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyAvailable };

Default Value

false

Remarks

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

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

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

Data Type

Boolean

RecipientCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String RecipientCertPrivateKeyContainer[int RecipientCertIndex] = { read=FRecipientCertPrivateKeyContainer };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String RecipientCertPublicKey[int RecipientCertIndex] = { read=FRecipientCertPublicKey };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String RecipientCertPublicKeyAlgorithm[int RecipientCertIndex] = { read=FRecipientCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int RecipientCertPublicKeyLength[int RecipientCertIndex] = { read=FRecipientCertPublicKeyLength };

Default Value

0

Remarks

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

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

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

Data Type

Integer

RecipientCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String RecipientCertSerialNumber[int RecipientCertIndex] = { read=FRecipientCertSerialNumber };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String RecipientCertSignatureAlgorithm[int RecipientCertIndex] = { read=FRecipientCertSignatureAlgorithm };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String RecipientCertStore[int RecipientCertIndex] = { read=FRecipientCertStore, write=FSetRecipientCertStore };
__property DynamicArray<Byte> RecipientCertStoreB[int RecipientCertIndex] = { read=FRecipientCertStoreB, write=FSetRecipientCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

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

This property is not available at design time.

Data Type

Byte Array

RecipientCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String RecipientCertStorePassword[int RecipientCertIndex] = { read=FRecipientCertStorePassword, write=FSetRecipientCertStorePassword };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderRecipientCertStoreTypes RecipientCertStoreType[int RecipientCertIndex] = { read=FRecipientCertStoreType, write=FSetRecipientCertStoreType };

enum TibeAS1SenderRecipientCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

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

This property is not available at design time.

Data Type

Integer

RecipientCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String RecipientCertSubjectAltNames[int RecipientCertIndex] = { read=FRecipientCertSubjectAltNames };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String RecipientCertThumbprintMD5[int RecipientCertIndex] = { read=FRecipientCertThumbprintMD5 };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String RecipientCertThumbprintSHA1[int RecipientCertIndex] = { read=FRecipientCertThumbprintSHA1 };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String RecipientCertThumbprintSHA256[int RecipientCertIndex] = { read=FRecipientCertThumbprintSHA256 };

Default Value

""

Remarks

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.

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

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

Data Type

String

RecipientCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String RecipientCertUsage[int RecipientCertIndex] = { read=FRecipientCertUsage };

Default Value

""

Remarks

The text description of RecipientCertUsageFlags.

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.

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

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

Data Type

String

RecipientCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int RecipientCertUsageFlags[int RecipientCertIndex] = { read=FRecipientCertUsageFlags };

Default Value

0

Remarks

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

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

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

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

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

Data Type

Integer

RecipientCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String RecipientCertVersion[int RecipientCertIndex] = { read=FRecipientCertVersion };

Default Value

""

Remarks

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

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

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

Data Type

String

RecipientCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String RecipientCertSubject[int RecipientCertIndex] = { read=FRecipientCertSubject, write=FSetRecipientCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

RecipientCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String RecipientCertEncoded[int RecipientCertIndex] = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded };
__property DynamicArray<Byte> RecipientCertEncodedB[int RecipientCertIndex] = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

SendTo Property (AS1Sender Component)

The recipient of the message.

Syntax

__property String SendTo = { read=FSendTo, write=FSetSendTo };

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

Signature algorithm to be used in outgoing messages.

Syntax

__property String SignatureAlgorithm = { read=FSignatureAlgorithm, write=FSetSignatureAlgorithm };

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

SigningCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String SigningCertEffectiveDate = { read=FSigningCertEffectiveDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String SigningCertExpirationDate = { read=FSigningCertExpirationDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SigningCertExtendedKeyUsage = { read=FSigningCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprint = { read=FSigningCertFingerprint };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprintSHA1 = { read=FSigningCertFingerprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SigningCertFingerprintSHA256 = { read=FSigningCertFingerprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String SigningCertIssuer = { read=FSigningCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String SigningCertPrivateKey = { read=FSigningCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SigningCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SigningCertPrivateKeyAvailable = { read=FSigningCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SigningCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SigningCertPrivateKeyContainer = { read=FSigningCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String SigningCertPublicKey = { read=FSigningCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SigningCertPublicKeyAlgorithm = { read=FSigningCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int SigningCertPublicKeyLength = { read=FSigningCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SigningCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SigningCertSerialNumber = { read=FSigningCertSerialNumber };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SigningCertSignatureAlgorithm = { read=FSigningCertSignatureAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String SigningCertStore = { read=FSigningCertStore, write=FSetSigningCertStore };
__property DynamicArray<Byte> SigningCertStoreB = { read=FSigningCertStoreB, write=FSetSigningCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Byte Array

SigningCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String SigningCertStorePassword = { read=FSigningCertStorePassword, write=FSetSigningCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SigningCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderSigningCertStoreTypes SigningCertStoreType = { read=FSigningCertStoreType, write=FSetSigningCertStoreType };

enum TibeAS1SenderSigningCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SigningCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String SigningCertSubjectAltNames = { read=FSigningCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String SigningCertThumbprintMD5 = { read=FSigningCertThumbprintMD5 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String SigningCertThumbprintSHA1 = { read=FSigningCertThumbprintSHA1 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String SigningCertThumbprintSHA256 = { read=FSigningCertThumbprintSHA256 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SigningCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String SigningCertUsage = { read=FSigningCertUsage };

Default Value

""

Remarks

The text description of SigningCertUsageFlags.

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.

This property is read-only.

Data Type

String

SigningCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int SigningCertUsageFlags = { read=FSigningCertUsageFlags };

Default Value

0

Remarks

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

Please see the SigningCertUsage property for a text representation of SigningCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SigningCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String SigningCertVersion = { read=FSigningCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SigningCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject, write=FSetSigningCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SigningCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SigningCertEncoded = { read=FSigningCertEncoded, write=FSetSigningCertEncoded };
__property DynamicArray<Byte> SigningCertEncodedB = { read=FSigningCertEncodedB, write=FSetSigningCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLAcceptServerCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore };
__property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Byte Array

SSLAcceptServerCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };

enum TibeAS1SenderSSLAcceptServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprint = { read=FSSLCertFingerprint };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String SSLCertIssuer = { read=FSSLCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String SSLCertPublicKey = { read=FSSLCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Byte Array

SSLCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibeAS1SenderSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String SSLCertUsage = { read=FSSLCertUsage };

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String SSLCertVersion = { read=FSSLCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLProvider Property (AS1Sender Component)

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

Syntax

__property TibeAS1SenderSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibeAS1SenderSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (AS1Sender Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (AS1Sender Component)

The date on which the certificate expires.

Syntax

__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (AS1Sender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (AS1Sender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (AS1Sender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (AS1Sender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (AS1Sender Component)

The issuer of the certificate.

Syntax

__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (AS1Sender Component)

The private key of the certificate (if available).

Syntax

__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (AS1Sender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (AS1Sender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (AS1Sender Component)

The public key of the certificate.

Syntax

__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (AS1Sender Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (AS1Sender Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (AS1Sender Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (AS1Sender Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (AS1Sender Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLServerCertStore = { read=FSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

This property is read-only.

Data Type

Byte Array

SSLServerCertStorePassword Property (AS1Sender Component)

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

Syntax

__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (AS1Sender Component)

The type of certificate store for this certificate.

Syntax

__property TibeAS1SenderSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

enum TibeAS1SenderSSLServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (AS1Sender Component)

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

Syntax

__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (AS1Sender Component)

The MD5 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (AS1Sender Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (AS1Sender Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (AS1Sender Component)

The text description of UsageFlags .

Syntax

__property String SSLServerCertUsage = { read=FSSLServerCertUsage };

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (AS1Sender Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (AS1Sender Component)

The certificate's version number.

Syntax

__property String SSLServerCertVersion = { read=FSSLServerCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (AS1Sender Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLServerCertSubject = { read=FSSLServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (AS1Sender Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

SSLStartMode Property (AS1Sender Component)

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

Syntax

__property TibeAS1SenderSSLStartModes SSLStartMode = { read=FSSLStartMode, write=FSetSSLStartMode };

enum TibeAS1SenderSSLStartModes {
  sslAutomatic=0,
  sslImplicit=1,
  sslExplicit=2,
  sslNone=3
};

Default Value

sslNone

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Subject Property (AS1Sender Component)

The subject of the message.

Syntax

__property String Subject = { read=FSubject, write=FSetSubject };

Default Value

"AS1 Message"

Remarks

The human-readable subject of the outgoing message.

Data Type

String

User Property (AS1Sender Component)

The username for your incoming mail server.

Syntax

__property String User = { read=FUser, write=FSetUser };

Default Value

""

Remarks

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

Data Type

String

Config Method (AS1Sender Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

Connect Method (AS1Sender Component)

Connects to the incoming mail server.

Syntax

void __fastcall Connect();

Remarks

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

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

DeleteMessage Method (AS1Sender Component)

Deletes the message specified by MailMessageNumber .

Syntax

void __fastcall DeleteMessage();

Remarks

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

Disconnect Method (AS1Sender Component)

Disconnects from the incoming mail server.

Syntax

void __fastcall Disconnect();

Remarks

Disconnects from the incoming mail server specified by MailServer.

ProcessQueue Method (AS1Sender Component)

Send the messages queued for sending.

Syntax

void __fastcall ProcessQueue(String Directory);

Remarks

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

QueryMessageSize Method (AS1Sender Component)

Returns the size in bytes of the current message.

Syntax

int __fastcall QueryMessageSize();

Remarks

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

QueryMessageUID Method (AS1Sender Component)

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

Syntax

String __fastcall QueryMessageUID();

Remarks

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

Queue Method (AS1Sender Component)

Prepares and queues the message to the specified directory.

Syntax

void __fastcall Queue(String Directory);

Remarks

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

ReadReceipt Method (AS1Sender Component)

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

Syntax

void __fastcall 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 component 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 component will process the receipt specified by MDNReceipt.

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

Finally, VerifyReceipt should be used to verify the receipt.

Reset Method (AS1Sender Component)

Resets the state of the control.

Syntax

void __fastcall Reset();

Remarks

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

SelectMailMessage Method (AS1Sender Component)

Selects and obtains information about the specified message.

Syntax

void __fastcall SelectMailMessage();

Remarks

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

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

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

Send Method (AS1Sender Component)

Prepares and sends the AS1 message.

Syntax

void __fastcall Send();

Remarks

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

You should set MailServer prior to sending.

SetRequestHeader Method (AS1Sender Component)

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

Syntax

void __fastcall SetRequestHeader(String HeaderName, String HeaderValue);

Remarks

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

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

VerifyReceipt Method (AS1Sender Component)

Verifies an MDN receipt.

Syntax

void __fastcall VerifyReceipt();

Remarks

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

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

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

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

ConnectionStatus Event (AS1Sender Component)

Fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TibeAS1SenderConnectionStatusEventParams;
typedef void __fastcall (__closure *TibeAS1SenderConnectionStatusEvent)(System::TObject* Sender, TibeAS1SenderConnectionStatusEventParams *e);
__property TibeAS1SenderConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

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

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

EndTransfer Event (AS1Sender Component)

Fired when the message text completes transferring.

Syntax

typedef struct {
} TibeAS1SenderEndTransferEventParams;
typedef void __fastcall (__closure *TibeAS1SenderEndTransferEvent)(System::TObject* Sender, TibeAS1SenderEndTransferEventParams *e);
__property TibeAS1SenderEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

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

Error Event (AS1Sender Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibeAS1SenderErrorEventParams;
typedef void __fastcall (__closure *TibeAS1SenderErrorEvent)(System::TObject* Sender, TibeAS1SenderErrorEventParams *e);
__property TibeAS1SenderErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Header Event (AS1Sender Component)

This event is fired for every message header being retrieved.

Syntax

typedef struct {
  String Field;
  String Value;
} TibeAS1SenderHeaderEventParams;
typedef void __fastcall (__closure *TibeAS1SenderHeaderEvent)(System::TObject* Sender, TibeAS1SenderHeaderEventParams *e);
__property TibeAS1SenderHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

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

Fired with log information while processing a message.

Syntax

typedef struct {
  String LogType;
  String LogMessage;
  DynamicArray<Byte> LogMessageB;
} TibeAS1SenderLogEventParams;
typedef void __fastcall (__closure *TibeAS1SenderLogEvent)(System::TObject* Sender, TibeAS1SenderLogEventParams *e);
__property TibeAS1SenderLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

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

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

The LogMessage event parameter holds the raw log data.

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

PITrail Event (AS1Sender Component)

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

Syntax

typedef struct {
  int Direction;
  String Message;
} TibeAS1SenderPITrailEventParams;
typedef void __fastcall (__closure *TibeAS1SenderPITrailEvent)(System::TObject* Sender, TibeAS1SenderPITrailEventParams *e);
__property TibeAS1SenderPITrailEvent OnPITrail = { read=FOnPITrail, write=FOnPITrail };

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:

SSLServerAuthentication Event (AS1Sender Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibeAS1SenderSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibeAS1SenderSSLServerAuthenticationEvent)(System::TObject* Sender, TibeAS1SenderSSLServerAuthenticationEventParams *e);
__property TibeAS1SenderSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibeAS1SenderSSLStatusEventParams;
typedef void __fastcall (__closure *TibeAS1SenderSSLStatusEvent)(System::TObject* Sender, TibeAS1SenderSSLStatusEventParams *e);
__property TibeAS1SenderSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

StartTransfer Event (AS1Sender Component)

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

Syntax

typedef struct {
} TibeAS1SenderStartTransferEventParams;
typedef void __fastcall (__closure *TibeAS1SenderStartTransferEvent)(System::TObject* Sender, TibeAS1SenderStartTransferEventParams *e);
__property TibeAS1SenderStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

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

Transfer Event (AS1Sender Component)

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

Syntax

typedef struct {
  __int64 BytesTransferred;
} TibeAS1SenderTransferEventParams;
typedef void __fastcall (__closure *TibeAS1SenderTransferEvent)(System::TObject* Sender, TibeAS1SenderTransferEventParams *e);
__property TibeAS1SenderTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

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

Config Settings (AS1Sender Component)

AS1 Config Settings

SSL Config Settings

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

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

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

Base Config Settings