POP Class

Properties   Methods   Events   Config Settings   Errors  

The POP Class is used to easily retrieve electronic mail from internet post office servers (POP).

Class Name

IPWorksEDI_POP

Procedural Interface

 ipworksedi_pop_open();
 ipworksedi_pop_close($res);
 ipworksedi_pop_register_callback($res, $id, $function);
 ipworksedi_pop_get_last_error($res);
 ipworksedi_pop_get_last_error_code($res);
 ipworksedi_pop_set($res, $id, $index, $value);
 ipworksedi_pop_get($res, $id, $index);
 ipworksedi_pop_do_config($res, $configurationstring);
 ipworksedi_pop_do_connect($res);
 ipworksedi_pop_do_delete($res);
 ipworksedi_pop_do_disconnect($res);
 ipworksedi_pop_do_doevents($res);
 ipworksedi_pop_do_interrupt($res);
 ipworksedi_pop_do_listmessagesizes($res);
 ipworksedi_pop_do_listmessageuids($res);
 ipworksedi_pop_do_localizedate($res, $datetime);
 ipworksedi_pop_do_querymessagesize($res);
 ipworksedi_pop_do_querymessageuid($res);
 ipworksedi_pop_do_querytotalsize($res);
 ipworksedi_pop_do_reset($res);
 ipworksedi_pop_do_retrieve($res);
 ipworksedi_pop_do_retrieveheaders($res);
 ipworksedi_pop_do_sendcommand($res, $command);

Remarks

The POP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). 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 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, the message text and 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).

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.

