AS1Sender Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_AS1Sender

Procedural Interface

 ipworksedi_as1sender_open();
 ipworksedi_as1sender_close($res);
 ipworksedi_as1sender_register_callback($res, $id, $function);
 ipworksedi_as1sender_get_last_error($res);
 ipworksedi_as1sender_get_last_error_code($res);
 ipworksedi_as1sender_set($res, $id, $index, $value);
 ipworksedi_as1sender_get($res, $id, $index);
 ipworksedi_as1sender_do_config($res, $configurationstring);
 ipworksedi_as1sender_do_connect($res);
 ipworksedi_as1sender_do_deletemessage($res);
 ipworksedi_as1sender_do_disconnect($res);
 ipworksedi_as1sender_do_processqueue($res, $directory);
 ipworksedi_as1sender_do_querymessagesize($res);
 ipworksedi_as1sender_do_querymessageuid($res);
 ipworksedi_as1sender_do_queue($res, $directory);
 ipworksedi_as1sender_do_readreceipt($res);
 ipworksedi_as1sender_do_reset($res);
 ipworksedi_as1sender_do_selectmailmessage($res);
 ipworksedi_as1sender_do_send($res);
 ipworksedi_as1sender_do_setrequestheader($res, $headername, $headervalue);
 ipworksedi_as1sender_do_verifyreceipt($res);

Remarks

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

A typical AS1 transaction is as follows:

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

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

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

When sending an EDI message, the client should specify, at a minimum, From and SendTo, MailServer, and 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 class will apply message security if the appropriate certificates are specified. To sign the data set SigningCert. To encrypt, set RecipientCerts.

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

The message may also be compressed by setting CompressionFormat.

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

Validating AS1 MDNs

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

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AttachmentCount Property (IPWorksEDI_AS1Sender Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();
public function setAttachmentCount($value);

Procedural Interface

ipworksedi_as1sender_get($res, 1 );
ipworksedi_as1sender_set($res, 1, $value );

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

The MIME content-type of this ediattachment .

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);
public function setAttachmentContentType($attachmentindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 2 , $attachmentindex);
ipworksedi_as1sender_set($res, 2, $value , $attachmentindex);

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

This property contains the attachment data.

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 3 , $attachmentindex);
ipworksedi_as1sender_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

This property contains the attachment data.

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

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

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (IPWorksEDI_AS1Sender Class)

The file name of the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 4 , $attachmentindex);
ipworksedi_as1sender_set($res, 4, $value , $attachmentindex);

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

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

Object Oriented Interface

public function getAttachmentHeaders($attachmentindex);
public function setAttachmentHeaders($attachmentindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 5 , $attachmentindex);
ipworksedi_as1sender_set($res, 5, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentName Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 6 , $attachmentindex);
ipworksedi_as1sender_set($res, 6, $value , $attachmentindex);

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

The compression format (if any) to use.

Object Oriented Interface

public function getCompressionFormat();
public function setCompressionFormat($value);

Procedural Interface

ipworksedi_as1sender_get($res, 7 );
ipworksedi_as1sender_set($res, 7, $value );

Possible Values

AS1SENDER_COMPRESSIONFORMAT_NONE(0), 
AS1SENDER_COMPRESSIONFORMAT_ZLIB(1)

Default Value

0

Remarks

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

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

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

Data Type

Integer

Connected Property (IPWorksEDI_AS1Sender Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksedi_as1sender_get($res, 8 );

Default Value

false

Remarks

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

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

Data Type

Boolean

EDIData Property (IPWorksEDI_AS1Sender Class)

This property contains the EDI payload of the transmission.

Object Oriented Interface

public function getEDIData();
public function setEDIData($value);

Procedural Interface

ipworksedi_as1sender_get($res, 9 );
ipworksedi_as1sender_set($res, 9, $value );

Default Value

''

Remarks

This property contains the EDI payload of the transmission.

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

The EDI message to send.

This property is not available at design time.

Data Type

Binary String

EDIType Property (IPWorksEDI_AS1Sender Class)

The Content-Type of the EDI message.

Object Oriented Interface

public function getEDIType();
public function setEDIType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 10 );
ipworksedi_as1sender_set($res, 10, $value );

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

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

Object Oriented Interface

public function getEDIName();
public function setEDIName($value);

