SMTP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_SMTP

Procedural Interface

 ipworks_smtp_open();
 ipworks_smtp_close($res);
 ipworks_smtp_register_callback($res, $id, $function);
 ipworks_smtp_get_last_error($res);
 ipworks_smtp_get_last_error_code($res);
 ipworks_smtp_set($res, $id, $index, $value);
 ipworks_smtp_get($res, $id, $index);
 ipworks_smtp_do_config($res, $configurationstring);
 ipworks_smtp_do_connect($res);
 ipworks_smtp_do_disconnect($res);
 ipworks_smtp_do_doevents($res);
 ipworks_smtp_do_expand($res, $emailaddress);
 ipworks_smtp_do_interrupt($res);
 ipworks_smtp_do_processqueue($res, $queuedir);
 ipworks_smtp_do_queue($res, $queuedir);
 ipworks_smtp_do_resetheaders($res);
 ipworks_smtp_do_send($res);
 ipworks_smtp_do_sendtoterminalandemail($res);
 ipworks_smtp_do_sendtoterminalonly($res);
 ipworks_smtp_do_sendtoterminaloremail($res);
 ipworks_smtp_do_verify($res, $emailaddress);

Remarks

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.