SMTP Class

Properties   Methods   Events   Config Settings   Errors  

The SMTP Class is used to send Internet mail using the SMTP protocol (the Internet mail standard).

Class Name

IPWorksEDI_SMTP

Procedural Interface

 ipworksedi_smtp_open();
 ipworksedi_smtp_close($res);
 ipworksedi_smtp_register_callback($res, $id, $function);
 ipworksedi_smtp_get_last_error($res);
 ipworksedi_smtp_get_last_error_code($res);
 ipworksedi_smtp_set($res, $id, $index, $value);
 ipworksedi_smtp_get($res, $id, $index);
 ipworksedi_smtp_do_config($res, $configurationstring);
 ipworksedi_smtp_do_connect($res);
 ipworksedi_smtp_do_disconnect($res);
 ipworksedi_smtp_do_doevents($res);
 ipworksedi_smtp_do_expand($res, $emailaddress);
 ipworksedi_smtp_do_interrupt($res);
 ipworksedi_smtp_do_processqueue($res, $queuedir);
 ipworksedi_smtp_do_queue($res, $queuedir);
 ipworksedi_smtp_do_reset($res);
 ipworksedi_smtp_do_resetheaders($res);
 ipworksedi_smtp_do_send($res);
 ipworksedi_smtp_do_sendcommand($res, $command);
 ipworksedi_smtp_do_sendtoterminalandemail($res);
 ipworksedi_smtp_do_sendtoterminalonly($res);
 ipworksedi_smtp_do_sendtoterminaloremail($res);
 ipworksedi_smtp_do_verify($res, $emailaddress);

Remarks

The SMTP Class supports both plaintext and SSL/TLS connections (RFC 2487). When connecting over 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 via the Config method.

The SMTP Class implements a standard SMTP client as specified in RFC 821. It has a simple plug-and-play interface. It contains a number of properties like SendTo, Subject, From, Cc, BCc, etc. that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in MessageText. Messages are sent by calling the Send method.

The class supports message delivery to multiple recipients through the SendTo, Cc, and BCc properties. Simply specify the destination email addresses separated by commas.

The interface of the class is open-ended. New features, including MIME attachments can be supported by using the OtherHeaders property.

A number of events provide feedback during the operation of the class. The Transfer event is fired during message delivery to show the number of bytes delivered. The PITrail event traces the commands that are sent to the server and the respective replies.

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.

AllowExtensions Property (IPWorksEDI_SMTP Class)

This property is a switch allowing the class to use ESMTP features (Extended SMTP).

Object Oriented Interface

public function getAllowExtensions();


public function setAllowExtensions($value);

Procedural Interface

ipworksedi_smtp_get($res, 1 );


ipworksedi_smtp_set($res, 1, $value );

Default Value

true

Remarks

This property is a switch allowing the class to use ESMTP features (Extended SMTP). If this property is True, the class will first send the EHLO greeting (Extended Hello) to the server and, if that fails, the standard HELO command will be sent.

This property is True by default but may be disabled if it is known in advance that the MailServer does not support SMTP extensions.

This property is not available at design time.

Data Type

Boolean

AuthMechanism Property (IPWorksEDI_SMTP Class)

This property is used when connecting to the mail server.

Object Oriented Interface

public function getAuthMechanism();


public function setAuthMechanism($value);

Procedural Interface

ipworksedi_smtp_get($res, 2 );


