HTMLMailer Class

Properties   Methods   Events   Config Settings   Errors  

The HTMLMailer Class is used to send HTML emails, including embedded images.

Class Name

IPWorksEDI_HTMLMailer

Procedural Interface

 ipworksedi_htmlmailer_open();
 ipworksedi_htmlmailer_close($res);
 ipworksedi_htmlmailer_register_callback($res, $id, $function);
 ipworksedi_htmlmailer_get_last_error($res);
 ipworksedi_htmlmailer_get_last_error_code($res);
 ipworksedi_htmlmailer_set($res, $id, $index, $value);
 ipworksedi_htmlmailer_get($res, $id, $index);
 ipworksedi_htmlmailer_do_addattachment($res, $filename);
 ipworksedi_htmlmailer_do_calcmessagetext($res);
 ipworksedi_htmlmailer_do_config($res, $configurationstring);
 ipworksedi_htmlmailer_do_connect($res);
 ipworksedi_htmlmailer_do_disconnect($res);
 ipworksedi_htmlmailer_do_doevents($res);
 ipworksedi_htmlmailer_do_interrupt($res);
 ipworksedi_htmlmailer_do_processqueue($res, $queuedir);
 ipworksedi_htmlmailer_do_queue($res, $queuedir);
 ipworksedi_htmlmailer_do_reset($res);
 ipworksedi_htmlmailer_do_resetheaders($res);
 ipworksedi_htmlmailer_do_send($res);
 ipworksedi_htmlmailer_do_sendcommand($res, $command);

Remarks

The HTMLMailer Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2487). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The class sends a message (provided in MessageHTML and MessageText). The HTML message may contain references to images that are automatically embedded into the message.

The MessageHTML property contains the HTML version of the message. The corresponding plaintext version is provided in the MessageText property.

When MessageHTML is set, the class automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.

The recipients are specified by the SendTo, Cc, and BCc properties, and the message subject by the Subject property.

Once all the appropriate properties have been set, call the Send method and your message will be sent to its intended recipient(s).

Other SMTP headers may be specified through the OtherHeaders property. Information about interaction with the server is provided by the PITrail event.

Property List

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

Method List

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

Event List

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

Config Settings

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

AttachmentCount Property (IPWorksEDI_HTMLMailer Class)

The number of records in the Attachment arrays.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 1 );
ipworksedi_htmlmailer_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentData
• AttachmentFileName
• AttachmentName

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

This property is not available at design time.

Data Type

Integer

AttachmentData Property (IPWorksEDI_HTMLMailer Class)

The raw data for the attachment that will be sent with your message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 2 , $attachmentindex);
ipworksedi_htmlmailer_set($res, 2, $value , $attachmentindex);

Default Value

''

Remarks

The raw data for the attachment that will be sent with your message. This field is used if AttachmentFileName is not 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

Binary String

AttachmentFileName Property (IPWorksEDI_HTMLMailer Class)

This property contains the path of a file on your system to be sent as an attachment with your message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 3 , $attachmentindex);
ipworksedi_htmlmailer_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

This property contains the path of a file on your system to be sent as an attachment with your message.

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

This property contains the name of the attachment to be sent.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 5 , $attachmentindex);
ipworksedi_htmlmailer_set($res, 5, $value , $attachmentindex);

Default Value

''

Remarks

This property contains the name of the attachment to be sent.

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

AuthMechanism Property (IPWorksEDI_HTMLMailer Class)

This property is used when connecting to the mail server.

Object Oriented Interface

public function getAuthMechanism();
public function setAuthMechanism($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 6 );
ipworksedi_htmlmailer_set($res, 6, $value );

Default Value

0

Remarks

This is the authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2), NTLM authentication will be used.

If this property is set to amKerberos (6), Kerberos authentication will be used.

Note: This functionality is available only in Windows.

When set to amXOAUTH2 (7), set User to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.

Data Type

Integer

BCc Property (IPWorksEDI_HTMLMailer Class)

