AS1Receiver Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_AS1Receiver

Procedural Interface

 ipworksedi_as1receiver_open();
 ipworksedi_as1receiver_close($res);
 ipworksedi_as1receiver_register_callback($res, $id, $function);
 ipworksedi_as1receiver_get_last_error($res);
 ipworksedi_as1receiver_get_last_error_code($res);
 ipworksedi_as1receiver_set($res, $id, $index, $value);
 ipworksedi_as1receiver_get($res, $id, $index);
 ipworksedi_as1receiver_do_config($res, $configurationstring);
 ipworksedi_as1receiver_do_connect($res);
 ipworksedi_as1receiver_do_createmdnreceipt($res, $headers, $mdn, $message);
 ipworksedi_as1receiver_do_deletemessage($res);
 ipworksedi_as1receiver_do_disconnect($res);
 ipworksedi_as1receiver_do_parserequest($res);
 ipworksedi_as1receiver_do_processqueue($res, $directory);
 ipworksedi_as1receiver_do_processrequest($res);
 ipworksedi_as1receiver_do_querymessagesize($res);
 ipworksedi_as1receiver_do_querymessageuid($res);
 ipworksedi_as1receiver_do_queue($res, $directory);
 ipworksedi_as1receiver_do_readrequest($res);
 ipworksedi_as1receiver_do_reset($res);
 ipworksedi_as1receiver_do_selectmailmessage($res);
 ipworksedi_as1receiver_do_sendresponse($res);

Remarks

The AS1Receiver class allows you to receive AS1 messages as specified in RFC 3335. The class can act as an email client, decrypt and verify incoming messages, generate receipts including Message Disposition Notifications (MDNs), and send them over SMTP/S.

Basic Operation

You should first log in to your mail server by setting MailServer, User, and Password, and invoking Connect. You may then navigate your mail inbox by setting MailMessageNumber, and inspecting properties such as MailMessageFrom, etc. When you find the desired file you may download it by invoking ReadRequest. Alternatively, you may acquire the AS1 data by other means and directly set Request and RequestHeaders.

ReadRequest (or ParseHeaders) will determine information such as From and SendTo, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned over SMTP/S by invoking SendResponse. In case the server address for incoming mail is different than that for outgoing mail you should use Config to configure this.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

Example AS1Receiver1.User = "myusername" AS1Receiver1.Password = "mypassword" AS1Receiver1.MailServer = "1.2.3.4" AS1Receiver1.Connect() // You may need to search the server for received files at this point AS1Receiver1.MessageNumber = 1; // You may check properties such as MailMessageFrom, etc. AS1Receiver1.ReadRequest() AS1Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS1Receiver1.SignerCert = (base 64 encoded certificate); AS1Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS1Receiver1.ProcessRequest(); AS1Receiver1.SendResponse(); AS1Receiver1.Disconnect(); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

Property List

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

Method List

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

Event List

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

Config Settings

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

AttachmentCount Property (IPWorksEDI_AS1Receiver Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();

Procedural Interface

ipworksedi_as1receiver_get($res, 1 );

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 read-only and not available at design time.

Data Type

Integer

AttachmentContentType Property (IPWorksEDI_AS1Receiver Class)

The MIME content-type of this ediattachment .

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);

Procedural Interface