ipworksedi_smtp_set($res, 2, $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_SMTP 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_smtp_get($res, 3 );


ipworksedi_smtp_set($res, 3, $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_SMTP 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_smtp_get($res, 4 );


ipworksedi_smtp_set($res, 4, $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

Command Property (IPWorksEDI_SMTP Class)

This property is used to send additional commands directly to the server.

Object Oriented Interface

public function setCommand($value);

Procedural Interface

ipworksedi_smtp_set($res, 5, $value );

Default Value

''

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

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

Data Type

String

Connected Property (IPWorksEDI_SMTP Class)

This shows whether the class is connected.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

ipworksedi_smtp_get($res, 6 );


ipworksedi_smtp_set($res, 6, $value );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DeliveryNotificationTo Property (IPWorksEDI_SMTP 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_smtp_get($res, 7 );


ipworksedi_smtp_set($res, 7, $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_SMTP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

ipworksedi_smtp_get($res, 8 );


ipworksedi_smtp_set($res, 8, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksEDI_SMTP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksedi_smtp_get($res, 9 );


ipworksedi_smtp_set($res, 9, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksEDI_SMTP Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

ipworksedi_smtp_get($res, 10 );


ipworksedi_smtp_set($res, 10, $value );

Default Value

''

Remarks

This property contains the name or IP address of 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_SMTP Class)

This property contains 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_smtp_get($res, 11 );


ipworksedi_smtp_set($res, 11, $value );

Default Value

''

Remarks

This property contains 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_SMTP Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

ipworksedi_smtp_get($res, 12 );


ipworksedi_smtp_set($res, 12, $value );

Default Value

0

Remarks

This property contains 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_SMTP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

ipworksedi_smtp_get($res, 13 );


ipworksedi_smtp_set($res, 13, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property 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

From Property (IPWorksEDI_SMTP Class)

The email address of the sender (required).

Object Oriented Interface

public function getFrom();


public function setFrom($value);

Procedural Interface

ipworksedi_smtp_get($res, 14 );


ipworksedi_smtp_set($res, 14, $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: "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

Idle Property (IPWorksEDI_SMTP Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksedi_smtp_get($res, 15 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

Importance Property (IPWorksEDI_SMTP Class)

Importance of the mail message (optional).

Object Oriented Interface

public function getImportance();


public function setImportance($value);

Procedural Interface

ipworksedi_smtp_get($res, 16 );


ipworksedi_smtp_set($res, 16, $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 how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

Data Type

Integer

LastReply Property (IPWorksEDI_SMTP Class)

The last reply from the server.

Object Oriented Interface

public function getLastReply();

Procedural Interface

ipworksedi_smtp_get($res, 17 );

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 can also be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalHost Property (IPWorksEDI_SMTP 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_smtp_get($res, 18 );


ipworksedi_smtp_set($res, 18, $value );

Default Value

''

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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_SMTP Class)

The server port for SMTP (default 25).

Object Oriented Interface

public function getMailPort();


public function setMailPort($value);

Procedural Interface

ipworksedi_smtp_get($res, 19 );


ipworksedi_smtp_set($res, 19, $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 implicit 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_SMTP Class)

The name or address of a mail server (mail relay).

Object Oriented Interface

public function getMailServer();


public function setMailServer($value);

Procedural Interface

ipworksedi_smtp_get($res, 20 );


ipworksedi_smtp_set($res, 20, $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 (a UNIX host for example), 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 and 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

Message Property (IPWorksEDI_SMTP Class)

Provides a way to set the raw message content.

Object Oriented Interface

public function getMessage();


public function setMessage($value);

Procedural Interface

ipworksedi_smtp_get($res, 21 );


ipworksedi_smtp_set($res, 21, $value );

Default Value

''

Remarks

This property may be set instead of MessageText. The value set here will not be modified in any way by the class and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

This property is not available at design time.

Data Type

Binary String

MessageDate Property (IPWorksEDI_SMTP Class)

Date of the mail message (optional).

Object Oriented Interface

public function getMessageDate();


public function setMessageDate($value);

Procedural Interface

ipworksedi_smtp_get($res, 22 );


ipworksedi_smtp_set($res, 22, $value );

Default Value

'*'

Remarks

If this property contains a non-empty 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

MessageHeaderCount Property (IPWorksEDI_SMTP Class)

The number of records in the MessageHeader arrays.

Object Oriented Interface

public function getMessageHeaderCount();

Procedural Interface

ipworksedi_smtp_get($res, 23 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

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

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

Data Type

Integer

MessageHeaderField Property (IPWorksEDI_SMTP Class)

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

Object Oriented Interface

public function getMessageHeaderField($messageheaderindex);

Procedural Interface

ipworksedi_smtp_get($res, 24 , $messageheaderindex);

Default Value

''

Remarks

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

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

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

Data Type

String

MessageHeaderValue Property (IPWorksEDI_SMTP Class)

This property contains the header contents.

Object Oriented Interface

public function getMessageHeaderValue($messageheaderindex);

Procedural Interface

ipworksedi_smtp_get($res, 25 , $messageheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

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

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

Data Type

String

MessageHeadersString Property (IPWorksEDI_SMTP Class)

String representation of RFC822-encoded headers of the message.

Object Oriented Interface

public function getMessageHeadersString();

Procedural Interface

ipworksedi_smtp_get($res, 26 );

Default Value

''

Remarks

This property holds the full headers of the message in RFC822 format.

This property is read-only.

Data Type

String

MessageId Property (IPWorksEDI_SMTP Class)

The Message Identifier for the message.

Object Oriented Interface

public function getMessageId();


public function setMessageId($value);

Procedural Interface

ipworksedi_smtp_get($res, 27 );


ipworksedi_smtp_set($res, 27, $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_SMTP Class)

The number of records in the MessageRecipient arrays.

Object Oriented Interface

public function getMessageRecipientCount();


public function setMessageRecipientCount($value);

Procedural Interface

ipworksedi_smtp_get($res, 28 );


ipworksedi_smtp_set($res, 28, $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_SMTP 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_smtp_get($res, 29 , $recipientindex);


ipworksedi_smtp_set($res, 29, $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_SMTP Class)

This property contains the name of the recipient.

Object Oriented Interface

public function getMessageRecipientName($recipientindex);


public function setMessageRecipientName($recipientindex, $value);

Procedural Interface

ipworksedi_smtp_get($res, 30 , $recipientindex);


ipworksedi_smtp_set($res, 30, $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_SMTP 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_smtp_get($res, 31 , $recipientindex);


ipworksedi_smtp_set($res, 31, $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_SMTP 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_smtp_get($res, 32 , $recipientindex);


ipworksedi_smtp_set($res, 32, $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_SMTP Class)

The full text of the message to send (without headers).

Object Oriented Interface

public function getMessageText();


public function setMessageText($value);

Procedural Interface

ipworksedi_smtp_get($res, 33 );


ipworksedi_smtp_set($res, 33, $value );

Default Value

''

Remarks

This property contains the full text of the message.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

Data Type

String

OtherHeaders Property (IPWorksEDI_SMTP Class)

An RFC 822 compliant string consisting of extra headers.

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

ipworksedi_smtp_get($res, 34 );


ipworksedi_smtp_set($res, 34, $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, etc.

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 (Send an Email With 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

Password Property (IPWorksEDI_SMTP Class)

A password for logon to the MailServer .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksedi_smtp_get($res, 35 );


ipworksedi_smtp_set($res, 35, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

Priority Property (IPWorksEDI_SMTP Class)

Priority of the mail message (optional).

Object Oriented Interface

public function getPriority();


public function setPriority($value);

Procedural Interface

ipworksedi_smtp_get($res, 36 );


ipworksedi_smtp_set($res, 36, $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_SMTP Class)

Email address to send a read receipt to.

Object Oriented Interface

public function getReadReceiptTo();


public function setReadReceiptTo($value);

Procedural Interface

ipworksedi_smtp_get($res, 37 );


ipworksedi_smtp_set($res, 37, $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 which should receive the read-receipt.

Data Type

String

ReplyTo Property (IPWorksEDI_SMTP Class)

A mail address to which to reply (optional).

Object Oriented Interface

public function getReplyTo();


public function setReplyTo($value);

Procedural Interface

ipworksedi_smtp_get($res, 38 );


ipworksedi_smtp_set($res, 38, $value );

Default Value

''

Remarks

If this property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (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

ReturnPath Property (IPWorksEDI_SMTP Class)

Sets the Return-Path to be used for sending email.

Object Oriented Interface

public function getReturnPath();


public function setReturnPath($value);

Procedural Interface

ipworksedi_smtp_get($res, 39 );


ipworksedi_smtp_set($res, 39, $value );

Default Value

''

Remarks

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.

Data Type

String

SendTo Property (IPWorksEDI_SMTP Class)

A comma separated list of addresses for destinations (required).

Object Oriented Interface

public function getSendTo();


public function setSendTo($value);

Procedural Interface

ipworksedi_smtp_get($res, 40 );


ipworksedi_smtp_set($res, 40, $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: "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 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_SMTP Class)

Sensitivity of the mail message (optional).

Object Oriented Interface

public function getSensitivity();


public function setSensitivity($value);

Procedural Interface

ipworksedi_smtp_get($res, 41 );


ipworksedi_smtp_set($res, 41, $value );

Default Value

0

Remarks

This property is 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: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

Data Type

Integer

SSLAcceptServerCertEncoded Property (IPWorksEDI_SMTP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_smtp_get($res, 43 );


ipworksedi_smtp_set($res, 43, $value );

Default Value

''

Remarks

This is 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

SSLCertEncoded Property (IPWorksEDI_SMTP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_smtp_get($res, 71 );


ipworksedi_smtp_set($res, 71, $value );

Default Value

''

Remarks

This is 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

SSLCertStore Property (IPWorksEDI_SMTP Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksedi_smtp_get($res, 87 );


ipworksedi_smtp_set($res, 87, $value );

Default Value

'MY'

Remarks

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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_SMTP 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_smtp_get($res, 88 );


ipworksedi_smtp_set($res, 88, $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_SMTP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_smtp_get($res, 89 );


ipworksedi_smtp_set($res, 89, $value );

Default Value

0

Remarks

This is 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

SSLCertSubject Property (IPWorksEDI_SMTP Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_smtp_get($res, 90 );


ipworksedi_smtp_set($res, 90, $value );

Default Value

''

Remarks

This is 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

SSLEnabled Property (IPWorksEDI_SMTP Class)

Whether TLS/SSL is enabled.

Object Oriented Interface

public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface

ipworksedi_smtp_get($res, 98 );


ipworksedi_smtp_set($res, 98, $value );

Default Value

false

Remarks

This setting 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_SMTP Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

ipworksedi_smtp_get($res, 99 );


ipworksedi_smtp_set($res, 99, $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:

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

SSLServerCertEncoded Property (IPWorksEDI_SMTP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_smtp_get($res, 101 );

Default Value

''

Remarks

This is 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_SMTP Class)

Determines how the class starts the SSL negotiation.

Object Oriented Interface

public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface

ipworksedi_smtp_get($res, 128 );


ipworksedi_smtp_set($res, 128, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Subject Property (IPWorksEDI_SMTP Class)

The subject of the mail message (optional).

Object Oriented Interface

public function getSubject();


public function setSubject($value);

Procedural Interface

ipworksedi_smtp_get($res, 129 );


ipworksedi_smtp_set($res, 129, $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_SMTP Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksedi_smtp_get($res, 130 );


ipworksedi_smtp_set($res, 130, $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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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_SMTP Class)

A user identifier to login as in the MailServer .

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksedi_smtp_get($res, 131 );


ipworksedi_smtp_set($res, 131, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

Config Method (IPWorksEDI_SMTP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_smtp_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_SMTP Class)

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

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_smtp_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_SMTP Class)

This method disconnects from the SMTP server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_smtp_do_disconnect($res);

Remarks

This method disconnects from the mail relay.

DoEvents Method (IPWorksEDI_SMTP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Expand Method (IPWorksEDI_SMTP Class)

This method asks the MailServer to expand a name or mailing list.

Object Oriented Interface

public function doExpand($emailaddress);

Procedural Interface

ipworksedi_smtp_do_expand($res, $emailaddress);

Remarks

This method asks the MailServer to expand a name or mailing list. The resulting response is provided in one or more Expand events (one for each address). The class will try to connect to the mail relay if it is not already connected.

Interrupt Method (IPWorksEDI_SMTP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_smtp_do_interrupt($res);

Remarks

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

ProcessQueue Method (IPWorksEDI_SMTP Class)

Sends the messages which have previously been queued into QueueDir .

Object Oriented Interface

public function doProcessQueue($queuedir);

Procedural Interface

ipworksedi_smtp_do_processqueue($res, $queuedir);

Remarks

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

This method looks in the directory for files with 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_SMTP Class)

Queues the message into QueueDir .

Object Oriented Interface

public function doQueue($queuedir);

Procedural Interface

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

The 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_SMTP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_smtp_do_reset($res);

Remarks

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

ResetHeaders Method (IPWorksEDI_SMTP Class)

Resets all the message headers to empty.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

ipworksedi_smtp_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_SMTP Class)

Sends the current message.

Object Oriented Interface

public function doSend();

Procedural Interface

ipworksedi_smtp_do_send($res);

Remarks

This method sends the current message. 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 Email)

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

SendCommand Method (IPWorksEDI_SMTP Class)

Sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

ipworksedi_smtp_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 and/or monitor the PITrail event to obtain the server's response.

SendToTerminalAndEmail Method (IPWorksEDI_SMTP Class)

Sends to terminal and email.

Object Oriented Interface

public function doSendToTerminalAndEmail();

Procedural Interface

ipworksedi_smtp_do_sendtoterminalandemail($res);

Remarks

This method is similar to Send but requests also that the message is sent to the terminal of the user as well, if he is logged on and accepts terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOnly Method (IPWorksEDI_SMTP Class)

Sends to terminal only.

Object Oriented Interface

public function doSendToTerminalOnly();

Procedural Interface

ipworksedi_smtp_do_sendtoterminalonly($res);

Remarks

This method is similar to Send but requests instead that the message is sent to the user's terminal. An error code with the server's response is returned if the user is not logged in or does not accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOrEmail Method (IPWorksEDI_SMTP Class)

Sends to terminal or email.

Object Oriented Interface

public function doSendToTerminalOrEmail();

Procedural Interface

ipworksedi_smtp_do_sendtoterminaloremail($res);

Remarks

This method is similar to Send but requests instead that the message is first sent to the user's terminal. If the user is not logged in or does not accept terminal messages, the message is sent to his mailbox. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

Verify Method (IPWorksEDI_SMTP Class)

Sends a Verification request to the SMTP server.

Object Oriented Interface

public function doVerify($emailaddress);

Procedural Interface

ipworksedi_smtp_do_verify($res, $emailaddress);

Remarks

This method asks the MailServer to verify the email address provided in the 'EmailAddress' parameter.

ConnectionStatus Event (IPWorksEDI_SMTP Class)

This event is fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

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

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus 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_SMTP Class)

This event is fired when the message text completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_smtp_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_SMTP Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Expand Event (IPWorksEDI_SMTP Class)

This event is fired for every email address returned by the server when the Expand method is called.

Object Oriented Interface

public function fireExpand($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 4, array($this, 'fireExpand'));

Parameter List

 'address'

Remarks

This event is fired for every email address as returned by the mail server when the Expand method is called.

The Address parameter may contain a name and an email address, or just an email address, suitable for any of the addressing properties.

PITrail Event (IPWorksEDI_SMTP Class)

Traces the commands sent to the mail server, and the respective replies.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 5, array($this, 'firePITrail'));

Parameter List

 'direction'
 'message'

Remarks

The PITrail event is useful for debugging purposes. It shows all 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_SMTP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 6, 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_SMTP Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 7, 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_SMTP Class)

Fired when the message text starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 8, 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_SMTP Class)

Fired while the message text gets transferred to MailServer .

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_smtp_register_callback($res, 9, 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 and/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 (SMTP Class)

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SMTP Class)

SMTP Errors

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

TCPClient Errors

TCP/IP Errors