MX Class

Properties   Methods   Events   Config Settings   Errors  

The MX class enables querying of mail exchange (MX) records from a Domain Name Server (DNS). Thus, it will find out the names of the mail servers accepting email for a given email address or domain.

Class Name

IPWorks_MX

Procedural Interface

 ipworks_mx_open();
 ipworks_mx_close($res);
 ipworks_mx_register_callback($res, $id, $function);
 ipworks_mx_get_last_error($res);
 ipworks_mx_get_last_error_code($res);
 ipworks_mx_set($res, $id, $index, $value);
 ipworks_mx_get($res, $id, $index);
 ipworks_mx_do_config($res, $configurationstring);
 ipworks_mx_do_doevents($res);
 ipworks_mx_do_interrupt($res);
 ipworks_mx_do_reset($res);
 ipworks_mx_do_resolve($res, $emailaddress);

Remarks

The class will attempt to automatically determine the name of a DNS server from the system settings or from the value of the DNSServer property.

The class operates in synchronous or asynchronous mode, depending on the value of the Timeout property. Calling the Resolve method makes the class query the DNSServer. The Response event is fired for each server that handles mail for the email address. The class will fill out the MailServer property with the most preferred mail server and will set the Status property to "OK" or to an error message upon completion.

The RequestId property may be used to identify requests and is used in the Response event. The user may set its value before sending out requests and then match the responses to the request using the RequestId parameter in the Response 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.

DNSPort Property (IPWorks_MX Class)

This property includes the port where the DNS server is listening.

Object Oriented Interface

public function getDNSPort();
public function setDNSPort($value);

Procedural Interface

ipworks_mx_get($res, 1 );
ipworks_mx_set($res, 1, $value );

Default Value

53

Remarks

This property contains the port where the DNS server is listening. The default value is 53, but you may set this property to any other value for use with experimental servers and such.

This property is not available at design time.

Data Type

Integer

DNSServer Property (IPWorks_MX Class)

This is the address of the DNS server.

Object Oriented Interface

public function getDNSServer();
public function setDNSServer($value);

Procedural Interface

ipworks_mx_get($res, 2 );
ipworks_mx_set($res, 2, $value );

Default Value

''

Remarks

This property contains the address of the DNS server. The class attempts to find the default DNS server for the machine where it is installed, and provide it in the DNSServer property. You may change it to any particular DNS server you want to query. While any internet host running a DNS service will suffice, it is preferable to use either the DNS server for your network or the DNS server for the domain that you are querying.

If the class cannot determine the default DNS server address, the property value will be an empty string.

Note: Automatic discovery of the default DNS server is not supported in the Java edition.

This property is not available at design time.

Data Type

String

Idle Property (IPWorks_MX Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_mx_get($res, 3 );

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

LocalHost Property (IPWorks_MX 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

ipworks_mx_get($res, 4 );
ipworks_mx_set($res, 4, $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

MailServer Property (IPWorks_MX Class)

This property includes the mail server with the lowest precedence value (lowest cost to reach).

Object Oriented Interface

public function getMailServer();

Procedural Interface

ipworks_mx_get($res, 5 );

Default Value

''

Remarks

This property contains the mail server with lowest precedence value (lowest cost to reach). After all events are fired, this property holds the name of the best mail server for the supplied email address, and the Status property holds the completion status.

This property is read-only.

Data Type

String

RequestId Property (IPWorks_MX Class)

This property identifies each request.

Object Oriented Interface

public function getRequestId();
public function setRequestId($value);

Procedural Interface

ipworks_mx_get($res, 6 );
ipworks_mx_set($res, 6, $value );

Default Value

0

Remarks

This property identifies each request. This may be useful if several email addresses need to be resolved. Each request may be identified by the user before starting a query by calling the Resolve method.

If a custom value is needed for RequestId, the property must be set before resolving an email address. The class increments RequestId automatically after sending each request.

This property is not available at design time.

Data Type

Integer

Status Property (IPWorks_MX Class)

The status of the request is empty while in progress. This property is set to OK or to an error message upon completion.

Object Oriented Interface

public function getStatus();

Procedural Interface

ipworks_mx_get($res, 7 );

Default Value

''

Remarks

This property is reset each time the Resolve method is called. When a response comes from the DNSServer, this property is set to "OK" in case of success or to an error message as described in the Response event.

This property is read-only.

Data Type

String

Timeout Property (IPWorks_MX Class)

This property includes the timeout for the class.

Object Oriented Interface

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

Procedural Interface

ipworks_mx_get($res, 8 );
ipworks_mx_set($res, 8, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

Config Method (IPWorks_MX Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_mx_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoEvents Method (IPWorks_MX Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_mx_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 (IPWorks_MX Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_mx_do_interrupt($res);

Remarks

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

Reset Method (IPWorks_MX Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_mx_do_reset($res);

Remarks

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

Resolve Method (IPWorks_MX Class)

This method resolves an email address.

Object Oriented Interface

public function doResolve($emailaddress);

Procedural Interface

ipworks_mx_do_resolve($res, $emailaddress);

Remarks

This method resolves an email address. Calling this method directs the class to query DNSServer at port DNSPort about MX records related to EmailAddress.

The server's response is provided through one or more Response events.

After the query completes, the MailServer property is set to the best mail server and the Status property includes the result description of the response.

Valid queries are email addresses like name@company.com or hostnames and domains like domain.com.

Example. Determine Top Priority Mail Server of Email Address:

MXControl.Resolve "email@server.com" While MXControl.MailServer = "" MXControl.DoEvents() End While BestMailServer = MXControl.MailServer

Error Event (IPWorks_MX Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_mx_register_callback($res, 1, 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.

Response Event (IPWorks_MX Class)

This event is fired for each MailServer accepting email for the domain.

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

ipworks_mx_register_callback($res, 2, array($this, 'fireResponse'));

Parameter List

 'requestid'
 'domain'
 'mailserver'
 'precedence'
 'timetolive'
 'statuscode'
 'description'
 'authoritative'

Remarks

A Response event is fired for each mail server handling email for the requested domain. The RequestId parameter identifies the request and equals the value of RequestId property right before the Resolve method is called. MailServer is the name of the server handling the email for the requested Domain. A lower Precedence value should be preferred. The TimeToLive parameter gives the validity time in seconds before the DNSServer should be queried again.

Possible values for the StatusCode and Description parameters are as follows:

After the last Response event is fired, the class sets the MailServer and Status properties to the best MailServer and the error or success code, respectively.

Config Settings (MX Class)

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

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (MX Class)

MX Errors

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

UDP Errors

SSL Errors

TCP/IP Errors