Procedural Interface

ipworksedi_as1sender_get($res, 11 );
ipworksedi_as1sender_set($res, 11, $value );

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

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

Object Oriented Interface

public function getEDIFileName();
public function setEDIFileName($value);

Procedural Interface

ipworksedi_as1sender_get($res, 12 );
ipworksedi_as1sender_set($res, 12, $value );

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

The algorithm used to encrypt the EDI data.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

ipworksedi_as1sender_get($res, 13 );
ipworksedi_as1sender_set($res, 13, $value );

Default Value

'3DES'

Remarks

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

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

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

Possible values are:

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

Data Type

String

FirewallAutoDetect Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksedi_as1sender_get($res, 14 );
ipworksedi_as1sender_set($res, 14, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksEDI_AS1Sender Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 15 );
ipworksedi_as1sender_set($res, 15, $value );

Possible Values

AS1SENDER_FIREWALLTYPE_NONE(0), 
AS1SENDER_FIREWALLTYPE_TUNNEL(1), 
AS1SENDER_FIREWALLTYPE_SOCKS4(2), 
AS1SENDER_FIREWALLTYPE_SOCKS5(3), 
AS1SENDER_FIREWALLTYPE_SOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksedi_as1sender_get($res, 16 );
ipworksedi_as1sender_set($res, 16, $value );

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 class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 17 );
ipworksedi_as1sender_set($res, 17, $value );

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 class fails with an error.

Data Type

String

FirewallPort Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksedi_as1sender_get($res, 18 );
ipworksedi_as1sender_set($res, 18, $value );

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

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

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksedi_as1sender_get($res, 19 );
ipworksedi_as1sender_set($res, 19, $value );

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 class fails with an error.

Data Type

String

From Property (IPWorksEDI_AS1Sender Class)

The sender of the original message.

Object Oriented Interface

public function getFrom();
public function setFrom($value);

Procedural Interface

