AS2Sender Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_AS2Sender

Procedural Interface

 ipworksedi_as2sender_open();
 ipworksedi_as2sender_close($res);
 ipworksedi_as2sender_register_callback($res, $id, $function);
 ipworksedi_as2sender_get_last_error($res);
 ipworksedi_as2sender_get_last_error_code($res);
 ipworksedi_as2sender_set($res, $id, $index, $value);
 ipworksedi_as2sender_get($res, $id, $index);
 ipworksedi_as2sender_do_config($res, $configurationstring);
 ipworksedi_as2sender_do_doevents($res);
 ipworksedi_as2sender_do_interrupt($res);
 ipworksedi_as2sender_do_post($res);
 ipworksedi_as2sender_do_readasyncreceipt($res);
 ipworksedi_as2sender_do_reset($res);
 ipworksedi_as2sender_do_restart($res);
 ipworksedi_as2sender_do_sendcemrequest($res, $requestid);
 ipworksedi_as2sender_do_sendcemresponse($res, $requestid);
 ipworksedi_as2sender_do_setrequestheader($res, $headername, $headervalue);
 ipworksedi_as2sender_do_settpinfo($res, $profile);
 ipworksedi_as2sender_do_verifyreceipt($res);

Remarks

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

A typical AS2 transaction is as follows:

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

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

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

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

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

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

The message may also be compressed by setting CompressionFormat.

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

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

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

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

Validating Asynchronous MDNs

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AS2From Property (IPWorksEDI_AS2Sender Class)

The AS2 Identifier of the sending system.

Object Oriented Interface

public function getAS2From();
public function setAS2From($value);

Procedural Interface

ipworksedi_as2sender_get($res, 1 );
ipworksedi_as2sender_set($res, 1, $value );

Default Value

''

Remarks

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

Required.

Data Type

String

AS2To Property (IPWorksEDI_AS2Sender Class)

The AS2 Identifier of the receiving system.

Object Oriented Interface

public function getAS2To();
public function setAS2To($value);

Procedural Interface

ipworksedi_as2sender_get($res, 2 );
ipworksedi_as2sender_set($res, 2, $value );

Default Value

''

Remarks

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

Required.

Data Type

String

AS2Version Property (IPWorksEDI_AS2Sender Class)

The version of AS2 being used.

Object Oriented Interface

public function getAS2Version();

Procedural Interface

ipworksedi_as2sender_get($res, 3 );

Default Value

'1.2'

Remarks

The version of AS2 being used.

This property is read-only.

Data Type

String

AsyncMDNInfoDir Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getAsyncMDNInfoDir();
public function setAsyncMDNInfoDir($value);

Procedural Interface

ipworksedi_as2sender_get($res, 4 );
ipworksedi_as2sender_set($res, 4, $value );

Default Value

''

Remarks

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

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

Data Type

String

AttachmentCount Property (IPWorksEDI_AS2Sender Class)

The number of records in the Attachment arrays.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 5 );
ipworksedi_as2sender_set($res, 5, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentHeaders
• AttachmentName

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

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (IPWorksEDI_AS2Sender Class)

The MIME content-type of this ediattachment .

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 6 , $attachmentindex);
ipworksedi_as2sender_set($res, 6, $value , $attachmentindex);

Default Value

''

Remarks

The MIME content-type of this EDIAttachment.

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

This property is not available at design time.

Data Type

String

AttachmentData Property (IPWorksEDI_AS2Sender Class)

This property contains the attachment data.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 7 , $attachmentindex);
ipworksedi_as2sender_set($res, 7, $value , $attachmentindex);

Default Value

''

Remarks

This property contains the attachment data.

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

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

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (IPWorksEDI_AS2Sender Class)