ipworksedi_as1receiver_get($res, 2 , $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 read-only and not available at design time.

Data Type

String

AttachmentData Property (IPWorksEDI_AS1Receiver Class)

This property contains the attachment data.

Object Oriented Interface

public function getAttachmentData($attachmentindex);

Procedural Interface

ipworksedi_as1receiver_get($res, 3 , $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 read-only and not available at design time.

Data Type

Binary String

AttachmentFileName Property (IPWorksEDI_AS1Receiver Class)

The file name of the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);

Procedural Interface

ipworksedi_as1receiver_get($res, 4 , $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 read-only and not available at design time.

Data Type

String

AttachmentHeaders Property (IPWorksEDI_AS1Receiver 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);

Procedural Interface

ipworksedi_as1receiver_get($res, 5 , $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 read-only and not available at design time.

Data Type

String

AttachmentName Property (IPWorksEDI_AS1Receiver 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);

Procedural Interface

ipworksedi_as1receiver_get($res, 6 , $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 read-only and not available at design time.

Data Type

String

CertEffectiveDate Property (IPWorksEDI_AS1Receiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getCertEffectiveDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 7 );

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

CertExpirationDate Property (IPWorksEDI_AS1Receiver Class)

The date on which the certificate expires.

Object Oriented Interface

public function getCertExpirationDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 8 );

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

CertExtendedKeyUsage Property (IPWorksEDI_AS1Receiver Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 9 );

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

CertFingerprint Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertFingerprint();

Procedural Interface

ipworksedi_as1receiver_get($res, 10 );

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

CertFingerprintSHA1 Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 11 );

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

CertFingerprintSHA256 Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 12 );

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

CertIssuer Property (IPWorksEDI_AS1Receiver Class)

The issuer of the certificate.

Object Oriented Interface

public function getCertIssuer();

Procedural Interface

ipworksedi_as1receiver_get($res, 13 );

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

CertPrivateKey Property (IPWorksEDI_AS1Receiver Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getCertPrivateKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 14 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (IPWorksEDI_AS1Receiver Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1receiver_get($res, 15 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1receiver_get($res, 16 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CertPublicKey Property (IPWorksEDI_AS1Receiver Class)

The public key of the certificate.

Object Oriented Interface

public function getCertPublicKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 17 );

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

CertPublicKeyAlgorithm Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 18 );

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

CertPublicKeyLength Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertPublicKeyLength();

Procedural Interface

ipworksedi_as1receiver_get($res, 19 );

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

CertSerialNumber Property (IPWorksEDI_AS1Receiver Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getCertSerialNumber();

Procedural Interface

ipworksedi_as1receiver_get($res, 20 );

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

CertSignatureAlgorithm Property (IPWorksEDI_AS1Receiver Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 21 );

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

CertStore Property (IPWorksEDI_AS1Receiver Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getCertStore();
public function setCertStore($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 22 );
ipworksedi_as1receiver_set($res, 22, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject 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

CertStorePassword Property (IPWorksEDI_AS1Receiver 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 getCertStorePassword();
public function setCertStorePassword($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 23 );
ipworksedi_as1receiver_set($res, 23, $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

CertStoreType Property (IPWorksEDI_AS1Receiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();
public function setCertStoreType($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 24 );
ipworksedi_as1receiver_set($res, 24, $value );

Possible Values

AS1RECEIVER_CERTSTORETYPE_USER(0), 
AS1RECEIVER_CERTSTORETYPE_MACHINE(1), 
AS1RECEIVER_CERTSTORETYPE_PFXFILE(2), 
AS1RECEIVER_CERTSTORETYPE_PFXBLOB(3), 
AS1RECEIVER_CERTSTORETYPE_JKSFILE(4), 
AS1RECEIVER_CERTSTORETYPE_JKSBLOB(5), 
AS1RECEIVER_CERTSTORETYPE_PEMKEY_FILE(6), 
AS1RECEIVER_CERTSTORETYPE_PEMKEY_BLOB(7), 
AS1RECEIVER_CERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1RECEIVER_CERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1RECEIVER_CERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1RECEIVER_CERTSTORETYPE_P7BFILE(11), 
AS1RECEIVER_CERTSTORETYPE_P7BBLOB(12), 
AS1RECEIVER_CERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1RECEIVER_CERTSTORETYPE_PPKFILE(14), 
AS1RECEIVER_CERTSTORETYPE_PPKBLOB(15), 
AS1RECEIVER_CERTSTORETYPE_XMLFILE(16), 
AS1RECEIVER_CERTSTORETYPE_XMLBLOB(17), 
AS1RECEIVER_CERTSTORETYPE_JWKFILE(18), 
AS1RECEIVER_CERTSTORETYPE_JWKBLOB(19), 
AS1RECEIVER_CERTSTORETYPE_SECURITY_KEY(20), 
AS1RECEIVER_CERTSTORETYPE_BCFKSFILE(21), 
AS1RECEIVER_CERTSTORETYPE_BCFKSBLOB(22), 
AS1RECEIVER_CERTSTORETYPE_PKCS11(23), 
AS1RECEIVER_CERTSTORETYPE_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

CertSubjectAltNames Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getCertSubjectAltNames();

Procedural Interface

ipworksedi_as1receiver_get($res, 25 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (IPWorksEDI_AS1Receiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintMD5();

Procedural Interface

ipworksedi_as1receiver_get($res, 26 );

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

CertThumbprintSHA1 Property (IPWorksEDI_AS1Receiver Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 27 );

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

CertThumbprintSHA256 Property (IPWorksEDI_AS1Receiver Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 28 );

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

CertUsage Property (IPWorksEDI_AS1Receiver Class)

The text description of UsageFlags .

Object Oriented Interface

public function getCertUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 29 );

Default Value

''

Remarks

The text description of CertUsageFlags.

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

CertUsageFlags Property (IPWorksEDI_AS1Receiver Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getCertUsageFlags();

Procedural Interface

ipworksedi_as1receiver_get($res, 30 );

Default Value

0

Remarks

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

Please see the CertUsage property for a text representation of CertUsageFlags.

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

This property is read-only.

Data Type

Integer

CertVersion Property (IPWorksEDI_AS1Receiver Class)

The certificate's version number.

Object Oriented Interface

public function getCertVersion();

Procedural Interface

ipworksedi_as1receiver_get($res, 31 );

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

CertSubject Property (IPWorksEDI_AS1Receiver Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getCertSubject();
public function setCertSubject($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 32 );
ipworksedi_as1receiver_set($res, 32, $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

CertEncoded Property (IPWorksEDI_AS1Receiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getCertEncoded();
public function setCertEncoded($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 33 );
ipworksedi_as1receiver_set($res, 33, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

CompressionFormat Property (IPWorksEDI_AS1Receiver Class)

The compression format used on the incoming message.

Object Oriented Interface

public function getCompressionFormat();

Procedural Interface

ipworksedi_as1receiver_get($res, 34 );

Possible Values

AS1RECEIVER_COMPRESSIONFORMAT_NONE(0), 
AS1RECEIVER_COMPRESSIONFORMAT_ZLIB(1)

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

Connected Property (IPWorksEDI_AS1Receiver Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksedi_as1receiver_get($res, 35 );

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

This property contains the EDI payload of the transmission.

Object Oriented Interface

public function getEDIData();

Procedural Interface

ipworksedi_as1receiver_get($res, 36 );

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.

This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

Data Type

Binary String

EDIType Property (IPWorksEDI_AS1Receiver Class)

The Content-Type of the EDI message.

Object Oriented Interface

public function getEDIType();

Procedural Interface

ipworksedi_as1receiver_get($res, 37 );

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 read-only.

Data Type

String

EDIName Property (IPWorksEDI_AS1Receiver 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();

Procedural Interface

ipworksedi_as1receiver_get($res, 38 );

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 read-only.

Data Type

String

EDIFileName Property (IPWorksEDI_AS1Receiver 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();

Procedural Interface

ipworksedi_as1receiver_get($res, 39 );

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 read-only.

Data Type

String

FirewallAutoDetect Property (IPWorksEDI_AS1Receiver 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_as1receiver_get($res, 40 );
ipworksedi_as1receiver_set($res, 40, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksEDI_AS1Receiver Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 41 );
ipworksedi_as1receiver_set($res, 41, $value );

Possible Values

AS1RECEIVER_FIREWALLTYPE_NONE(0), 
AS1RECEIVER_FIREWALLTYPE_TUNNEL(1), 
AS1RECEIVER_FIREWALLTYPE_SOCKS4(2), 
AS1RECEIVER_FIREWALLTYPE_SOCKS5(3), 
AS1RECEIVER_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_AS1Receiver Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 42 );
ipworksedi_as1receiver_set($res, 42, $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_AS1Receiver 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_as1receiver_get($res, 43 );
ipworksedi_as1receiver_set($res, 43, $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_AS1Receiver Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 44 );
ipworksedi_as1receiver_set($res, 44, $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_AS1Receiver 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_as1receiver_get($res, 45 );
ipworksedi_as1receiver_set($res, 45, $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_AS1Receiver Class)

The sender of the original message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 46 );
ipworksedi_as1receiver_set($res, 46, $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_AS1Receiver 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_as1receiver_get($res, 47 );
ipworksedi_as1receiver_set($res, 47, $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_AS1Receiver Class)

The path to a directory for logging.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 48 );
ipworksedi_as1receiver_set($res, 48, $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_AS1Receiver Class)

The log file written.

Object Oriented Interface

public function getLogFile();

Procedural Interface

ipworksedi_as1receiver_get($res, 49 );

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

The value of the Cc header of the mail message.

Object Oriented Interface

public function getMailMessageCc();

Procedural Interface

ipworksedi_as1receiver_get($res, 50 );

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

The number of messages waiting in the mailbox.

Object Oriented Interface

public function getMailMessageCount();

Procedural Interface

ipworksedi_as1receiver_get($res, 51 );

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

The message date for the currently selected message.

Object Oriented Interface

public function getMailMessageDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 52 );

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

The sender of the mail message.

Object Oriented Interface

public function getMailMessageFrom();

Procedural Interface

ipworksedi_as1receiver_get($res, 53 );

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

The message headers for the currently selected message.

Object Oriented Interface

public function getMailMessageHeaders();

Procedural Interface

ipworksedi_as1receiver_get($res, 54 );

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

The message number on the incoming mail server.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 55 );
ipworksedi_as1receiver_set($res, 55, $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

This property is not available at design time.

Data Type

Integer

MailMessageReplyTo Property (IPWorksEDI_AS1Receiver Class)

The value of the ReplyTo header of the mail message.

Object Oriented Interface

public function getMailMessageReplyTo();

Procedural Interface

ipworksedi_as1receiver_get($res, 56 );

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

The subject of the mail message.

Object Oriented Interface

public function getMailMessageSubject();

Procedural Interface

ipworksedi_as1receiver_get($res, 57 );

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

The text of the mail message.

Object Oriented Interface

public function getMailMessageText();

Procedural Interface

ipworksedi_as1receiver_get($res, 58 );

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

The recipient of the mail message.

Object Oriented Interface

public function getMailMessageTo();

Procedural Interface

ipworksedi_as1receiver_get($res, 59 );

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

The address of your mail server.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 60 );
ipworksedi_as1receiver_set($res, 60, $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

MDNReceiptContent Property (IPWorksEDI_AS1Receiver Class)

This contains the entire content of the MDN Receipt.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 61 );
ipworksedi_as1receiver_set($res, 61, $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_AS1Receiver Class)

The number of headers in the MDN.

Object Oriented Interface

public function getMDNReceiptHeaderCount();

Procedural Interface

ipworksedi_as1receiver_get($res, 62 );

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

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

Object Oriented Interface

public function getMDNReceiptHeaderField();

Procedural Interface

ipworksedi_as1receiver_get($res, 63 );

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_AS1Receiver 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_as1receiver_get($res, 64 );
ipworksedi_as1receiver_set($res, 64, $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_AS1Receiver 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_as1receiver_get($res, 65 );
ipworksedi_as1receiver_set($res, 65, $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_AS1Receiver Class)

The value of the MDN header currently selected by HeaderIndex .

Object Oriented Interface

public function getMDNReceiptHeaderValue();

Procedural Interface

ipworksedi_as1receiver_get($res, 66 );

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_AS1Receiver 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_as1receiver_get($res, 67 );

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

The human-readable portion of the MDN receipt.

Object Oriented Interface

public function getMDNReceiptMessage();

Procedural Interface

ipworksedi_as1receiver_get($res, 68 );

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

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

Object Oriented Interface

public function getMDNReceiptMICValue();

Procedural Interface

ipworksedi_as1receiver_get($res, 69 );

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

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

Object Oriented Interface

public function getMDNReceiptSigningProtocol();

Procedural Interface

ipworksedi_as1receiver_get($res, 70 );

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

The recipient for the Message Disposition Notification (MDN).

Object Oriented Interface

public function getMDNTo();

Procedural Interface

ipworksedi_as1receiver_get($res, 71 );

Default Value

''

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.

According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.

This property is read-only.

Data Type

String

MessageId Property (IPWorksEDI_AS1Receiver Class)

The message ID of the incoming message.

Object Oriented Interface

public function getMessageId();

Procedural Interface

ipworksedi_as1receiver_get($res, 72 );

Default Value

''

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

Data Type

String

Password Property (IPWorksEDI_AS1Receiver Class)

The password for your incoming mail server.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 73 );
ipworksedi_as1receiver_set($res, 73, $value );

Default Value

''

Remarks

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

Data Type

String

Request Property (IPWorksEDI_AS1Receiver Class)

The AS1 request to be processed.

Object Oriented Interface

public function getRequest();
public function setRequest($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 74 );
ipworksedi_as1receiver_set($res, 74, $value );

Default Value

''

Remarks

You may specify the request manually, or you may load the request from the mail server by invoking ReadRequest.

The headers generally should be specified separately in RequestHeaders.

Data Type

Binary String

RequestHeaderCount Property (IPWorksEDI_AS1Receiver Class)

The number of records in the RequestHeader arrays.

Object Oriented Interface

public function getRequestHeaderCount();
public function setRequestHeaderCount($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 75 );
ipworksedi_as1receiver_set($res, 75, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

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

This property is not available at design time.

Data Type

Integer

RequestHeaderField Property (IPWorksEDI_AS1Receiver Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getRequestHeaderField($requestheaderindex);
public function setRequestHeaderField($requestheaderindex, $value);

Procedural Interface

ipworksedi_as1receiver_get($res, 76 , $requestheaderindex);
ipworksedi_as1receiver_set($res, 76, $value , $requestheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

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

This property is not available at design time.

Data Type

String

RequestHeaderValue Property (IPWorksEDI_AS1Receiver Class)

This property contains the header contents.

Object Oriented Interface

public function getRequestHeaderValue($requestheaderindex);
public function setRequestHeaderValue($requestheaderindex, $value);

Procedural Interface

ipworksedi_as1receiver_get($res, 77 , $requestheaderindex);
ipworksedi_as1receiver_set($res, 77, $value , $requestheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

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

This property is not available at design time.

Data Type

String

RequestHeadersString Property (IPWorksEDI_AS1Receiver Class)

The headers in the AS1 request.

Object Oriented Interface

public function getRequestHeadersString();
public function setRequestHeadersString($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 78 );
ipworksedi_as1receiver_set($res, 78, $value );

Default Value

''

Remarks

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

Data Type

String

ScanResult Property (IPWorksEDI_AS1Receiver Class)

The result of invoking ParseRequest .

Object Oriented Interface

public function getScanResult();

Procedural Interface

ipworksedi_as1receiver_get($res, 79 );

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

This property is read-only.

Data Type

Integer

SendTo Property (IPWorksEDI_AS1Receiver Class)

The recipient of the original message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 80 );
ipworksedi_as1receiver_set($res, 80, $value );

Default Value

''

Remarks

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

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

Data Type

String

SignerCertEffectiveDate Property (IPWorksEDI_AS1Receiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSignerCertEffectiveDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 81 );

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 and not available at design time.

Data Type

String

SignerCertExpirationDate Property (IPWorksEDI_AS1Receiver Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSignerCertExpirationDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 82 );

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 and not available at design time.

Data Type

String

SignerCertExtendedKeyUsage Property (IPWorksEDI_AS1Receiver Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSignerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 83 );

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 and not available at design time.

Data Type

String

SignerCertFingerprint Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertFingerprint();

Procedural Interface

ipworksedi_as1receiver_get($res, 84 );

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 and not available at design time.

Data Type

String

SignerCertFingerprintSHA1 Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 85 );

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 and not available at design time.

Data Type

String

SignerCertFingerprintSHA256 Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 86 );

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 and not available at design time.

Data Type

String

SignerCertIssuer Property (IPWorksEDI_AS1Receiver Class)

The issuer of the certificate.

Object Oriented Interface

public function getSignerCertIssuer();

Procedural Interface

ipworksedi_as1receiver_get($res, 87 );

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 and not available at design time.

Data Type

String

SignerCertPrivateKey Property (IPWorksEDI_AS1Receiver Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 88 );

Default Value

''

Remarks

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

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

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

Data Type

String

SignerCertPrivateKeyAvailable Property (IPWorksEDI_AS1Receiver Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSignerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1receiver_get($res, 89 );

Default Value

false

Remarks

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

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

Data Type

Boolean

SignerCertPrivateKeyContainer Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1receiver_get($res, 90 );

Default Value

''

Remarks

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

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

Data Type

String

SignerCertPublicKey Property (IPWorksEDI_AS1Receiver Class)

The public key of the certificate.

Object Oriented Interface

public function getSignerCertPublicKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 91 );

Default Value

''

Remarks

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

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

Data Type

String

SignerCertPublicKeyAlgorithm Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 92 );

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 and not available at design time.

Data Type

String

SignerCertPublicKeyLength Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1receiver_get($res, 93 );

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 and not available at design time.

Data Type

Integer

SignerCertSerialNumber Property (IPWorksEDI_AS1Receiver Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSignerCertSerialNumber();

Procedural Interface

ipworksedi_as1receiver_get($res, 94 );

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 and not available at design time.

Data Type

String

SignerCertSignatureAlgorithm Property (IPWorksEDI_AS1Receiver Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSignerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 95 );

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 and not available at design time.

Data Type

String

SignerCertStore Property (IPWorksEDI_AS1Receiver Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSignerCertStore();
public function setSignerCertStore($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 96 );
ipworksedi_as1receiver_set($res, 96, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject 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 not available at design time.

Data Type

Binary String

SignerCertStorePassword Property (IPWorksEDI_AS1Receiver 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 getSignerCertStorePassword();
public function setSignerCertStorePassword($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 97 );
ipworksedi_as1receiver_set($res, 97, $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.

This property is not available at design time.

Data Type

String

SignerCertStoreType Property (IPWorksEDI_AS1Receiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSignerCertStoreType();
public function setSignerCertStoreType($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 98 );
ipworksedi_as1receiver_set($res, 98, $value );

Possible Values

AS1RECEIVER_SIGNERCERTSTORETYPE_USER(0), 
AS1RECEIVER_SIGNERCERTSTORETYPE_MACHINE(1), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PFXFILE(2), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PFXBLOB(3), 
AS1RECEIVER_SIGNERCERTSTORETYPE_JKSFILE(4), 
AS1RECEIVER_SIGNERCERTSTORETYPE_JKSBLOB(5), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1RECEIVER_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1RECEIVER_SIGNERCERTSTORETYPE_P7BFILE(11), 
AS1RECEIVER_SIGNERCERTSTORETYPE_P7BBLOB(12), 
AS1RECEIVER_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PPKFILE(14), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PPKBLOB(15), 
AS1RECEIVER_SIGNERCERTSTORETYPE_XMLFILE(16), 
AS1RECEIVER_SIGNERCERTSTORETYPE_XMLBLOB(17), 
AS1RECEIVER_SIGNERCERTSTORETYPE_JWKFILE(18), 
AS1RECEIVER_SIGNERCERTSTORETYPE_JWKBLOB(19), 
AS1RECEIVER_SIGNERCERTSTORETYPE_SECURITY_KEY(20), 
AS1RECEIVER_SIGNERCERTSTORETYPE_BCFKSFILE(21), 
AS1RECEIVER_SIGNERCERTSTORETYPE_BCFKSBLOB(22), 
AS1RECEIVER_SIGNERCERTSTORETYPE_PKCS11(23), 
AS1RECEIVER_SIGNERCERTSTORETYPE_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 not available at design time.

Data Type

Integer

SignerCertSubjectAltNames Property (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function getSignerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1receiver_get($res, 99 );

Default Value

''

Remarks

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

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

Data Type

String

SignerCertThumbprintMD5 Property (IPWorksEDI_AS1Receiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1receiver_get($res, 100 );

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 and not available at design time.

Data Type

String

SignerCertThumbprintSHA1 Property (IPWorksEDI_AS1Receiver Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 101 );

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 and not available at design time.

Data Type

String

SignerCertThumbprintSHA256 Property (IPWorksEDI_AS1Receiver Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 102 );

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 and not available at design time.

Data Type

String

SignerCertUsage Property (IPWorksEDI_AS1Receiver Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSignerCertUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 103 );

Default Value

''

Remarks

The text description of SignerCertUsageFlags.

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 and not available at design time.

Data Type

String

SignerCertUsageFlags Property (IPWorksEDI_AS1Receiver Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSignerCertUsageFlags();

Procedural Interface

ipworksedi_as1receiver_get($res, 104 );

Default Value

0

Remarks

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

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

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

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

Data Type

Integer

SignerCertVersion Property (IPWorksEDI_AS1Receiver Class)

The certificate's version number.

Object Oriented Interface

public function getSignerCertVersion();

Procedural Interface

ipworksedi_as1receiver_get($res, 105 );

Default Value

''

Remarks

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

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

Data Type

String

SignerCertSubject Property (IPWorksEDI_AS1Receiver Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSignerCertSubject();
public function setSignerCertSubject($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 106 );
ipworksedi_as1receiver_set($res, 106, $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.

This property is not available at design time.

Data Type

String

SignerCertEncoded Property (IPWorksEDI_AS1Receiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded();
public function setSignerCertEncoded($value);

Procedural Interface

ipworksedi_as1receiver_get($res, 107 );
ipworksedi_as1receiver_set($res, 107, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_AS1Receiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 108 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 109 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 110 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_as1receiver_get($res, 111 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 112 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 113 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_as1receiver_get($res, 114 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 115 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1receiver_get($res, 116 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1receiver_get($res, 117 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 118 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 119 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1receiver_get($res, 120 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_as1receiver_get($res, 121 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 122 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 123 );
ipworksedi_as1receiver_set($res, 123, $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_AS1Receiver 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_as1receiver_get($res, 124 );
ipworksedi_as1receiver_set($res, 124, $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_AS1Receiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 125 );
ipworksedi_as1receiver_set($res, 125, $value );

Possible Values

AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
AS1RECEIVER_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
AS1RECEIVER_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_AS1Receiver Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1receiver_get($res, 126 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_AS1Receiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1receiver_get($res, 127 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 128 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 129 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 130 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_as1receiver_get($res, 131 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_as1receiver_get($res, 132 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 133 );
ipworksedi_as1receiver_set($res, 133, $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_AS1Receiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 134 );
ipworksedi_as1receiver_set($res, 134, $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_AS1Receiver Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 135 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 136 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 137 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_as1receiver_get($res, 138 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 139 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 140 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_as1receiver_get($res, 141 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 142 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1receiver_get($res, 143 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1receiver_get($res, 144 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 145 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 146 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_as1receiver_get($res, 147 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_as1receiver_get($res, 148 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 149 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 150 );
ipworksedi_as1receiver_set($res, 150, $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_AS1Receiver 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_as1receiver_get($res, 151 );
ipworksedi_as1receiver_set($res, 151, $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_AS1Receiver Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 152 );
ipworksedi_as1receiver_set($res, 152, $value );

Possible Values

AS1RECEIVER_SSLCERTSTORETYPE_USER(0), 
AS1RECEIVER_SSLCERTSTORETYPE_MACHINE(1), 
AS1RECEIVER_SSLCERTSTORETYPE_PFXFILE(2), 
AS1RECEIVER_SSLCERTSTORETYPE_PFXBLOB(3), 
AS1RECEIVER_SSLCERTSTORETYPE_JKSFILE(4), 
AS1RECEIVER_SSLCERTSTORETYPE_JKSBLOB(5), 
AS1RECEIVER_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
AS1RECEIVER_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1RECEIVER_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1RECEIVER_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1RECEIVER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1RECEIVER_SSLCERTSTORETYPE_P7BFILE(11), 
AS1RECEIVER_SSLCERTSTORETYPE_P7BBLOB(12), 
AS1RECEIVER_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1RECEIVER_SSLCERTSTORETYPE_PPKFILE(14), 
AS1RECEIVER_SSLCERTSTORETYPE_PPKBLOB(15), 
AS1RECEIVER_SSLCERTSTORETYPE_XMLFILE(16), 
AS1RECEIVER_SSLCERTSTORETYPE_XMLBLOB(17), 
AS1RECEIVER_SSLCERTSTORETYPE_JWKFILE(18), 
AS1RECEIVER_SSLCERTSTORETYPE_JWKBLOB(19), 
AS1RECEIVER_SSLCERTSTORETYPE_SECURITY_KEY(20), 
AS1RECEIVER_SSLCERTSTORETYPE_BCFKSFILE(21), 
AS1RECEIVER_SSLCERTSTORETYPE_BCFKSBLOB(22), 
AS1RECEIVER_SSLCERTSTORETYPE_PKCS11(23), 
AS1RECEIVER_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_AS1Receiver Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_as1receiver_get($res, 153 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_AS1Receiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_as1receiver_get($res, 154 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 155 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 156 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 157 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_as1receiver_get($res, 158 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_as1receiver_get($res, 159 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 160 );
ipworksedi_as1receiver_set($res, 160, $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_AS1Receiver Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 161 );
ipworksedi_as1receiver_set($res, 161, $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_AS1Receiver 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_as1receiver_get($res, 162 );
ipworksedi_as1receiver_set($res, 162, $value );

Possible Values

AS1RECEIVER_SSLPROVIDER_AUTOMATIC(0), 
AS1RECEIVER_SSLPROVIDER_PLATFORM(1), 
AS1RECEIVER_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:

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 163 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksedi_as1receiver_get($res, 164 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 165 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksedi_as1receiver_get($res, 166 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 167 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 168 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksedi_as1receiver_get($res, 169 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 170 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as1receiver_get($res, 171 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as1receiver_get($res, 172 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksedi_as1receiver_get($res, 173 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 174 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as1receiver_get($res, 175 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksedi_as1receiver_get($res, 176 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as1receiver_get($res, 177 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksedi_as1receiver_get($res, 178 );

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_AS1Receiver 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_as1receiver_get($res, 179 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksedi_as1receiver_get($res, 180 );

Possible Values

AS1RECEIVER_SSLSERVERCERTSTORETYPE_USER(0), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_MACHINE(1), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
AS1RECEIVER_SSLSERVERCERTSTORETYPE_PKCS11(23), 
AS1RECEIVER_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_AS1Receiver Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as1receiver_get($res, 181 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksEDI_AS1Receiver Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as1receiver_get($res, 182 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as1receiver_get($res, 183 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as1receiver_get($res, 184 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksedi_as1receiver_get($res, 185 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksedi_as1receiver_get($res, 186 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksedi_as1receiver_get($res, 187 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksedi_as1receiver_get($res, 188 );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_as1receiver_get($res, 189 );

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_AS1Receiver 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_as1receiver_get($res, 190 );
ipworksedi_as1receiver_set($res, 190, $value );

Possible Values

AS1RECEIVER_SSLSTARTMODE_AUTOMATIC(0), 
AS1RECEIVER_SSLSTARTMODE_IMPLICIT(1), 
AS1RECEIVER_SSLSTARTMODE_EXPLICIT(2), 
AS1RECEIVER_SSLSTARTMODE_NONE(3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

User Property (IPWorksEDI_AS1Receiver Class)

The username for your incoming mail server.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as1receiver_get($res, 191 );
ipworksedi_as1receiver_set($res, 191, $value );

Default Value

''

Remarks

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

Data Type

String

Config Method (IPWorksEDI_AS1Receiver Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Connects to the incoming mail server.

Object Oriented Interface

public function doConnect();

Procedural Interface

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

CreateMDNReceipt Method (IPWorksEDI_AS1Receiver Class)

Creates MDNReceipt .

Object Oriented Interface

public function doCreateMDNReceipt($headers, $mdn, $message);

Procedural Interface

ipworksedi_as1receiver_do_createmdnreceipt($res, $headers, $mdn, $message);

Remarks

CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.

This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the class generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

DeleteMessage Method (IPWorksEDI_AS1Receiver Class)

Deletes the message specified by MailMessageNumber .

Object Oriented Interface

public function doDeleteMessage();

Procedural Interface

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

Disconnects from the incoming mail server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_as1receiver_do_disconnect($res);

Remarks

Disconnects from the incoming mail server specified by MailServer.

ParseRequest Method (IPWorksEDI_AS1Receiver Class)

Parses the EDI message and determines the EDIData .

Object Oriented Interface

public function doParseRequest();

Procedural Interface

ipworksedi_as1receiver_do_parserequest($res);

Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.

If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.

The class may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.

Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.

ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

ProcessQueue Method (IPWorksEDI_AS1Receiver Class)

Send the messages queued for sending.

Object Oriented Interface

public function doProcessQueue($directory);

Procedural Interface

ipworksedi_as1receiver_do_processqueue($res, $directory);

Remarks

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

ProcessRequest Method (IPWorksEDI_AS1Receiver Class)

Processes the EDI data, and generates the receipt.

Object Oriented Interface

public function doProcessRequest();

Procedural Interface

ipworksedi_as1receiver_do_processrequest($res);

Remarks

Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.

The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.

The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.

The class will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

QueryMessageSize Method (IPWorksEDI_AS1Receiver Class)

Returns the size in bytes of the current message.

Object Oriented Interface

public function doQueryMessageSize();

Procedural Interface

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

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

Object Oriented Interface

public function doQueryMessageUID();

Procedural Interface

ipworksedi_as1receiver_do_querymessageuid($res);

Remarks

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

Queue Method (IPWorksEDI_AS1Receiver Class)

Prepares and queues the message to the specified directory.

Object Oriented Interface

public function doQueue($directory);

Procedural Interface

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

ReadRequest Method (IPWorksEDI_AS1Receiver Class)

Reads the AS1 request from the mail server.

Object Oriented Interface

public function doReadRequest();

Procedural Interface

ipworksedi_as1receiver_do_readrequest($res);

Remarks

In the Java edition, ReadRequest will retrieve the file specified by MailMessageNumber from the mail server. The request will be stored in Request and the headers in RequestHeaders. The headers will also be parsed as in ParseHeaders, and the appropriate values of From, SendTo, etc., will be populated. After looking up and setting your trading partner information (such as certificates) you may then call ProcessRequest.

Reset Method (IPWorksEDI_AS1Receiver Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_as1receiver_do_reset($res);

Remarks

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

SelectMailMessage Method (IPWorksEDI_AS1Receiver Class)

Selects and obtains information about the specified message.

Object Oriented Interface

public function doSelectMailMessage();

Procedural Interface

ipworksedi_as1receiver_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., allow you to determine if this message is an AS1 message. Additional properties are exposed via the Config method.

If this message is an AS1 transmission, you may use ReadRequest to read it. The Request and RequestHeaders properties will contain the request and request headers, and From will be populated with the originator of the request. You may then set trading partner information and invoke ProcessRequest to process the request.

SendResponse Method (IPWorksEDI_AS1Receiver Class)

Sends the MDN receipt.

Object Oriented Interface

public function doSendResponse();

Procedural Interface

ipworksedi_as1receiver_do_sendresponse($res);

Remarks

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

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

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

ConnectionStatus Event (IPWorksEDI_AS1Receiver Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksedi_as1receiver_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:

EndTransfer Event (IPWorksEDI_AS1Receiver Class)

Fired when the message text completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

This event is fired for every message header being retrieved.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

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

Fired with log information while processing a message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_as1receiver_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_AS1Receiver 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_as1receiver_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:

SignerCertInfo Event (IPWorksEDI_AS1Receiver Class)

This event is fired during verification of the signed message.

Object Oriented Interface

public function fireSignerCertInfo($param);

Procedural Interface

ipworksedi_as1receiver_register_callback($res, 7, array($this, 'fireSignerCertInfo'));

Parameter List

 'issuer'
 'serialnumber'
 'subjectkeyidentifier'
 'certencoded'

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

NOTE: When this value is present, the class will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

SSLServerAuthentication Event (IPWorksEDI_AS1Receiver Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_as1receiver_register_callback($res, 8, 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_AS1Receiver Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_as1receiver_register_callback($res, 9, 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_AS1Receiver Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_as1receiver_register_callback($res, 10, array($this, 'fireStartTransfer'));

Parameter List

Remarks

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

Transfer Event (IPWorksEDI_AS1Receiver Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_as1receiver_register_callback($res, 11, array($this, 'fireTransfer'));

Parameter List

 'bytestransferred'

Remarks

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

Config Settings (AS1Receiver Class)

AS1Receiver Config Settings

AS1 Config Settings

SSL Config Settings

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

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

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

Base Config Settings