AuthMechanism Property (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function getAuthMechanism();


public function setAuthMechanism($value);

Procedural Interface

ipworksedi_pop_get($res, 1 );


ipworksedi_pop_set($res, 1, $value );

Default Value

0

Remarks

This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.

amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. Note: This functionality is available only in Windows.

Data Type

Integer

Command Property (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function setCommand($value);

Procedural Interface

ipworksedi_pop_set($res, 2, $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_POP Class)

This shows whether the class is connected.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

ipworksedi_pop_get($res, 3 );


ipworksedi_pop_set($res, 3, $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

FirewallAutoDetect Property (IPWorksEDI_POP 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_pop_get($res, 4 );


ipworksedi_pop_set($res, 4, $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_POP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksedi_pop_get($res, 5 );


ipworksedi_pop_set($res, 5, $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_POP 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_pop_get($res, 6 );


ipworksedi_pop_set($res, 6, $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_POP 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_pop_get($res, 7 );


ipworksedi_pop_set($res, 7, $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_POP 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_pop_get($res, 8 );


ipworksedi_pop_set($res, 8, $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_POP 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_pop_get($res, 9 );


ipworksedi_pop_set($res, 9, $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

Idle Property (IPWorksEDI_POP Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksedi_pop_get($res, 10 );

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

IncludeHeaders Property (IPWorksEDI_POP Class)

This property instructs the class to include the headers in the MessageText and LocalFile.

Object Oriented Interface

public function getIncludeHeaders();


public function setIncludeHeaders($value);

Procedural Interface

ipworksedi_pop_get($res, 11 );


ipworksedi_pop_set($res, 11, $value );

Default Value

false

Remarks

This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the MessageText property;. If LocalFile is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the MIME class for further message processing.

Data Type

Boolean

LastReply Property (IPWorksEDI_POP Class)

The last reply from the server.

Object Oriented Interface

public function getLastReply();

Procedural Interface

ipworksedi_pop_get($res, 12 );

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

LocalFile Property (IPWorksEDI_POP Class)

This property includes the path to a local file to download the message body. If the file exists, it is overwritten (optional).

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

ipworksedi_pop_get($res, 13 );


ipworksedi_pop_set($res, 13, $value );

Default Value

''

Remarks

This property is used when retrieving a message. If this property is empty, then the received data are provided through the parameters of the Transfer event. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.

Data Type

String

LocalHost Property (IPWorksEDI_POP 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_pop_get($res, 14 );


ipworksedi_pop_set($res, 14, $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_POP Class)

This property includes the server port for POP (default 110).

Object Oriented Interface

public function getMailPort();


public function setMailPort($value);

Procedural Interface

ipworksedi_pop_get($res, 15 );


ipworksedi_pop_set($res, 15, $value );

Default Value

110

Remarks

This property contains the server port for POP (default 110). 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 Secure Sockets Layer (SSL), use port 995 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (IPWorksEDI_POP Class)

This property includes the name or address of a mail server (internet post office server).

Object Oriented Interface

public function getMailServer();


public function setMailServer($value);

Procedural Interface

ipworksedi_pop_get($res, 16 );


ipworksedi_pop_set($res, 16, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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.

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

MaxLines Property (IPWorksEDI_POP Class)

This property includes the maximum number of message lines other than headers to retrieve.

Object Oriented Interface

public function getMaxLines();


public function setMaxLines($value);

Procedural Interface

ipworksedi_pop_get($res, 17 );


ipworksedi_pop_set($res, 17, $value );

Default Value

0

Remarks

This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.

The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.

Data Type

Integer

Message Property (IPWorksEDI_POP Class)

This property provides the raw message content.

Object Oriented Interface

public function getMessage();

Procedural Interface

ipworksedi_pop_get($res, 18 );

Default Value

''

Remarks

This property is populated after calling Retrieve and holds the raw message content. This can be used to access the data before any processing is done by the class.

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

Data Type

Binary String

MessageCc Property (IPWorksEDI_POP Class)

This property includes the value of the CC header of the last retrieved message.

Object Oriented Interface

public function getMessageCc();

Procedural Interface

ipworksedi_pop_get($res, 19 );

Default Value

''

Remarks

This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageCount Property (IPWorksEDI_POP Class)

This property includes the number of messages in the mailbox.

Object Oriented Interface

public function getMessageCount();

Procedural Interface

ipworksedi_pop_get($res, 20 );

Default Value

0

Remarks

This property contains the number of messages in the mailbox. When the class is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server.

This property is read-only.

Data Type

Integer

MessageDate Property (IPWorksEDI_POP Class)

This property includes the value of the date header of the last retrieved message.

Object Oriented Interface

public function getMessageDate();

Procedural Interface

ipworksedi_pop_get($res, 21 );

Default Value

''

Remarks

This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageFrom Property (IPWorksEDI_POP Class)

This property includes the value of the from header of the last retrieved message.

Object Oriented Interface

public function getMessageFrom();

Procedural Interface

ipworksedi_pop_get($res, 22 );

Default Value

''

Remarks

This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageHeaderCount Property (IPWorksEDI_POP Class)

The number of records in the MessageHeader arrays.

Object Oriented Interface

public function getMessageHeaderCount();

Procedural Interface

ipworksedi_pop_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_POP 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_pop_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_POP Class)

This property contains the header contents.

Object Oriented Interface

public function getMessageHeaderValue($messageheaderindex);

Procedural Interface

ipworksedi_pop_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_POP Class)

This property includes a string representation of the full headers of the message as retrieved from the server.

Object Oriented Interface

public function getMessageHeadersString();

Procedural Interface

ipworksedi_pop_get($res, 26 );

Default Value

''

Remarks

This property contains a string representation of the full headers of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server.

The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString

This property is read-only.

Data Type

String

MessageNumber Property (IPWorksEDI_POP Class)

This property includes the current (selected) message.

Object Oriented Interface

public function getMessageNumber();


public function setMessageNumber($value);

Procedural Interface

ipworksedi_pop_get($res, 27 );


ipworksedi_pop_set($res, 27, $value );

Default Value

1

Remarks

This property indicates the current (selected) message. This property specifies a message number in between 1 and MessageCount. The various class methods related to single messages use this property as a message pointer (see method descriptions and the MessageSize property).

Data Type

Integer

MessageRecipientCount Property (IPWorksEDI_POP Class)

The number of records in the MessageRecipient arrays.

Object Oriented Interface

public function getMessageRecipientCount();

Procedural Interface

ipworksedi_pop_get($res, 28 );

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 read-only and not available at design time.

Data Type

Integer

MessageRecipientAddress Property (IPWorksEDI_POP Class)

This property contains the email address of the recipient.

Object Oriented Interface

public function getMessageRecipientAddress($recipientindex);

Procedural Interface

ipworksedi_pop_get($res, 29 , $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 read-only and not available at design time.

Data Type

String

MessageRecipientName Property (IPWorksEDI_POP Class)

This property contains the name of the recipient.

Object Oriented Interface

public function getMessageRecipientName($recipientindex);

Procedural Interface

ipworksedi_pop_get($res, 30 , $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 read-only and not available at design time.

Data Type

String

MessageRecipientOptions Property (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function getMessageRecipientOptions($recipientindex);

Procedural Interface

ipworksedi_pop_get($res, 31 , $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 read-only and not available at design time.

Data Type

String

MessageRecipientType Property (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function getMessageRecipientType($recipientindex);

Procedural Interface

ipworksedi_pop_get($res, 32 , $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 read-only and not available at design time.

Data Type

Integer

MessageReplyTo Property (IPWorksEDI_POP Class)

This property includes the value of the Reply-To header of the last retrieved message.

Object Oriented Interface

public function getMessageReplyTo();

Procedural Interface

ipworksedi_pop_get($res, 33 );

Default Value

''

Remarks

This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageSize Property (IPWorksEDI_POP Class)

This property includes the size in bytes of the current message.

Object Oriented Interface

public function getMessageSize();

Procedural Interface

ipworksedi_pop_get($res, 34 );

Default Value

0

Remarks

This property contains the size in bytes of the current message. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is 0. Otherwise, it contains the size of the mail message (including headers) as reported by the server.

The MailServer is asked about the size of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

This property is read-only.

Data Type

Integer

MessageSubject Property (IPWorksEDI_POP Class)

This property includes the value of the Subject header of the last retrieved message.

Object Oriented Interface

public function getMessageSubject();

Procedural Interface

ipworksedi_pop_get($res, 35 );

Default Value

''

Remarks

This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageText Property (IPWorksEDI_POP Class)

This property includes the full text of the message as retrieved from the server.

Object Oriented Interface

public function getMessageText();

Procedural Interface

ipworksedi_pop_get($res, 36 );

Default Value

''

Remarks

This property contains the full text of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of MaxLines).

The MailServer is asked about the text of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

Data Type

String

MessageTo Property (IPWorksEDI_POP Class)

This property includes the value of the To header of the last retrieved message.

Object Oriented Interface

public function getMessageTo();

Procedural Interface

ipworksedi_pop_get($res, 37 );

Default Value

''

Remarks

This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageUID Property (IPWorksEDI_POP Class)

This property includes the unique identifier of the message as specified by the server.

Object Oriented Interface

public function getMessageUID();

Procedural Interface

ipworksedi_pop_get($res, 38 );

Default Value

''

Remarks

This property contains the unique identifier of the message as specified by the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the UID of the mail message as reported by the server.

The MailServer is asked about the UID of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

Password Property (IPWorksEDI_POP Class)

This property includes the password for the mailbox user.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksedi_pop_get($res, 39 );


ipworksedi_pop_set($res, 39, $value );

Default Value

''

Remarks

This property contains the password for the mailbox user. This property must be set before the class connects to the MailServer.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksEDI_POP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_pop_get($res, 41 );


ipworksedi_pop_set($res, 41, $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_POP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_pop_get($res, 69 );


ipworksedi_pop_set($res, 69, $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_POP 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_pop_get($res, 85 );


ipworksedi_pop_set($res, 85, $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_POP 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_pop_get($res, 86 );


ipworksedi_pop_set($res, 86, $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_POP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_pop_get($res, 87 );


ipworksedi_pop_set($res, 87, $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_POP 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_pop_get($res, 88 );


ipworksedi_pop_set($res, 88, $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_POP Class)

Whether TLS/SSL is enabled.

Object Oriented Interface

public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface

ipworksedi_pop_get($res, 96 );


ipworksedi_pop_set($res, 96, $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_POP Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

ipworksedi_pop_get($res, 97 );


ipworksedi_pop_set($res, 97, $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_POP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_pop_get($res, 99 );

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

Determines how the class starts the SSL negotiation.

Object Oriented Interface

public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface

ipworksedi_pop_get($res, 126 );


ipworksedi_pop_set($res, 126, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (IPWorksEDI_POP Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksedi_pop_get($res, 127 );


ipworksedi_pop_set($res, 127, $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

TotalSize Property (IPWorksEDI_POP Class)

This property includes cumulative size in bytes of messages in the mailbox (including headers).

Object Oriented Interface

public function getTotalSize();

Procedural Interface

ipworksedi_pop_get($res, 128 );

Default Value

0

Remarks

This property contains the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the value of this property is 0. When connected, it contains the cumulative size of all the messages in the mail box as reported by the POP server.

This property is read-only.

Data Type

Long64

User Property (IPWorksEDI_POP Class)

This property includes the user identifier for the mailbox.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksedi_pop_get($res, 129 );


ipworksedi_pop_set($res, 129, $value );

Default Value

''

Remarks

This property contains the user identifier for the mailbox. This property must be set before the class connects to the MailServer.

Data Type

String

Config Method (IPWorksEDI_POP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_pop_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_POP Class)

This method connects to the mail server and attempts to log in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_pop_do_connect($res);

Remarks

This method connects to the mail server and attempts to log in using the current User and Password. Then it retrieves the initial statistics about the mailbox contents (MessageCount and TotalSize).

Example. Connect to POP Mailbox:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

Delete Method (IPWorksEDI_POP Class)

This method deletes a message specified by MessageNumber on the server.

Object Oriented Interface

public function doDelete();

Procedural Interface

ipworksedi_pop_do_delete($res);

Remarks

This method asks the MailServer to delete the message specified by MessageNumber. The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the Reset method.

Disconnect Method (IPWorksEDI_POP Class)

This method disconnects from the mail server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_pop_do_disconnect($res);

Remarks

This method makes the class disconnect from the MailServer by sending the QUIT command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection.

DoEvents Method (IPWorksEDI_POP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_pop_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_POP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_pop_do_interrupt($res);

Remarks

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

ListMessageSizes Method (IPWorksEDI_POP Class)

This method retrieves a list of all message sizes from the server.

Object Oriented Interface

public function doListMessageSizes();

Procedural Interface

ipworksedi_pop_do_listmessagesizes($res);

Remarks

This message retrieves a list of all message sizes from the server. For each message listed, a MessageList event will fire containing the number and size of the message.

ListMessageUIDs Method (IPWorksEDI_POP Class)

This method retrieves a list of all message UIDs from the server.

Object Oriented Interface

public function doListMessageUIDs();

Procedural Interface

ipworksedi_pop_do_listmessageuids($res);

Remarks

This method retrieves a list of all message UIDs from the server. For each message listed, a MessageList event will fire containing the number and UID of the message.

LocalizeDate Method (IPWorksEDI_POP Class)

This method converts a valid RFC 822 message date to a local date and time.

Object Oriented Interface

public function doLocalizeDate($datetime);

Procedural Interface

ipworksedi_pop_do_localizedate($res, $datetime);

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

QueryMessageSize Method (IPWorksEDI_POP Class)

This method returns the size in bytes of the current message.

Object Oriented Interface

public function doQueryMessageSize();

Procedural Interface

ipworksedi_pop_do_querymessagesize($res);

Remarks

This method queries the server for the size in bytes of the message specified by MessageNumber. The method returns the size (in bytes) of the message.

If the class is not connected, or MessageNumber does not contain a valid message number, the return value is 0. Otherwise, it returns the size of the mail message (including headers) as reported by the server.

The MailServer is asked about the size of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

QueryMessageUID Method (IPWorksEDI_POP Class)

This method returns the unique identifier (UID) of the message as specified by the server.

Object Oriented Interface

public function doQueryMessageUID();

Procedural Interface

ipworksedi_pop_do_querymessageuid($res);

Remarks

This method returns the unique identifier (UID) of the message specified by MessageNumber. If the class is not connected, or MessageNumber does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server.

The MailServer is asked about the UID of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

QueryTotalSize Method (IPWorksEDI_POP Class)

This method returns the cumulative size in bytes of messages in the mailbox (including headers).

Object Oriented Interface

public function doQueryTotalSize();

Procedural Interface

ipworksedi_pop_do_querytotalsize($res);

Remarks

This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the return value of this method is 0. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server.

Reset Method (IPWorksEDI_POP Class)

This method resets all changes and revert back to the state when the user first connected.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_pop_do_reset($res);

Remarks

This method is used to reset all changes and revert back to the state when the user first connected. Asks the MailServer to reset all changes and revert back to the state it was when connected.

Retrieve Method (IPWorksEDI_POP Class)

This method retrieves a message specified by MessageNumber from the server.

Object Oriented Interface

public function doRetrieve();

Procedural Interface

ipworksedi_pop_do_retrieve($res);

Remarks

This method is used to retrieve a message specified by MessageNumber from the server. It asks the MailServer to retrieve the message specified by MessageNumber. The message headers will arrive in the Header event, and the message text will arrive in the Transfer event.

The MaxLines property defines the number of lines retrieved.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve()

RetrieveHeaders Method (IPWorksEDI_POP Class)

This method retrieves headers for a message specified by MessageNumber .

Object Oriented Interface

public function doRetrieveHeaders();

Procedural Interface

ipworksedi_pop_do_retrieveheaders($res);

Remarks

Calling this method will retrieve the headers for the message specified by the MessageNumber property. The message headers will be provided by the Header event and also stored in the MessageHeaders property.

Example. Connect and Retrieve Message Headers:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders()

SendCommand Method (IPWorksEDI_POP Class)

Sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

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

ConnectionStatus Event (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksedi_pop_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_POP Class)

This event is fired when the message completes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

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

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the message body completes transferring from the server to the local host.

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

Error Event (IPWorksEDI_POP Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Header Event (IPWorksEDI_POP Class)

This event is fired for every message header being retrieved.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 4, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

MessageList Event (IPWorksEDI_POP Class)

This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Object Oriented Interface

public function fireMessageList($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 5, array($this, 'fireMessageList'));

Parameter List

 'messagenumber'
 'messageuid'
 'messagesize'

Remarks

When ListMessageSizes is called, MessageSize is valid, and MessageUID is always an empty string.

When ListMessageUIDs is called, MessageUID is valid, and MessageSize is 0.

PITrail Event (IPWorksEDI_POP Class)

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

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 6, 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_POP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 7, 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_POP Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 8, 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_POP Class)

This event is fired when the message starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 9, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the message body starts transferring from the server to the local host.

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

Transfer Event (IPWorksEDI_POP Class)

This event is fired when the message is transferred from MailServer .

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_pop_register_callback($res, 10, array($this, 'fireTransfer'));

Parameter List

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

Remarks

The Text parameter contains the portion of the message data to be retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), BytesTransferred equals the value of the MessageSize property.

The Transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress rather than to get the actual data.

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.

Note: For the PercentDone parameter value to be correct, the GetMessageSize configuration setting must be set to True.

Config Settings (POP Class)

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

POP Errors

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

TCPClient Errors

TCP/IP Errors