ipworksedi_as1sender_get($res, 20 );
ipworksedi_as1sender_set($res, 20, $value );

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

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksedi_as1sender_get($res, 21 );
ipworksedi_as1sender_set($res, 21, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

LogDirectory Property (IPWorksEDI_AS1Sender Class)

The path to a directory for logging.

Object Oriented Interface

public function getLogDirectory();
public function setLogDirectory($value);

Procedural Interface

ipworksedi_as1sender_get($res, 22 );
ipworksedi_as1sender_set($res, 22, $value );

Default Value

''

Remarks

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

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

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

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (IPWorksEDI_AS1Sender Class)

The log file written.

Object Oriented Interface

public function getLogFile();

Procedural Interface

ipworksedi_as1sender_get($res, 23 );

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

The value of the Cc header of the mail message.

Object Oriented Interface

public function getMailMessageCc();

Procedural Interface

ipworksedi_as1sender_get($res, 24 );

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

The number of messages waiting in the mailbox.

Object Oriented Interface

public function getMailMessageCount();

Procedural Interface

ipworksedi_as1sender_get($res, 25 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

MailMessageDate Property (IPWorksEDI_AS1Sender Class)

The message date for the currently selected message.

Object Oriented Interface

public function getMailMessageDate();

Procedural Interface

ipworksedi_as1sender_get($res, 26 );

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

The sender of the mail message.

Object Oriented Interface

public function getMailMessageFrom();

Procedural Interface

ipworksedi_as1sender_get($res, 27 );

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

The message headers for the currently selected message.

Object Oriented Interface

public function getMailMessageHeaders();

Procedural Interface

ipworksedi_as1sender_get($res, 28 );

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

The message number on the incoming mail server.

Object Oriented Interface

public function getMailMessageNumber();
public function setMailMessageNumber($value);

Procedural Interface

ipworksedi_as1sender_get($res, 29 );
ipworksedi_as1sender_set($res, 29, $value );

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

The value of the ReplyTo header of the mail message.

Object Oriented Interface

public function getMailMessageReplyTo();

Procedural Interface

ipworksedi_as1sender_get($res, 30 );

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

The subject of the mail message.

Object Oriented Interface

public function getMailMessageSubject();

Procedural Interface

ipworksedi_as1sender_get($res, 31 );

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

The text of the mail message.

Object Oriented Interface

public function getMailMessageText();

Procedural Interface

ipworksedi_as1sender_get($res, 32 );

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

The recipient of the mail message.

Object Oriented Interface

public function getMailMessageTo();

Procedural Interface

ipworksedi_as1sender_get($res, 33 );

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

The address of your mail server.

Object Oriented Interface

public function getMailServer();
public function setMailServer($value);

Procedural Interface

ipworksedi_as1sender_get($res, 34 );
ipworksedi_as1sender_set($res, 34, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

MDNOptions Property (IPWorksEDI_AS1Sender Class)

Used to indicate the options requested for the MDN receipt.

Object Oriented Interface

public function getMDNOptions();
public function setMDNOptions($value);

Procedural Interface

ipworksedi_as1sender_get($res, 35 );
ipworksedi_as1sender_set($res, 35, $value );

Default Value

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

Remarks

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

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

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

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

Data Type

String

MDNReceiptContent Property (IPWorksEDI_AS1Sender Class)

This contains the entire content of the MDN Receipt.

Object Oriented Interface

public function getMDNReceiptContent();
public function setMDNReceiptContent($value);

Procedural Interface

ipworksedi_as1sender_get($res, 36 );
ipworksedi_as1sender_set($res, 36, $value );

Default Value

''

Remarks

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

Data Type

Binary String

MDNReceiptHeaderCount Property (IPWorksEDI_AS1Sender Class)

The number of headers in the MDN.

Object Oriented Interface

public function getMDNReceiptHeaderCount();

Procedural Interface

ipworksedi_as1sender_get($res, 37 );

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

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

Object Oriented Interface

public function getMDNReceiptHeaderField();

Procedural Interface

ipworksedi_as1sender_get($res, 38 );

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

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

Object Oriented Interface

public function getMDNReceiptHeaderIndex();
public function setMDNReceiptHeaderIndex($value);

Procedural Interface

ipworksedi_as1sender_get($res, 39 );
ipworksedi_as1sender_set($res, 39, $value );

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

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

Object Oriented Interface

public function getMDNReceiptHeaders();
public function setMDNReceiptHeaders($value);

Procedural Interface

ipworksedi_as1sender_get($res, 40 );
ipworksedi_as1sender_set($res, 40, $value );

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

The value of the MDN header currently selected by HeaderIndex .

Object Oriented Interface

public function getMDNReceiptHeaderValue();

Procedural Interface

ipworksedi_as1sender_get($res, 41 );

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

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

Object Oriented Interface

public function getMDNReceiptMDN();

Procedural Interface

ipworksedi_as1sender_get($res, 42 );

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

The human-readable portion of the MDN receipt.

Object Oriented Interface

public function getMDNReceiptMessage();

Procedural Interface

ipworksedi_as1sender_get($res, 43 );

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

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

Object Oriented Interface

public function getMDNReceiptMICValue();

Procedural Interface

ipworksedi_as1sender_get($res, 44 );

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

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

Object Oriented Interface

public function getMDNReceiptSigningProtocol();

Procedural Interface

ipworksedi_as1sender_get($res, 45 );

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

The system to which an MDN should be directed.

Object Oriented Interface

public function getMDNTo();
public function setMDNTo($value);

Procedural Interface

ipworksedi_as1sender_get($res, 46 );
ipworksedi_as1sender_set($res, 46, $value );

Default Value

''

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. This should be set to a valid email address, and would typically be the same as the From address.

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

Data Type

String

MessageId Property (IPWorksEDI_AS1Sender Class)

The Id of the message.

Object Oriented Interface

public function getMessageId();
public function setMessageId($value);

Procedural Interface

ipworksedi_as1sender_get($res, 47 );
ipworksedi_as1sender_set($res, 47, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

OriginalContentMIC Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getOriginalContentMIC();
public function setOriginalContentMIC($value);

Procedural Interface

ipworksedi_as1sender_get($res, 48 );
ipworksedi_as1sender_set($res, 48, $value );

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

The password for your incoming mail server.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 49 );
ipworksedi_as1sender_set($res, 49, $value );

Default Value

''

Remarks

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

Data Type

String

ReceiptSignerCertEffectiveDate Property (IPWorksEDI_AS1Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getReceiptSignerCertEffectiveDate();

Procedural Interface

ipworksedi_as1sender_get($res, 50 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getReceiptSignerCertExpirationDate();

Procedural Interface

ipworksedi_as1sender_get($res, 51 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getReceiptSignerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 52 );

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

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

Object Oriented Interface

public function getReceiptSignerCertFingerprint();

Procedural Interface

ipworksedi_as1sender_get($res, 53 );

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

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

Object Oriented Interface

public function getReceiptSignerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 54 );

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

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

Object Oriented Interface

public function getReceiptSignerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 55 );

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

The issuer of the certificate.

Object Oriented Interface

public function getReceiptSignerCertIssuer();

Procedural Interface

ipworksedi_as1sender_get($res, 56 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getReceiptSignerCertPrivateKey();

Procedural Interface

ipworksedi_as1sender_get($res, 57 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getReceiptSignerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1sender_get($res, 58 );

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

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

Object Oriented Interface

public function getReceiptSignerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1sender_get($res, 59 );

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

The public key of the certificate.

Object Oriented Interface

public function getReceiptSignerCertPublicKey();

Procedural Interface

ipworksedi_as1sender_get($res, 60 );

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

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

Object Oriented Interface

public function getReceiptSignerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 61 );

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

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

Object Oriented Interface

public function getReceiptSignerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1sender_get($res, 62 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getReceiptSignerCertSerialNumber();

Procedural Interface

ipworksedi_as1sender_get($res, 63 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getReceiptSignerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 64 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getReceiptSignerCertStore();
public function setReceiptSignerCertStore($value);

Procedural Interface

ipworksedi_as1sender_get($res, 65 );
ipworksedi_as1sender_set($res, 65, $value );

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

Binary String

ReceiptSignerCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getReceiptSignerCertStorePassword();
public function setReceiptSignerCertStorePassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 66 );
ipworksedi_as1sender_set($res, 66, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getReceiptSignerCertStoreType();
public function setReceiptSignerCertStoreType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 67 );
ipworksedi_as1sender_set($res, 67, $value );

Possible Values

AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_USER(0), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_MACHINE(1), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_PKCS11(23), 
AS1SENDER_RECEIPTSIGNERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

ReceiptSignerCertSubjectAltNames Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getReceiptSignerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1sender_get($res, 68 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ReceiptSignerCertThumbprintMD5 Property (IPWorksEDI_AS1Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getReceiptSignerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1sender_get($res, 69 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getReceiptSignerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 70 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getReceiptSignerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 71 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getReceiptSignerCertUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 72 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getReceiptSignerCertUsageFlags();

Procedural Interface

ipworksedi_as1sender_get($res, 73 );

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

The certificate's version number.

Object Oriented Interface

public function getReceiptSignerCertVersion();

Procedural Interface

ipworksedi_as1sender_get($res, 74 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getReceiptSignerCertSubject();
public function setReceiptSignerCertSubject($value);

Procedural Interface

ipworksedi_as1sender_get($res, 75 );
ipworksedi_as1sender_set($res, 75, $value );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getReceiptSignerCertEncoded();
public function setReceiptSignerCertEncoded($value);

Procedural Interface

ipworksedi_as1sender_get($res, 76 );
ipworksedi_as1sender_set($res, 76, $value );

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

Binary String

RecipientCertCount Property (IPWorksEDI_AS1Sender Class)

The number of records in the RecipientCert arrays.

Object Oriented Interface

public function getRecipientCertCount();
public function setRecipientCertCount($value);

Procedural Interface

ipworksedi_as1sender_get($res, 77 );
ipworksedi_as1sender_set($res, 77, $value );

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getRecipientCertEffectiveDate($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 78 , $recipientcertindex);

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

The date on which the certificate expires.

Object Oriented Interface

public function getRecipientCertExpirationDate($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 79 , $recipientcertindex);

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getRecipientCertExtendedKeyUsage($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 80 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertFingerprint($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 81 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertFingerprintSHA1($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 82 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertFingerprintSHA256($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 83 , $recipientcertindex);

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

The issuer of the certificate.

Object Oriented Interface

public function getRecipientCertIssuer($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 84 , $recipientcertindex);

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

The private key of the certificate (if available).

Object Oriented Interface

public function getRecipientCertPrivateKey($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 85 , $recipientcertindex);

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getRecipientCertPrivateKeyAvailable($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 86 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertPrivateKeyContainer($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 87 , $recipientcertindex);

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

The public key of the certificate.

Object Oriented Interface

public function getRecipientCertPublicKey($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 88 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertPublicKeyAlgorithm($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 89 , $recipientcertindex);

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

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

Object Oriented Interface

public function getRecipientCertPublicKeyLength($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 90 , $recipientcertindex);

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getRecipientCertSerialNumber($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 91 , $recipientcertindex);

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getRecipientCertSignatureAlgorithm($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 92 , $recipientcertindex);

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getRecipientCertStore($recipientcertindex);
public function setRecipientCertStore($recipientcertindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 93 , $recipientcertindex);
ipworksedi_as1sender_set($res, 93, $value , $recipientcertindex);

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

Binary String

RecipientCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getRecipientCertStorePassword($recipientcertindex);
public function setRecipientCertStorePassword($recipientcertindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 94 , $recipientcertindex);
ipworksedi_as1sender_set($res, 94, $value , $recipientcertindex);

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getRecipientCertStoreType($recipientcertindex);
public function setRecipientCertStoreType($recipientcertindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 95 , $recipientcertindex);
ipworksedi_as1sender_set($res, 95, $value , $recipientcertindex);

Possible Values

AS1SENDER_RECIPIENTCERTSTORETYPE_USER(0), 
AS1SENDER_RECIPIENTCERTSTORETYPE_MACHINE(1), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_RECIPIENTCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_RECIPIENTCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_RECIPIENTCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_RECIPIENTCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_RECIPIENTCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_RECIPIENTCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_RECIPIENTCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_RECIPIENTCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_RECIPIENTCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_RECIPIENTCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_RECIPIENTCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_RECIPIENTCERTSTORETYPE_PKCS11(23), 
AS1SENDER_RECIPIENTCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

The $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 (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getRecipientCertSubjectAltNames($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 96 , $recipientcertindex);

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

The MD5 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintMD5($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 97 , $recipientcertindex);

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA1($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 98 , $recipientcertindex);

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getRecipientCertThumbprintSHA256($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 99 , $recipientcertindex);

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

The text description of UsageFlags .

Object Oriented Interface

public function getRecipientCertUsage($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 100 , $recipientcertindex);

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getRecipientCertUsageFlags($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 101 , $recipientcertindex);

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

The certificate's version number.

Object Oriented Interface

public function getRecipientCertVersion($recipientcertindex);

Procedural Interface

ipworksedi_as1sender_get($res, 102 , $recipientcertindex);

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getRecipientCertSubject($recipientcertindex);
public function setRecipientCertSubject($recipientcertindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 103 , $recipientcertindex);
ipworksedi_as1sender_set($res, 103, $value , $recipientcertindex);

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getRecipientCertEncoded($recipientcertindex);
public function setRecipientCertEncoded($recipientcertindex, $value);

Procedural Interface

ipworksedi_as1sender_get($res, 104 , $recipientcertindex);
ipworksedi_as1sender_set($res, 104, $value , $recipientcertindex);

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

Binary String

SendTo Property (IPWorksEDI_AS1Sender Class)

The recipient of the message.

Object Oriented Interface

public function getSendTo();
public function setSendTo($value);

Procedural Interface

ipworksedi_as1sender_get($res, 105 );
ipworksedi_as1sender_set($res, 105, $value );

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

Signature algorithm to be used in outgoing messages.

Object Oriented Interface

public function getSignatureAlgorithm();
public function setSignatureAlgorithm($value);

Procedural Interface

ipworksedi_as1sender_get($res, 106 );
ipworksedi_as1sender_set($res, 106, $value );

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSigningCertEffectiveDate();

Procedural Interface

ipworksedi_as1sender_get($res, 107 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSigningCertExpirationDate();

Procedural Interface

ipworksedi_as1sender_get($res, 108 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSigningCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 109 );

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

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

ipworksedi_as1sender_get($res, 110 );

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

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

Object Oriented Interface

public function getSigningCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 111 );

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

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

Object Oriented Interface

public function getSigningCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 112 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

ipworksedi_as1sender_get($res, 113 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSigningCertPrivateKey();

Procedural Interface

ipworksedi_as1sender_get($res, 114 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSigningCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1sender_get($res, 115 );

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

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

Object Oriented Interface

public function getSigningCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1sender_get($res, 116 );

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

The public key of the certificate.

Object Oriented Interface

public function getSigningCertPublicKey();

Procedural Interface

ipworksedi_as1sender_get($res, 117 );

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

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

Object Oriented Interface

public function getSigningCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 118 );

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

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

Object Oriented Interface

public function getSigningCertPublicKeyLength();

Procedural Interface

ipworksedi_as1sender_get($res, 119 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

ipworksedi_as1sender_get($res, 120 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSigningCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 121 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSigningCertStore();
public function setSigningCertStore($value);

Procedural Interface

ipworksedi_as1sender_get($res, 122 );
ipworksedi_as1sender_set($res, 122, $value );

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

Binary String

SigningCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSigningCertStorePassword();
public function setSigningCertStorePassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 123 );
ipworksedi_as1sender_set($res, 123, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSigningCertStoreType();
public function setSigningCertStoreType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 124 );
ipworksedi_as1sender_set($res, 124, $value );

Possible Values

AS1SENDER_SIGNINGCERTSTORETYPE_USER(0), 
AS1SENDER_SIGNINGCERTSTORETYPE_MACHINE(1), 
AS1SENDER_SIGNINGCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_SIGNINGCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_SIGNINGCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_SIGNINGCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_SIGNINGCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_SIGNINGCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_SIGNINGCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_SIGNINGCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_SIGNINGCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_SIGNINGCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_SIGNINGCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_SIGNINGCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_SIGNINGCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_SIGNINGCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_SIGNINGCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_SIGNINGCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_SIGNINGCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_SIGNINGCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_SIGNINGCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_SIGNINGCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_SIGNINGCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_SIGNINGCERTSTORETYPE_PKCS11(23), 
AS1SENDER_SIGNINGCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SigningCertSubjectAltNames Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSigningCertSubjectAltNames();

Procedural Interface

ipworksedi_as1sender_get($res, 125 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SigningCertThumbprintMD5 Property (IPWorksEDI_AS1Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSigningCertThumbprintMD5();

Procedural Interface

ipworksedi_as1sender_get($res, 126 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSigningCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 127 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSigningCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 128 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSigningCertUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 129 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSigningCertUsageFlags();

Procedural Interface

ipworksedi_as1sender_get($res, 130 );

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

The certificate's version number.

Object Oriented Interface

public function getSigningCertVersion();

Procedural Interface

ipworksedi_as1sender_get($res, 131 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSigningCertSubject();
public function setSigningCertSubject($value);

Procedural Interface

ipworksedi_as1sender_get($res, 132 );
ipworksedi_as1sender_set($res, 132, $value );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSigningCertEncoded();
public function setSigningCertEncoded($value);

Procedural Interface

ipworksedi_as1sender_get($res, 133 );
ipworksedi_as1sender_set($res, 133, $value );

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

Binary String

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_AS1Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_as1sender_get($res, 134 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_as1sender_get($res, 135 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 136 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_as1sender_get($res, 137 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 138 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 139 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_as1sender_get($res, 140 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_as1sender_get($res, 141 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1sender_get($res, 142 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1sender_get($res, 143 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_as1sender_get($res, 144 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 145 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1sender_get($res, 146 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_as1sender_get($res, 147 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 148 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksedi_as1sender_get($res, 149 );
ipworksedi_as1sender_set($res, 149, $value );

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

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 150 );
ipworksedi_as1sender_set($res, 150, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 151 );
ipworksedi_as1sender_set($res, 151, $value );

Possible Values

AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
AS1SENDER_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1sender_get($res, 152 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_AS1Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1sender_get($res, 153 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 154 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 155 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 156 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_as1sender_get($res, 157 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_as1sender_get($res, 158 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksedi_as1sender_get($res, 159 );
ipworksedi_as1sender_set($res, 159, $value );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_as1sender_get($res, 160 );
ipworksedi_as1sender_set($res, 160, $value );

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

Binary String

SSLCertEffectiveDate Property (IPWorksEDI_AS1Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_as1sender_get($res, 161 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_as1sender_get($res, 162 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 163 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_as1sender_get($res, 164 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 165 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 166 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_as1sender_get($res, 167 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_as1sender_get($res, 168 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1sender_get($res, 169 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1sender_get($res, 170 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_as1sender_get($res, 171 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 172 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_as1sender_get($res, 173 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_as1sender_get($res, 174 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 175 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksedi_as1sender_get($res, 176 );
ipworksedi_as1sender_set($res, 176, $value );

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

Binary String

SSLCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksedi_as1sender_get($res, 177 );
ipworksedi_as1sender_set($res, 177, $value );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_as1sender_get($res, 178 );
ipworksedi_as1sender_set($res, 178, $value );

Possible Values

AS1SENDER_SSLCERTSTORETYPE_USER(0), 
AS1SENDER_SSLCERTSTORETYPE_MACHINE(1), 
AS1SENDER_SSLCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_SSLCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_SSLCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_SSLCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_SSLCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_SSLCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_SSLCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_SSLCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_SSLCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_SSLCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_SSLCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_SSLCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_SSLCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_SSLCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_SSLCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_SSLCERTSTORETYPE_PKCS11(23), 
AS1SENDER_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_as1sender_get($res, 179 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_AS1Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_as1sender_get($res, 180 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 181 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 182 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 183 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_as1sender_get($res, 184 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_as1sender_get($res, 185 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_as1sender_get($res, 186 );
ipworksedi_as1sender_set($res, 186, $value );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_as1sender_get($res, 187 );
ipworksedi_as1sender_set($res, 187, $value );

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

Binary String

SSLProvider Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksedi_as1sender_get($res, 188 );
ipworksedi_as1sender_set($res, 188, $value );

Possible Values

AS1SENDER_SSLPROVIDER_AUTOMATIC(0), 
AS1SENDER_SSLPROVIDER_PLATFORM(1), 
AS1SENDER_SSLPROVIDER_INTERNAL(2)

Default Value

0

Remarks

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

Possible values are as follows:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorksEDI_AS1Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksedi_as1sender_get($res, 189 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksedi_as1sender_get($res, 190 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 191 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksedi_as1sender_get($res, 192 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 193 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 194 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksedi_as1sender_get($res, 195 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksedi_as1sender_get($res, 196 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1sender_get($res, 197 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1sender_get($res, 198 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksedi_as1sender_get($res, 199 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 200 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1sender_get($res, 201 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksedi_as1sender_get($res, 202 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1sender_get($res, 203 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksedi_as1sender_get($res, 204 );

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

Binary String

SSLServerCertStorePassword Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksedi_as1sender_get($res, 205 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksedi_as1sender_get($res, 206 );

Possible Values

AS1SENDER_SSLSERVERCERTSTORETYPE_USER(0), 
AS1SENDER_SSLSERVERCERTSTORETYPE_MACHINE(1), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
AS1SENDER_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
AS1SENDER_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1SENDER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1SENDER_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
AS1SENDER_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
AS1SENDER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
AS1SENDER_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
AS1SENDER_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
AS1SENDER_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
AS1SENDER_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
AS1SENDER_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
AS1SENDER_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
AS1SENDER_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
AS1SENDER_SSLSERVERCERTSTORETYPE_PKCS11(23), 
AS1SENDER_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1sender_get($res, 207 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksEDI_AS1Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1sender_get($res, 208 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1sender_get($res, 209 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1sender_get($res, 210 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksedi_as1sender_get($res, 211 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksedi_as1sender_get($res, 212 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksedi_as1sender_get($res, 213 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksedi_as1sender_get($res, 214 );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_as1sender_get($res, 215 );

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

Binary String

SSLStartMode Property (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function getSSLStartMode();
public function setSSLStartMode($value);

Procedural Interface

ipworksedi_as1sender_get($res, 216 );
ipworksedi_as1sender_set($res, 216, $value );

Possible Values

AS1SENDER_SSLSTARTMODE_AUTOMATIC(0), 
AS1SENDER_SSLSTARTMODE_IMPLICIT(1), 
AS1SENDER_SSLSTARTMODE_EXPLICIT(2), 
AS1SENDER_SSLSTARTMODE_NONE(3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Subject Property (IPWorksEDI_AS1Sender Class)

The subject of the message.

Object Oriented Interface

public function getSubject();
public function setSubject($value);

Procedural Interface

ipworksedi_as1sender_get($res, 217 );
ipworksedi_as1sender_set($res, 217, $value );

Default Value

'AS1 Message'

Remarks

The human-readable subject of the outgoing message.

Data Type

String

User Property (IPWorksEDI_AS1Sender Class)

The username for your incoming mail server.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksedi_as1sender_get($res, 218 );
ipworksedi_as1sender_set($res, 218, $value );

Default Value

''

Remarks

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

Data Type

String

Config Method (IPWorksEDI_AS1Sender Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_as1sender_do_config($res, $configurationstring);

Remarks

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

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

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

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

Connect Method (IPWorksEDI_AS1Sender Class)

Connects to the incoming mail server.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_as1sender_do_connect($res);

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

Deletes the message specified by MailMessageNumber .

Object Oriented Interface

public function doDeleteMessage();

Procedural Interface

ipworksedi_as1sender_do_deletemessage($res);

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

Disconnects from the incoming mail server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_as1sender_do_disconnect($res);

Remarks

Disconnects from the incoming mail server specified by MailServer.

ProcessQueue Method (IPWorksEDI_AS1Sender Class)

Send the messages queued for sending.

Object Oriented Interface

public function doProcessQueue($directory);

Procedural Interface

ipworksedi_as1sender_do_processqueue($res, $directory);

Remarks

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

QueryMessageSize Method (IPWorksEDI_AS1Sender Class)

Returns the size in bytes of the current message.

Object Oriented Interface

public function doQueryMessageSize();

Procedural Interface

ipworksedi_as1sender_do_querymessagesize($res);

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

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

Object Oriented Interface

public function doQueryMessageUID();

Procedural Interface

ipworksedi_as1sender_do_querymessageuid($res);

Remarks

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

Queue Method (IPWorksEDI_AS1Sender Class)

Prepares and queues the message to the specified directory.

Object Oriented Interface

public function doQueue($directory);

Procedural Interface

ipworksedi_as1sender_do_queue($res, $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 (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function doReadReceipt();

Procedural Interface

ipworksedi_as1sender_do_readreceipt($res);

Remarks

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

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

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

Finally, VerifyReceipt should be used to verify the receipt.

Reset Method (IPWorksEDI_AS1Sender Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_as1sender_do_reset($res);

Remarks

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

SelectMailMessage Method (IPWorksEDI_AS1Sender Class)

Selects and obtains information about the specified message.

Object Oriented Interface

public function doSelectMailMessage();

Procedural Interface

ipworksedi_as1sender_do_selectmailmessage($res);

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

Prepares and sends the AS1 message.

Object Oriented Interface

public function doSend();

Procedural Interface

ipworksedi_as1sender_do_send($res);

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

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

Object Oriented Interface

public function doSetRequestHeader($headername, $headervalue);

Procedural Interface

ipworksedi_as1sender_do_setrequestheader($res, $headername, $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 (IPWorksEDI_AS1Sender Class)

Verifies an MDN receipt.

Object Oriented Interface

public function doVerifyReceipt();

Procedural Interface

ipworksedi_as1sender_do_verifyreceipt($res);

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

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 1, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (IPWorksEDI_AS1Sender Class)

Fired when the message text completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

Remarks

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

Error Event (IPWorksEDI_AS1Sender Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Header Event (IPWorksEDI_AS1Sender Class)

This event is fired for every message header being retrieved.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 4, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Fired with log information while processing a message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'logtype'
 'logmessage'

Remarks

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

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

The LogMessage event parameter holds the raw log data.

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

PITrail Event (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 6, array($this, 'firePITrail'));

Parameter List

 'direction'
 'message'

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 7, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 8, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 9, array($this, 'fireStartTransfer'));

Parameter List

Remarks

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

Transfer Event (IPWorksEDI_AS1Sender Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_as1sender_register_callback($res, 10, array($this, 'fireTransfer'));

Parameter List

 'bytestransferred'

Remarks

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

Config Settings (AS1Sender Class)

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

AS1 Config Settings

SSL Config Settings

Base Config Settings

Trappable Errors (AS1Sender Class)

AS1Sender Errors

POP Errors

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

TCPClient Errors

TCP/IP Errors

SMTP Errors

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

TCPClient Errors

TCP/IP Errors

SMIME Errors