The file name of the attachment.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 8 , $attachmentindex);
ipworksedi_as2sender_set($res, 8, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentHeaders Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 9 , $attachmentindex);
ipworksedi_as2sender_set($res, 9, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentName Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 10 , $attachmentindex);
ipworksedi_as2sender_set($res, 10, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

CEMCount Property (IPWorksEDI_AS2Sender Class)

The number of records in the CEM arrays.

Object Oriented Interface

public function getCEMCount();
public function setCEMCount($value);

Procedural Interface

ipworksedi_as2sender_get($res, 11 );
ipworksedi_as2sender_set($res, 11, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CEMAccepted Property (IPWorksEDI_AS2Sender Class)

Whether the CEM request is accepted.

Object Oriented Interface

public function getCEMAccepted($cemindex);
public function setCEMAccepted($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 12 , $cemindex);
ipworksedi_as2sender_set($res, 12, $value , $cemindex);

Default Value

false

Remarks

Whether the CEM request is accepted.

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

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

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

This property is not available at design time.

Data Type

Boolean

CEMCertId Property (IPWorksEDI_AS2Sender Class)

A user defined identifier for the certificate.

Object Oriented Interface

public function getCEMCertId($cemindex);
public function setCEMCertId($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 13 , $cemindex);
ipworksedi_as2sender_set($res, 13, $value , $cemindex);

Default Value

''

Remarks

A user defined identifier for the certificate.

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

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

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

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

This property is not available at design time.

Data Type

String

CEMCertIssuer Property (IPWorksEDI_AS2Sender Class)

This property holds the issuer of the certificate.

Object Oriented Interface

public function getCEMCertIssuer($cemindex);
public function setCEMCertIssuer($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 14 , $cemindex);
ipworksedi_as2sender_set($res, 14, $value , $cemindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

CEMCertSerialNumber Property (IPWorksEDI_AS2Sender Class)

This property holds the serial number of the certificate.

Object Oriented Interface

public function getCEMCertSerialNumber($cemindex);
public function setCEMCertSerialNumber($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 15 , $cemindex);
ipworksedi_as2sender_set($res, 15, $value , $cemindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

CEMCertStore Property (IPWorksEDI_AS2Sender Class)

The name of the certificate store for the certificate.

Object Oriented Interface

public function getCEMCertStore($cemindex);
public function setCEMCertStore($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 16 , $cemindex);
ipworksedi_as2sender_set($res, 16, $value , $cemindex);

Default Value

'MY'

Remarks

The name of the certificate store for the certificate.

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

Designations of certificate stores are platform dependent.

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

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

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

This property is not available at design time.

Data Type

Binary String

CEMCertStorePassword Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getCEMCertStorePassword($cemindex);
public function setCEMCertStorePassword($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 17 , $cemindex);
ipworksedi_as2sender_set($res, 17, $value , $cemindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

CEMCertStoreType Property (IPWorksEDI_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getCEMCertStoreType($cemindex);
public function setCEMCertStoreType($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 18 , $cemindex);
ipworksedi_as2sender_set($res, 18, $value , $cemindex);

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

This property is not available at design time.

Data Type

Integer

CEMCertSubject Property (IPWorksEDI_AS2Sender Class)

The subject of the certificate.

Object Oriented Interface

public function getCEMCertSubject($cemindex);
public function setCEMCertSubject($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 19 , $cemindex);
ipworksedi_as2sender_set($res, 19, $value , $cemindex);

Default Value

''

Remarks

The subject of the certificate.

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

CEMCertUsage Property (IPWorksEDI_AS2Sender Class)

This property defines which usages are applicable to the certificate.

Object Oriented Interface

public function getCEMCertUsage($cemindex);
public function setCEMCertUsage($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 20 , $cemindex);
ipworksedi_as2sender_set($res, 20, $value , $cemindex);

Default Value

15

Remarks

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

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

The default value is "15", meaning all usages are allowed.

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

This property is not available at design time.

Data Type

Integer

CEMRejectionReason Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getCEMRejectionReason($cemindex);
public function setCEMRejectionReason($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 21 , $cemindex);
ipworksedi_as2sender_set($res, 21, $value , $cemindex);

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CEMRespondByDate Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getCEMRespondByDate($cemindex);
public function setCEMRespondByDate($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 22 , $cemindex);
ipworksedi_as2sender_set($res, 22, $value , $cemindex);

Default Value

''

Remarks

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

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

When using AS2Sender set this before calling SendCEMRequest.

When using AS2Receiver this property may be queried.

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

This property is not available at design time.

Data Type

String

CEMResponseURL Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getCEMResponseURL($cemindex);
public function setCEMResponseURL($cemindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 23 , $cemindex);
ipworksedi_as2sender_set($res, 23, $value , $cemindex);

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

CompressionFormat Property (IPWorksEDI_AS2Sender Class)

The compression format (if any) to use.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 24 );
ipworksedi_as2sender_set($res, 24, $value );

Default Value

0

Remarks

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

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

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

Data Type

Integer

CookieCount Property (IPWorksEDI_AS2Sender Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworksedi_as2sender_get($res, 25 );
ipworksedi_as2sender_set($res, 25, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (IPWorksEDI_AS2Sender Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworksedi_as2sender_get($res, 26 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieExpiration Property (IPWorksEDI_AS2Sender Class)

An expiration time for the cookie (if provided by the server).

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworksedi_as2sender_get($res, 27 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieName Property (IPWorksEDI_AS2Sender Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 28 , $cookieindex);
ipworksedi_as2sender_set($res, 28, $value , $cookieindex);

Default Value

''

Remarks

The name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (IPWorksEDI_AS2Sender Class)

A path name to limit the cookie to (if provided by the server).

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworksedi_as2sender_get($res, 29 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieSecure Property (IPWorksEDI_AS2Sender Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworksedi_as2sender_get($res, 30 , $cookieindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (IPWorksEDI_AS2Sender Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworksedi_as2sender_get($res, 31 , $cookieindex);
ipworksedi_as2sender_set($res, 31, $value , $cookieindex);

Default Value

''

Remarks

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

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

EDIData Property (IPWorksEDI_AS2Sender Class)

This property contains the EDI payload of the transmission.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 32 );
ipworksedi_as2sender_set($res, 32, $value );

Default Value

''

Remarks

This property contains the EDI payload of the transmission.

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

The EDI message to send.

This property is not available at design time.

Data Type

Binary String

EDIType Property (IPWorksEDI_AS2Sender Class)

The Content-Type of the EDI message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 33 );
ipworksedi_as2sender_set($res, 33, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

EDIName Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 34 );
ipworksedi_as2sender_set($res, 34, $value );

Default Value

'rfc1767.edi'

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EDIFileName Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 35 );
ipworksedi_as2sender_set($res, 35, $value );

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (IPWorksEDI_AS2Sender Class)

The algorithm used to encrypt the EDI data.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 36 );
ipworksedi_as2sender_set($res, 36, $value );

Default Value

'3DES'

Remarks

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

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

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

Possible values are:

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

Data Type

String

Etag Property (IPWorksEDI_AS2Sender Class)

The Etag of the file being sent.

Object Oriented Interface

public function getEtag();
public function setEtag($value);

Procedural Interface

ipworksedi_as2sender_get($res, 37 );
ipworksedi_as2sender_set($res, 37, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallAutoDetect Property (IPWorksEDI_AS2Sender 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_as2sender_get($res, 38 );
ipworksedi_as2sender_set($res, 38, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksEDI_AS2Sender Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 39 );
ipworksedi_as2sender_set($res, 39, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 40 );
ipworksedi_as2sender_set($res, 40, $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_AS2Sender 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_as2sender_get($res, 41 );
ipworksedi_as2sender_set($res, 41, $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_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 42 );
ipworksedi_as2sender_set($res, 42, $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_AS2Sender 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_as2sender_get($res, 43 );
ipworksedi_as2sender_set($res, 43, $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_AS2Sender Class)

The email address of the HTTP agent (optional).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 44 );
ipworksedi_as2sender_set($res, 44, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

LocalHost Property (IPWorksEDI_AS2Sender 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_as2sender_get($res, 45 );
ipworksedi_as2sender_set($res, 45, $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.

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

The path to a directory for logging.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 46 );
ipworksedi_as2sender_set($res, 46, $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 complete text of the outgoing request and the incoming response.

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

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

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

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

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (IPWorksEDI_AS2Sender Class)

The log file written.

Object Oriented Interface

public function getLogFile();

Procedural Interface

ipworksedi_as2sender_get($res, 47 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

MDNDeliveryOption Property (IPWorksEDI_AS2Sender Class)

A URL indicating how the receipt is to be delivered.

Object Oriented Interface

public function getMDNDeliveryOption();
public function setMDNDeliveryOption($value);

Procedural Interface

ipworksedi_as2sender_get($res, 48 );
ipworksedi_as2sender_set($res, 48, $value );

Default Value

''

Remarks

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

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

Data Type

String

MDNOptions Property (IPWorksEDI_AS2Sender Class)

Used to indicate the options requested for the MDN receipt.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 49 );
ipworksedi_as2sender_set($res, 49, $value );

Default Value

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

Remarks

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

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

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

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

Data Type

String

MDNReceiptContent Property (IPWorksEDI_AS2Sender Class)

This contains the entire content of the MDN Receipt.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 50 );
ipworksedi_as2sender_set($res, 50, $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_AS2Sender Class)

The number of headers in the MDN.

Object Oriented Interface

public function getMDNReceiptHeaderCount();

Procedural Interface

ipworksedi_as2sender_get($res, 51 );

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

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

Object Oriented Interface

public function getMDNReceiptHeaderField();

Procedural Interface

ipworksedi_as2sender_get($res, 52 );

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_AS2Sender 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_as2sender_get($res, 53 );
ipworksedi_as2sender_set($res, 53, $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_AS2Sender 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_as2sender_get($res, 54 );
ipworksedi_as2sender_set($res, 54, $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_AS2Sender Class)

The value of the MDN header currently selected by HeaderIndex .

Object Oriented Interface

public function getMDNReceiptHeaderValue();

Procedural Interface

ipworksedi_as2sender_get($res, 55 );

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_AS2Sender 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_as2sender_get($res, 56 );

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

The human-readable portion of the MDN receipt.

Object Oriented Interface

public function getMDNReceiptMessage();

Procedural Interface

ipworksedi_as2sender_get($res, 57 );

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

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

Object Oriented Interface

public function getMDNReceiptMICValue();

Procedural Interface

ipworksedi_as2sender_get($res, 58 );

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

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

Object Oriented Interface

public function getMDNReceiptSigningProtocol();

Procedural Interface

ipworksedi_as2sender_get($res, 59 );

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

Used to indicate that a message disposition notification is requested.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 60 );
ipworksedi_as2sender_set($res, 60, $value );

Default Value

''

Remarks

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

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

Data Type

String

MessageId Property (IPWorksEDI_AS2Sender Class)

The Id of the message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 61 );
ipworksedi_as2sender_set($res, 61, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

OriginalContentMIC Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 62 );
ipworksedi_as2sender_set($res, 62, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

ProxyAuthScheme Property (IPWorksEDI_AS2Sender Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworksedi_as2sender_get($res, 63 );
ipworksedi_as2sender_set($res, 63, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworksedi_as2sender_get($res, 64 );
ipworksedi_as2sender_set($res, 64, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorksEDI_AS2Sender Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworksedi_as2sender_get($res, 65 );
ipworksedi_as2sender_set($res, 65, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

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

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

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

Data Type

String

ProxyPort Property (IPWorksEDI_AS2Sender Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworksedi_as2sender_get($res, 66 );
ipworksedi_as2sender_set($res, 66, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworksedi_as2sender_get($res, 67 );
ipworksedi_as2sender_set($res, 67, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (IPWorksEDI_AS2Sender Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworksedi_as2sender_get($res, 68 );
ipworksedi_as2sender_set($res, 68, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (IPWorksEDI_AS2Sender Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworksedi_as2sender_get($res, 69 );
ipworksedi_as2sender_set($res, 69, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

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

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

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

Data Type

String

ReceiptSignerCertStore Property (IPWorksEDI_AS2Sender Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 85 );
ipworksedi_as2sender_set($res, 85, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

ReceiptSignerCertStorePassword Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 86 );
ipworksedi_as2sender_set($res, 86, $value );

Default Value

''

Remarks

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

Data Type

String

ReceiptSignerCertStoreType Property (IPWorksEDI_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 87 );
ipworksedi_as2sender_set($res, 87, $value );

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

ReceiptSignerCertSubject Property (IPWorksEDI_AS2Sender Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 95 );
ipworksedi_as2sender_set($res, 95, $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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

ReceiptSignerCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 96 );
ipworksedi_as2sender_set($res, 96, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

RecipientCertCount Property (IPWorksEDI_AS2Sender Class)

The number of records in the RecipientCert arrays.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 97 );
ipworksedi_as2sender_set($res, 97, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientCertEncoded
• RecipientCertStore
• RecipientCertStorePassword
• RecipientCertStoreType
• RecipientCertSubject

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

This property is not available at design time.

Data Type

Integer

RecipientCertStore Property (IPWorksEDI_AS2Sender Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 113 , $recipientcertindex);
ipworksedi_as2sender_set($res, 113, $value , $recipientcertindex);

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

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

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 114 , $recipientcertindex);
ipworksedi_as2sender_set($res, 114, $value , $recipientcertindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (IPWorksEDI_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 115 , $recipientcertindex);
ipworksedi_as2sender_set($res, 115, $value , $recipientcertindex);

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (IPWorksEDI_AS2Sender Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 123 , $recipientcertindex);
ipworksedi_as2sender_set($res, 123, $value , $recipientcertindex);

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

RecipientCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 124 , $recipientcertindex);
ipworksedi_as2sender_set($res, 124, $value , $recipientcertindex);

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

Binary String

RestartDirectory Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getRestartDirectory();
public function setRestartDirectory($value);

Procedural Interface

ipworksedi_as2sender_get($res, 125 );
ipworksedi_as2sender_set($res, 125, $value );

Default Value

''

Remarks

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

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

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

NOTE: This directory will not automatically be cleaned up.

Data Type

String

RolloverSigningCertStore Property (IPWorksEDI_AS2Sender Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getRolloverSigningCertStore();
public function setRolloverSigningCertStore($value);

Procedural Interface

ipworksedi_as2sender_get($res, 141 );
ipworksedi_as2sender_set($res, 141, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

RolloverSigningCertStorePassword Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function getRolloverSigningCertStorePassword();
public function setRolloverSigningCertStorePassword($value);

Procedural Interface

ipworksedi_as2sender_get($res, 142 );
ipworksedi_as2sender_set($res, 142, $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

RolloverSigningCertStoreType Property (IPWorksEDI_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getRolloverSigningCertStoreType();
public function setRolloverSigningCertStoreType($value);

Procedural Interface

ipworksedi_as2sender_get($res, 143 );
ipworksedi_as2sender_set($res, 143, $value );

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

RolloverSigningCertSubject Property (IPWorksEDI_AS2Sender Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getRolloverSigningCertSubject();
public function setRolloverSigningCertSubject($value);

Procedural Interface

ipworksedi_as2sender_get($res, 151 );
ipworksedi_as2sender_set($res, 151, $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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

RolloverSigningCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getRolloverSigningCertEncoded();
public function setRolloverSigningCertEncoded($value);

Procedural Interface

ipworksedi_as2sender_get($res, 152 );
ipworksedi_as2sender_set($res, 152, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SignatureAlgorithm Property (IPWorksEDI_AS2Sender Class)

Signature algorithm to be used in outgoing messages.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 153 );
ipworksedi_as2sender_set($res, 153, $value );

Default Value

'sha-256'

Remarks

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

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

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

Data Type

String

SigningCertStore Property (IPWorksEDI_AS2Sender Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 169 );
ipworksedi_as2sender_set($res, 169, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SigningCertStorePassword Property (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 170 );
ipworksedi_as2sender_set($res, 170, $value );

Default Value

''

Remarks

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

Data Type

String

SigningCertStoreType Property (IPWorksEDI_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 171 );
ipworksedi_as2sender_set($res, 171, $value );

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

SigningCertSubject Property (IPWorksEDI_AS2Sender Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 179 );
ipworksedi_as2sender_set($res, 179, $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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SigningCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 180 );
ipworksedi_as2sender_set($res, 180, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_AS2Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_as2sender_get($res, 181 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_as2sender_get($res, 182 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 183 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_as2sender_get($res, 184 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 185 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 186 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_as2sender_get($res, 187 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_as2sender_get($res, 188 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as2sender_get($res, 189 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as2sender_get($res, 190 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_as2sender_get($res, 191 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 192 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as2sender_get($res, 193 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_as2sender_get($res, 194 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 195 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 196 );
ipworksedi_as2sender_set($res, 196, $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_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 197 );
ipworksedi_as2sender_set($res, 197, $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_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 198 );
ipworksedi_as2sender_set($res, 198, $value );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as2sender_get($res, 199 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_AS2Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as2sender_get($res, 200 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 201 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 202 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 203 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_as2sender_get($res, 204 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_as2sender_get($res, 205 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 206 );
ipworksedi_as2sender_set($res, 206, $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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 207 );
ipworksedi_as2sender_set($res, 207, $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_AS2Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_as2sender_get($res, 208 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_as2sender_get($res, 209 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 210 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_as2sender_get($res, 211 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 212 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 213 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_as2sender_get($res, 214 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_as2sender_get($res, 215 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as2sender_get($res, 216 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as2sender_get($res, 217 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_as2sender_get($res, 218 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 219 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_as2sender_get($res, 220 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_as2sender_get($res, 221 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 222 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 223 );
ipworksedi_as2sender_set($res, 223, $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_AS2Sender Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 224 );
ipworksedi_as2sender_set($res, 224, $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_AS2Sender Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 225 );
ipworksedi_as2sender_set($res, 225, $value );

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

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_as2sender_get($res, 226 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_AS2Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_as2sender_get($res, 227 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 228 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 229 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 230 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_as2sender_get($res, 231 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_as2sender_get($res, 232 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 233 );
ipworksedi_as2sender_set($res, 233, $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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (IPWorksEDI_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 234 );
ipworksedi_as2sender_set($res, 234, $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_AS2Sender 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_as2sender_get($res, 235 );
ipworksedi_as2sender_set($res, 235, $value );

Default Value

0

Remarks

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

Possible values are as follows:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorksEDI_AS2Sender Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksedi_as2sender_get($res, 236 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksedi_as2sender_get($res, 237 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 238 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksedi_as2sender_get($res, 239 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 240 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 241 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksedi_as2sender_get($res, 242 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksedi_as2sender_get($res, 243 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_as2sender_get($res, 244 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_as2sender_get($res, 245 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksedi_as2sender_get($res, 246 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 247 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksedi_as2sender_get($res, 248 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksedi_as2sender_get($res, 249 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_as2sender_get($res, 250 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksedi_as2sender_get($res, 251 );

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

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksedi_as2sender_get($res, 252 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksedi_as2sender_get($res, 253 );

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

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksedi_as2sender_get($res, 254 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksEDI_AS2Sender Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksedi_as2sender_get($res, 255 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_as2sender_get($res, 256 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_as2sender_get($res, 257 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksedi_as2sender_get($res, 258 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksedi_as2sender_get($res, 259 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksedi_as2sender_get($res, 260 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksedi_as2sender_get($res, 261 );

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=support@nsoftware.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_AS2Sender Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_as2sender_get($res, 262 );

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

Subject Property (IPWorksEDI_AS2Sender Class)

The subject of the message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_as2sender_get($res, 263 );
ipworksedi_as2sender_set($res, 263, $value );

Default Value

''

Remarks

The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer.

Data Type

String

Timeout Property (IPWorksEDI_AS2Sender Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksedi_as2sender_get($res, 264 );
ipworksedi_as2sender_set($res, 264, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

URL Property (IPWorksEDI_AS2Sender Class)

The URL to which the request is made.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

ipworksedi_as2sender_get($res, 265 );
ipworksedi_as2sender_set($res, 265, $value );

Default Value

''

Remarks

This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https".

Data Type

String

UseOAEP Property (IPWorksEDI_AS2Sender Class)

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).

Object Oriented Interface

public function getUseOAEP();
public function setUseOAEP($value);

Procedural Interface

ipworksedi_as2sender_get($res, 266 );
ipworksedi_as2sender_set($res, 266, $value );

Default Value

false

Remarks

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the class will use PKCS1.

To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams

Data Type

Boolean

UsePSS Property (IPWorksEDI_AS2Sender Class)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Object Oriented Interface

public function getUsePSS();
public function setUsePSS($value);

Procedural Interface

ipworksedi_as2sender_get($res, 267 );
ipworksedi_as2sender_set($res, 267, $value );

Default Value

false

Remarks

This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

UserAgent Property (IPWorksEDI_AS2Sender Class)

Information about the user agent.

Object Oriented Interface

public function getUserAgent();
public function setUserAgent($value);

Procedural Interface

ipworksedi_as2sender_get($res, 268 );
ipworksedi_as2sender_set($res, 268, $value );

Default Value

'IPWorks EDI AS2Sender Component - www.nsoftware.com'

Remarks

You may override the default with the name and version of your software.

Data Type

String

Config Method (IPWorksEDI_AS2Sender Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoEvents Method (IPWorksEDI_AS2Sender Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_as2sender_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (IPWorksEDI_AS2Sender Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_as2sender_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Post Method (IPWorksEDI_AS2Sender Class)

Post data to the AS2 server, and check the receipt.

Object Oriented Interface

public function doPost();

Procedural Interface

ipworksedi_as2sender_do_post($res);

Remarks

Post data to the server. The reply will also be checked, and if a synchronous MDN was requested (i.e., MDNTo is not empty), it will be validated. After the method finishes, the MDNReceipt, ReceiptSigningProtocol, and ReceiptSignerCert properties will be populated with the appropriate values.

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

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

ReadAsyncReceipt Method (IPWorksEDI_AS2Sender Class)

Reads an asynchronous MDN receipt from the current HTTP session.

Object Oriented Interface

public function doReadAsyncReceipt();

Procedural Interface

ipworksedi_as2sender_do_readasyncreceipt($res);

Remarks

ReadAsyncReceipt is used to read an asynchronous MDN receipt from the . The class will fetch the request stream from the HTTP session. MDNReceipt will be populated with a new instance of MDNReceipt.

Reset Method (IPWorksEDI_AS2Sender Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_as2sender_do_reset($res);

Remarks

Resets all HTTP headers as well as EDIData, etc. After invoking this method the class may be reused as if it were newly created.

Restart Method (IPWorksEDI_AS2Sender Class)

Restart sending of the file specified by the Etag property.

Object Oriented Interface

public function doRestart();

Procedural Interface

ipworksedi_as2sender_do_restart($res);

Remarks

This method should be called when using the AS2 restart functionality. When called, the class will process the file and cache the processed contents to the RestartDirectory. Before sending, the Etag property will be populated with a unique Etag which identifies the processed file.

If sending is interrupted or fails, this method should be called to restart sending of the previously processed file starting where the interruption occurred. In order to restart from the last transfer, the Etag must be populated with the value from the last connection.

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

SendCEMRequest Method (IPWorksEDI_AS2Sender Class)

Sends a Certificate Exchange Messaging (CEM) request.

Object Oriented Interface

public function doSendCEMRequest($requestid);

Procedural Interface

ipworksedi_as2sender_do_sendcemrequest($res, $requestid);

Remarks

This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.

Certificate Exchange Messaging (CEM) allows for new certificates to be sent to a recipient and be automatically updated. This removes the requirement to manually send new certificates to a partner via email or other means. When both sides support this functionality updating certificates can be accomplished in a short period of time.

To prepare a CEM request populate the CEMDetails collection with at least one certificate. For instance if the certificate of the application will be updated soon, the CEMDetails may be populated with the corresponding public certificate to be sent to your partner. CEMDetails should only contain public certificates.

Set CEMRespondByDate to the date by which you expect a response. The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

Optionally set CEMCertId to a friendly identifier that the partner may use to help understand the purpose of the new certificate. For instance "New.Encryption.Cert.2014".

Set CEMResponseURL to the publicly accessible URL where the CEM response will be sent after the partner processes it.

The RequestId parameter uniquely identifies this CEM request and must be saved for use later when receiving the CEM response.

When calling this method the applicable CEMDetails properties are:

• CEMCertStoreType
• CEMCertStore
• CEMCertStorePassword
• CEMCertSubject
• CEMRespondByDate
• CEMResponseURL
• CEMCertUsage (optional)
• CEMCertId (optional)

SendCEMResponse Method (IPWorksEDI_AS2Sender Class)

Sends a Certificate Exchange Messaging (CEM) response.

Object Oriented Interface

public function doSendCEMResponse($requestid);

Procedural Interface

ipworksedi_as2sender_do_sendcemresponse($res, $requestid);

Remarks

This method send the Certificate Exchange Messaging (CEM) request with the details specified in CEMDetails.

A CEM request must have previously been received using AS2Receiver. To send the CEM response, populate CEMDetails with the certificate information and decide whether to accept or reject the request. The following properties may be set to specify the certificate:

• CEMCertStoreType
• CEMCertStore
• CEMCertSubject

Alternatively, the certificate information may be set:

• CEMCertIssuer
• CEMCertSerialNumber

After specifying the certificate information choose whether to accept or reject the request. To accept the request set CEMAccepted to True. To reject the request set CEMAccepted to False and specify a reason in CEMRejectionReason.

Call SendCEMResponse and pass the CEM request Id that was retrieved from the request.

SetRequestHeader Method (IPWorksEDI_AS2Sender Class)

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

Object Oriented Interface

public function doSetRequestHeader($headername, $headervalue);

Procedural Interface

ipworksedi_as2sender_do_setrequestheader($res, $headername, $headervalue);

Remarks

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

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

SetTPInfo Method (IPWorksEDI_AS2Sender Class)

A convenient way to set AS2 communication parameters using XML strings.

Object Oriented Interface

public function doSetTPInfo($profile);

Procedural Interface

ipworksedi_as2sender_do_settpinfo($res, $profile);

Remarks

SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.

The "self" information should always precede the partner information as shown below. AS2Sender as2sender = new AS2Sender(); AS2Profilemgr mgr = new AS2Profilemgr(); mgr.DataDir = @"C:\as2data"; as2sender.SetTPInfo(mgr.GetTPInfo("self")); as2sender.SetTPInfo(mgr.GetTPInfo("partnerOrg")); as2sender.EDIFile = @"C:\as2Data.x12"; as2sender.Post();

VerifyReceipt Method (IPWorksEDI_AS2Sender Class)

Verifies an asynchronous MDN receipt.

Object Oriented Interface

public function doVerifyReceipt();

Procedural Interface

ipworksedi_as2sender_do_verifyreceipt($res);

Remarks

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

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

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

This method should be used to verify receipts received asynchronously; i.e., not in the HTTP reply to a POST. When posting, asynchronous MDN delivery may be requested by setting MDNDeliveryOption.

Connected Event (IPWorksEDI_AS2Sender Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

Disconnected Event (IPWorksEDI_AS2Sender Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 2, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksEDI_AS2Sender Class)

Fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 3, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IPWorksEDI_AS2Sender Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 4, 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_AS2Sender Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 5, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (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 an empty string.

Note that only the top-level headers will be returned through this event, and that they are available through the ReplyHeaders property.

The Field parameter contains the name of the HTTP header (which is the same 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_AS2Sender Class)

Fired with log information while processing a message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 6, 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:

SetCookie Event (IPWorksEDI_AS2Sender Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 7, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

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

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

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

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (IPWorksEDI_AS2Sender Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_as2sender_register_callback($res, 8, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLStatus Event (IPWorksEDI_AS2Sender Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_as2sender_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_AS2Sender Class)

Fired when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

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

Parameter List

 'direction'

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (IPWorksEDI_AS2Sender Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

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

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AS2Sender Class)

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

AS2Sender Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (AS2Sender Class)

AS2Sender Errors

SMIME Errors