This property includes a comma-separated list of addresses for blind carbon copies (optional).

Object Oriented Interface

public function getBCc();
public function setBCc($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 7 );
ipworksedi_htmlmailer_set($res, 7, $value );

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.

The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

Cc Property (IPWorksEDI_HTMLMailer Class)

This property includes a comma-separated list of addresses for carbon copies (optional).

Object Oriented Interface

public function getCc();
public function setCc($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 8 );
ipworksedi_htmlmailer_set($res, 8, $value );

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).

The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

Connected Property (IPWorksEDI_HTMLMailer Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksedi_htmlmailer_get($res, 9 );

Default Value

false

Remarks

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

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

Data Type

Boolean

DeliveryNotificationTo Property (IPWorksEDI_HTMLMailer Class)

This property includes the email address to which to send a delivery notification.

Object Oriented Interface

public function getDeliveryNotificationTo();
public function setDeliveryNotificationTo($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 10 );
ipworksedi_htmlmailer_set($res, 10, $value );

Default Value

''

Remarks

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.

Data Type

String

FirewallAutoDetect Property (IPWorksEDI_HTMLMailer 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_htmlmailer_get($res, 11 );
ipworksedi_htmlmailer_set($res, 11, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorksEDI_HTMLMailer Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 12 );
ipworksedi_htmlmailer_set($res, 12, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorksEDI_HTMLMailer Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 13 );
ipworksedi_htmlmailer_set($res, 13, $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_HTMLMailer 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_htmlmailer_get($res, 14 );
ipworksedi_htmlmailer_set($res, 14, $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_HTMLMailer Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 15 );
ipworksedi_htmlmailer_set($res, 15, $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_HTMLMailer 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_htmlmailer_get($res, 16 );
ipworksedi_htmlmailer_set($res, 16, $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_HTMLMailer Class)

This property includes the email address of the sender (required).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 17 );
ipworksedi_htmlmailer_set($res, 17, $value );

Default Value

''

Remarks

This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

HTMLFile Property (IPWorksEDI_HTMLMailer Class)

This property includes the path to a local HTML file.

Object Oriented Interface

public function getHTMLFile();
public function setHTMLFile($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 18 );
ipworksedi_htmlmailer_set($res, 18, $value );

Default Value

''

Remarks

This property may contain the path to the local HTML file. If this property is not empty, the contents of the file with that name will be appended to the text in MessageHTML.

Note: This means that if MessageHTML is empty, HTMLFile is what will be sent to the server.

This property is not available at design time.

Data Type

String

Idle Property (IPWorksEDI_HTMLMailer Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksedi_htmlmailer_get($res, 19 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

ImageCount Property (IPWorksEDI_HTMLMailer Class)

The number of records in the Image arrays.

Object Oriented Interface

public function getImageCount();
public function setImageCount($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 20 );
ipworksedi_htmlmailer_set($res, 20, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ImageData
• ImageFile
• ImageId
• ImageType

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

This property is not available at design time.

Data Type

Integer

ImageData Property (IPWorksEDI_HTMLMailer Class)

This property optionally specifies the image data.

Object Oriented Interface

public function getImageData($imageindex);
public function setImageData($imageindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 21 , $imageindex);
ipworksedi_htmlmailer_set($res, 21, $value , $imageindex);

Default Value

''

Remarks

This property optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the hex-encoded image data or the raw unencoded image data.

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

This property is not available at design time.

Data Type

Binary String

ImageFile Property (IPWorksEDI_HTMLMailer Class)

This property contains the name of the image files embedded into the HTML message.

Object Oriented Interface

public function getImageFile($imageindex);
public function setImageFile($imageindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 22 , $imageindex);
ipworksedi_htmlmailer_set($res, 22, $value , $imageindex);

Default Value

''

Remarks

This property contains the name of the image files embedded into the HTML message. This value is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).

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

This property is not available at design time.

Data Type

String

ImageId Property (IPWorksEDI_HTMLMailer Class)

This property contains the content identifier for embedded images.

Object Oriented Interface

public function getImageId($imageindex);
public function setImageId($imageindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 23 , $imageindex);
ipworksedi_htmlmailer_set($res, 23, $value , $imageindex);

Default Value

''

Remarks

This property contains the content identifier for embedded images. This value is computed automatically, unless ParseHTML is False, in which case you are responsible for providing it.

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

This property is not available at design time.

Data Type

String

ImageType Property (IPWorksEDI_HTMLMailer Class)

This property contains the content type for embedded images.

Object Oriented Interface

public function getImageType($imageindex);
public function setImageType($imageindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 24 , $imageindex);
ipworksedi_htmlmailer_set($res, 24, $value , $imageindex);

Default Value

''

Remarks

This property contains the content type for embedded images. This value is determined automatically, unless ParseHTML is False, in which case you are responsible for providing it.

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

This property is not available at design time.

Data Type

String

Importance Property (IPWorksEDI_HTMLMailer Class)

This property indicates the importance of the mail message (optional).

Object Oriented Interface

public function getImportance();
public function setImportance($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 25 );
ipworksedi_htmlmailer_set($res, 25, $value );

Default Value

0

Remarks

This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

Data Type

Integer

LastReply Property (IPWorksEDI_HTMLMailer Class)

This property indicates the last reply received from the server.

Object Oriented Interface

public function getLastReply();

Procedural Interface

ipworksedi_htmlmailer_get($res, 26 );

Default Value

''

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalHost Property (IPWorksEDI_HTMLMailer 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_htmlmailer_get($res, 27 );
ipworksedi_htmlmailer_set($res, 27, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

MailPort Property (IPWorksEDI_HTMLMailer Class)

This property includes the server port for SMTP (default 25).

Object Oriented Interface

public function getMailPort();
public function setMailPort($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 28 );
ipworksedi_htmlmailer_set($res, 28, $value );

Default Value

25

Remarks

This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 465 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (IPWorksEDI_HTMLMailer Class)

This property includes the name or address of a mail server (mail relay).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 29 );
ipworksedi_htmlmailer_set($res, 29, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the class does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (e.g., a UNIX host), but it is preferable to select a MailServer that is close to the machine sending mail.

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, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

MessageDate Property (IPWorksEDI_HTMLMailer Class)

This property includes the date of the mail message (optional).

Object Oriented Interface

public function getMessageDate();
public function setMessageDate($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 30 );
ipworksedi_htmlmailer_set($res, 30, $value );

Default Value

'*'

Remarks

If this property contains a nonempty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: If this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the class

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

This property is not available at design time.

Data Type

String

MessageHTML Property (IPWorksEDI_HTMLMailer Class)

This property includes the HTML version of the message.

Object Oriented Interface

public function getMessageHTML();
public function setMessageHTML($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 31 );
ipworksedi_htmlmailer_set($res, 31, $value );

Default Value

''

Remarks

This property contains the HTML version of the message.

When this property is set, the class automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.

Example. Setting MessageHTML:

component.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>";

Data Type

String

MessageId Property (IPWorksEDI_HTMLMailer Class)

This property includes the message identifier for the message.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 32 );
ipworksedi_htmlmailer_set($res, 32, $value );

Default Value

'*'

Remarks

This property contains the message identifier for the message. When set, the value of MessageId is used as the Message-Id header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

This property is not available at design time.

Data Type

String

MessageRecipientCount Property (IPWorksEDI_HTMLMailer Class)

The number of records in the MessageRecipient arrays.

Object Oriented Interface

public function getMessageRecipientCount();
public function setMessageRecipientCount($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 33 );
ipworksedi_htmlmailer_set($res, 33, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

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

This property is not available at design time.

Data Type

Integer

MessageRecipientAddress Property (IPWorksEDI_HTMLMailer Class)

This property contains the email address of the recipient.

Object Oriented Interface

public function getMessageRecipientAddress($recipientindex);
public function setMessageRecipientAddress($recipientindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 34 , $recipientindex);
ipworksedi_htmlmailer_set($res, 34, $value , $recipientindex);

Default Value

''

Remarks

This property contains the email address of the recipient.

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

This property is not available at design time.

Data Type

String

MessageRecipientName Property (IPWorksEDI_HTMLMailer Class)

This property contains the name of the recipient.

Object Oriented Interface

public function getMessageRecipientName($recipientindex);
public function setMessageRecipientName($recipientindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 35 , $recipientindex);
ipworksedi_htmlmailer_set($res, 35, $value , $recipientindex);

Default Value

''

Remarks

This property contains the name of the recipient.

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

This property is not available at design time.

Data Type

String

MessageRecipientOptions Property (IPWorksEDI_HTMLMailer Class)

This property contains the recipient sending options (used only by SMTP).

Object Oriented Interface

public function getMessageRecipientOptions($recipientindex);
public function setMessageRecipientOptions($recipientindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 36 , $recipientindex);
ipworksedi_htmlmailer_set($res, 36, $value , $recipientindex);

Default Value

''

Remarks

This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";

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

This property is not available at design time.

Data Type

String

MessageRecipientType Property (IPWorksEDI_HTMLMailer Class)

This property contains the recipient type: To, Cc, or Bcc.

Object Oriented Interface

public function getMessageRecipientType($recipientindex);
public function setMessageRecipientType($recipientindex, $value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 37 , $recipientindex);
ipworksedi_htmlmailer_set($res, 37, $value , $recipientindex);

Default Value

0

Remarks

This property contains the recipient type: To, Cc, or Bcc.

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

This property is not available at design time.

Data Type

Integer

MessageText Property (IPWorksEDI_HTMLMailer Class)

This property includes the plaintext version of the message.

Object Oriented Interface

public function getMessageText();
public function setMessageText($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 38 );
ipworksedi_htmlmailer_set($res, 38, $value );

Default Value

''

Remarks

This property is a plaintext version of the HTML message. This is necessary for recipients with legacy mail readers that do not support HTML.

The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the class automatically computes a plaintext version of the text and puts it into this property. You may choose to override this default text with your own version.

Data Type

String

OtherHeaders Property (IPWorksEDI_HTMLMailer Class)

This property includes an RFC 822-compliant string consisting of extra headers.

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 39 );
ipworksedi_htmlmailer_set($res, 39, $value );

Default Value

''

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the class. A good example is delivery of MIME-encoded messages.

Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.

Example. Sending an Email with an Additional Header:

component.MailServer = "MyServer"; component.From = "me@server.com"; component.SendTo = "recipient@server.com"; component.Subject = "My Subject"; component.MessageText = "This is the message body."; component.OtherHeaders = "HeaderName: HeaderValue"; component.Send();

This property is not available at design time.

Data Type

String

ParseHTML Property (IPWorksEDI_HTMLMailer Class)

This property controls the behavior of the MessageHTML property.

Object Oriented Interface

public function getParseHTML();
public function setParseHTML($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 40 );
ipworksedi_htmlmailer_set($res, 40, $value );

Default Value

true

Remarks

This property controls the behavior of the MessageHTML property. If ParseHTML is set to False, you must provide valid values in MessageHTML, MessageText, and Images.

Data Type

Boolean

Password Property (IPWorksEDI_HTMLMailer Class)

This property includes a password for logon to the MailServer .

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 41 );
ipworksedi_htmlmailer_set($res, 41, $value );

Default Value

''

Remarks

If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.

This property is not available at design time.

Data Type

String

Priority Property (IPWorksEDI_HTMLMailer Class)

This property includes the priority of the mail message (optional).

Object Oriented Interface

public function getPriority();
public function setPriority($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 42 );
ipworksedi_htmlmailer_set($res, 42, $value );

Default Value

0

Remarks

When this property is set, a priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

Data Type

Integer

ReadReceiptTo Property (IPWorksEDI_HTMLMailer Class)

This property includes the email address to send a read-receipt to.

Object Oriented Interface

public function getReadReceiptTo();
public function setReadReceiptTo($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 43 );
ipworksedi_htmlmailer_set($res, 43, $value );

Default Value

''

Remarks

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.

Data Type

String

ReplyTo Property (IPWorksEDI_HTMLMailer Class)

This property includes a mail address to which to reply (optional).

Object Oriented Interface

public function getReplyTo();
public function setReplyTo($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 44 );
ipworksedi_htmlmailer_set($res, 44, $value );

Default Value

''

Remarks

If this property contains a nonempty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies, which is useful if this address is different from the one in From.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

SendTo Property (IPWorksEDI_HTMLMailer Class)

This property includes a comma-separated list of addresses for destinations (required).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 45 );
ipworksedi_htmlmailer_set($res, 45, $value );

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

The class will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Data Type

String

Sensitivity Property (IPWorksEDI_HTMLMailer Class)

This property indicates the sensitivity of the mail message (optional).

Object Oriented Interface

public function getSensitivity();
public function setSensitivity($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 46 );
ipworksedi_htmlmailer_set($res, 46, $value );

Default Value

0

Remarks

This property provides an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are as follows: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_HTMLMailer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 47 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 48 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 49 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_htmlmailer_get($res, 50 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 51 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 52 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 53 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 54 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_htmlmailer_get($res, 55 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 56 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 57 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 58 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_htmlmailer_get($res, 59 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_htmlmailer_get($res, 60 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 61 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 62 );
ipworksedi_htmlmailer_set($res, 62, $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_HTMLMailer 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_htmlmailer_get($res, 63 );
ipworksedi_htmlmailer_set($res, 63, $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_HTMLMailer Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 64 );
ipworksedi_htmlmailer_set($res, 64, $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_HTMLMailer Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_htmlmailer_get($res, 65 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_HTMLMailer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_htmlmailer_get($res, 66 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 67 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 68 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 69 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_htmlmailer_get($res, 70 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_htmlmailer_get($res, 71 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 72 );
ipworksedi_htmlmailer_set($res, 72, $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_HTMLMailer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 73 );
ipworksedi_htmlmailer_set($res, 73, $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_HTMLMailer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 74 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 75 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 76 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_htmlmailer_get($res, 77 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 78 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 79 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 80 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 81 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_htmlmailer_get($res, 82 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 83 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 84 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 85 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_htmlmailer_get($res, 86 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_htmlmailer_get($res, 87 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 88 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 89 );
ipworksedi_htmlmailer_set($res, 89, $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_HTMLMailer 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_htmlmailer_get($res, 90 );
ipworksedi_htmlmailer_set($res, 90, $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_HTMLMailer Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 91 );
ipworksedi_htmlmailer_set($res, 91, $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_HTMLMailer Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_htmlmailer_get($res, 92 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_HTMLMailer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_htmlmailer_get($res, 93 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 94 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 95 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 96 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_htmlmailer_get($res, 97 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_htmlmailer_get($res, 98 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 99 );
ipworksedi_htmlmailer_set($res, 99, $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_HTMLMailer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 100 );
ipworksedi_htmlmailer_set($res, 100, $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

SSLEnabled Property (IPWorksEDI_HTMLMailer Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksedi_htmlmailer_get($res, 101 );
ipworksedi_htmlmailer_set($res, 101, $value );

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (IPWorksEDI_HTMLMailer 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_htmlmailer_get($res, 102 );
ipworksedi_htmlmailer_set($res, 102, $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:

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 103 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksedi_htmlmailer_get($res, 104 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 105 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksedi_htmlmailer_get($res, 106 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 107 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 108 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 109 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 110 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_htmlmailer_get($res, 111 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_htmlmailer_get($res, 112 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksedi_htmlmailer_get($res, 113 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 114 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksedi_htmlmailer_get($res, 115 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksedi_htmlmailer_get($res, 116 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_htmlmailer_get($res, 117 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksedi_htmlmailer_get($res, 118 );

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_HTMLMailer 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_htmlmailer_get($res, 119 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksedi_htmlmailer_get($res, 120 );

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

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksedi_htmlmailer_get($res, 121 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksEDI_HTMLMailer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksedi_htmlmailer_get($res, 122 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_htmlmailer_get($res, 123 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_htmlmailer_get($res, 124 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksedi_htmlmailer_get($res, 125 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksedi_htmlmailer_get($res, 126 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksedi_htmlmailer_get($res, 127 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksedi_htmlmailer_get($res, 128 );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_htmlmailer_get($res, 129 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

SSLStartMode Property (IPWorksEDI_HTMLMailer Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 130 );
ipworksedi_htmlmailer_set($res, 130, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Subject Property (IPWorksEDI_HTMLMailer Class)

This property includes the subject of the mail message (optional).

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 131 );
ipworksedi_htmlmailer_set($res, 131, $value );

Default Value

''

Remarks

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Data Type

String

Timeout Property (IPWorksEDI_HTMLMailer Class)

The timeout for the class.

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 132 );
ipworksedi_htmlmailer_set($res, 132, $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

User Property (IPWorksEDI_HTMLMailer Class)

This property includes the user identifier needed to log in as in the MailServer .

Object Oriented Interface

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

Procedural Interface

ipworksedi_htmlmailer_get($res, 133 );
ipworksedi_htmlmailer_set($res, 133, $value );

Default Value

''

Remarks

If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.

This property is not available at design time.

Data Type

String

AddAttachment Method (IPWorksEDI_HTMLMailer Class)

This adds FileName as an attachment.

Object Oriented Interface

public function doAddAttachment($filename);

Procedural Interface

ipworksedi_htmlmailer_do_addattachment($res, $filename);

Remarks

This method adds the file name as an attachment. The full list of attachments is contained in the Attachments property.

Example 1: Adding an Attachment

component.AddAttachment("C:\file1.zip"); component.AddAttachment("C:\file2.zip"); component.Send(); Example 3: Using an Attachments Array

component.AttachmentCount = 1; component.AttachmentName(0) = "name"; component.AttachmentFile(0) = "C:\file.txt";

CalcMessageText Method (IPWorksEDI_HTMLMailer Class)

This method populates MessageText with the plaintext version of the message.

Object Oriented Interface

public function doCalcMessageText();

Procedural Interface

ipworksedi_htmlmailer_do_calcmessagetext($res);

Remarks

This method parses MessageHTML or HTMLFile and calculates a plaintext version of the message. The plaintext version is stored in the MessageText property.

Calling this method is optional. When the Send method is called, the class will automatically calculate a plaintext version of the message. This may be called in cases in which the plaintext version will be set explicitly. For instance:

component.MessageHTML="<html><body><b>Test Message</b></body></html>"; component.CalcMessageText(); component.MessageText = "A new custom plaintext message";

Config Method (IPWorksEDI_HTMLMailer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_htmlmailer_do_config($res, $configurationstring);

Remarks

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

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

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

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

Connect Method (IPWorksEDI_HTMLMailer Class)

This method connects to the mail relay and sends the SMTP HELO command.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_htmlmailer_do_connect($res);

Remarks

This method connects to the mail relay and sends the SMTP HELO command, thus preparing to send messages. Any number of messages can later be sent using the Send method.

Example. Connecting and Sending an Email:

control.MailServer = "MyServer" control.From = "me@server.com" control.SendTo = "recipient@server.com" control.Subject = "My Subject" control.MessageText = "This is the message body" control.Connect() control.Send() control.Disconnect()

Disconnect Method (IPWorksEDI_HTMLMailer Class)

This method disconnects from the SMTP server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_htmlmailer_do_disconnect($res);

Remarks

This method disconnects from the mail relay.

DoEvents Method (IPWorksEDI_HTMLMailer Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_htmlmailer_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_HTMLMailer Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_htmlmailer_do_interrupt($res);

Remarks

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

ProcessQueue Method (IPWorksEDI_HTMLMailer Class)

This method sends the messages that previously have been queued into QueueDir .

Object Oriented Interface

public function doProcessQueue($queuedir);

Procedural Interface

ipworksedi_htmlmailer_do_processqueue($res, $queuedir);

Remarks

This method sends the messages that previously have been queued into QueueDir. The PITrail event shows the interaction with the server as messages are processed.

This method looks in the directory for files with the extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the KeepQueue configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Queue Method (IPWorksEDI_HTMLMailer Class)

This method queues the message into QueueDir .

Object Oriented Interface

public function doQueue($queuedir);

Procedural Interface

ipworksedi_htmlmailer_do_queue($res, $queuedir);

Remarks

This method queues the message into QueueDir. The message is queued into a unique file into the directory QueueDir for future processing.

QueueDir must already exist, or an error will be generated. Alternatively, QueueDir may be set to "*" to return the result as a string instead of writing it to a file.

This method returns the name of the unique queue file created in QueueDir. The file extension is ".queued".

Please refer to the ProcessQueue method for more information on email queue processing.

Reset Method (IPWorksEDI_HTMLMailer Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_htmlmailer_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

ResetHeaders Method (IPWorksEDI_HTMLMailer Class)

This method resets all the message headers to empty.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

ipworksedi_htmlmailer_do_resetheaders($res);

Remarks

This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.

Send Method (IPWorksEDI_HTMLMailer Class)

This method sends the current message and MIME-encoded attachment.

Object Oriented Interface

public function doSend();

Procedural Interface

ipworksedi_htmlmailer_do_send($res);

Remarks

This method sends the current message and MIME-encoded attachment. If the class is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.

If the class is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.

Example. Send an HTML Email:

HTMLMailerControl.MailServer = "myserver" HTMLMailerControl.SendTo = "recipient@myserver.com" HTMLMailerControl.From = "me@myserver.com" HTMLMailerControl.Subject = "My Subject" HTMLMailerControl.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>" HTMLMailerControl.Send

SendCommand Method (IPWorksEDI_HTMLMailer Class)

This method sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

ipworksedi_htmlmailer_do_sendcommand($res, $command);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

ConnectionStatus Event (IPWorksEDI_HTMLMailer Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

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

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

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

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

EndTransfer Event (IPWorksEDI_HTMLMailer Class)

This event is fired when the message text completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

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

Parameter List

 'direction'

Remarks

If MessageText is not empty, the EndTransfer event is fired when the MessageText finishes transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. For more information, go to the description of the AttachedFile property.

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

Error Event (IPWorksEDI_HTMLMailer Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

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

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

PITrail Event (IPWorksEDI_HTMLMailer Class)

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

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_htmlmailer_register_callback($res, 4, array($this, 'firePITrail'));

Parameter List

 'direction'
 'message'

Remarks

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

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

SSLServerAuthentication Event (IPWorksEDI_HTMLMailer Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_htmlmailer_register_callback($res, 5, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (IPWorksEDI_HTMLMailer Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_htmlmailer_register_callback($res, 6, 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_HTMLMailer Class)

This event is fired when the message text starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_htmlmailer_register_callback($res, 7, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

If MessageText is not empty, the StartTransfer event is fired when the MessageText starts transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

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

Transfer Event (IPWorksEDI_HTMLMailer Class)

This event is fired when the message text is transferred to MailServer .

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_htmlmailer_register_callback($res, 8, array($this, 'fireTransfer'));

Parameter List

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

Remarks

One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText or AttachedFile.

Text contains the current portion of the message being sent.

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

HTMLMailer Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (HTMLMailer Class)

HTMLMailer Errors

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

MIME Errors

SMTP Errors

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

TCPClient Errors

TCP/IP Errors