POP Class

Properties   Methods   Events   Configuration Settings   Errors  

The POP Component is used to easily retrieve electronic mail from Internet Post Office servers (POP).

Class Name

IPWorks_POP

Procedural Interface

 ipworks_pop_open();
 ipworks_pop_close($res);
 ipworks_pop_register_callback($res, $id, $function);
 ipworks_pop_get_last_error($res);
 ipworks_pop_get_last_error_code($res);
 ipworks_pop_set($res, $id, $index, $value);
 ipworks_pop_get($res, $id, $index);
 ipworks_pop_do_config($res, $configurationstring);
 ipworks_pop_do_connect($res);
 ipworks_pop_do_delete($res);
 ipworks_pop_do_disconnect($res);
 ipworks_pop_do_doevents($res);
 ipworks_pop_do_interrupt($res);
 ipworks_pop_do_listmessagesizes($res);
 ipworks_pop_do_listmessageuids($res);
 ipworks_pop_do_localizedate($res, $datetime);
 ipworks_pop_do_reset($res);
 ipworks_pop_do_retrieve($res);
 ipworks_pop_do_retrieveheaders($res);

Remarks

The POP Class implements a standard internet post office (POP3) client as specified in RFC 1725.

To connect to a MailServer first set the appropriate User and Password and then connect by calling the Connect method. Upon successful connection to the MailServer, the number of waiting messages is shown by the MessageCount property. A message is selected by setting the MessageNumber property to a number between 1 and MessageCount (inclusive). Then, message text and/or headers are received by calling the Retrieve method.

The message text is received through the Transfer event, whereas the message headers are received through the Header event. Additionally, up to MaxLines from the message body are provided in the MessageText property. The body of the message is also saved in the file specified by the LocalFile property. StartTransfer and EndTransfer events are fired at the beginning and end of message transmission. The PITrail event provides a trace of the interaction between the client and server (excluding message transfers).