Docs

IPWorks 2022 PHP Edition

Version 22.0 [Build 8171]

IMAP Class

Properties   Methods   Events   Configuration Settings   Errors  

The IMAP Class is used to communicate with IMAP servers using the IMAP (Internet Message Access) protocol.

Class Name

IPWorks_IMAP

Procedural Interface

 ipworks_imap_open();
 ipworks_imap_close($res);
 ipworks_imap_register_callback($res, $id, $function);
 ipworks_imap_get_last_error($res);
 ipworks_imap_get_last_error_code($res);
 ipworks_imap_set($res, $id, $index, $value);
 ipworks_imap_get($res, $id, $index);
 ipworks_imap_do_addmessageflags($res, $flags);

 ipworks_imap_do_appendtomailbox($res);

 ipworks_imap_do_checkmailbox($res);

 ipworks_imap_do_closemailbox($res);

 ipworks_imap_do_config($res, $configurationstring);

 ipworks_imap_do_connect($res);

 ipworks_imap_do_copytomailbox($res);

 ipworks_imap_do_createmailbox($res);

 ipworks_imap_do_deletefrommailbox($res);

 ipworks_imap_do_deletemailbox($res);

 ipworks_imap_do_deletemailboxacl($res, $user);

 ipworks_imap_do_disconnect($res);

 ipworks_imap_do_doevents($res);

 ipworks_imap_do_examinemailbox($res);

 ipworks_imap_do_expungemailbox($res);

 ipworks_imap_do_fetchmessageheaders($res);

 ipworks_imap_do_fetchmessageinfo($res);

 ipworks_imap_do_fetchmessagepart($res, $partid);

 ipworks_imap_do_fetchmessagepartheaders($res, $partid);

 ipworks_imap_do_fetchmessagetext($res);

 ipworks_imap_do_getmailboxacl($res);

 ipworks_imap_do_interrupt($res);

 ipworks_imap_do_listmailboxes($res);

 ipworks_imap_do_listsubscribedmailboxes($res);

 ipworks_imap_do_localizedate($res, $datetime);

 ipworks_imap_do_movetomailbox($res);

 ipworks_imap_do_noop($res);

 ipworks_imap_do_renamemailbox($res, $newname);

 ipworks_imap_do_reset($res);

 ipworks_imap_do_resetmessageflags($res);

 ipworks_imap_do_searchmailbox($res, $searchcriteria);

 ipworks_imap_do_selectmailbox($res);

 ipworks_imap_do_sendcommand($res, $command);

 ipworks_imap_do_setmailboxacl($res, $user, $rights);

 ipworks_imap_do_startidle($res);

 ipworks_imap_do_stopidle($res);

 ipworks_imap_do_subscribemailbox($res);

 ipworks_imap_do_unsetmessageflags($res);

 ipworks_imap_do_unsubscribemailbox($res);

Remarks

The IMAP Class supports both plaintext and 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 IMAP Class implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

The first step in using the class is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.

Normally, after connecting to the server a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the class's methods. The primary arguments for most commands are the Mailbox property and the MessageSet property. The MessageSet property denotes either a single message, or a range of messages. Other arguments are specified through other properties such as SortCriteria, MessageFlags, etc.

Responses are received through events such as MessageInfo, MailboxList, and also reflected to properties such as MessageText, MessageSubject, etc.

The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.

The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AuthMechanismThe authentication mechanism to be used when connecting to the mail server.
AutoDecodePartsDetermines whether to automatically decode message parts.
ConnectedShows whether the class is connected.
EndByteThe byte index of the position where the transfer should end.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the class.
LastReplyThe last reply from the server.
LocalFileThe path to a local file for downloading the message body. If the file exists, it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailboxName of the mailbox selected on the server.
MailboxFlagsDefines flags in the selected mailbox.
MailboxListCountThe number of records in the MailboxList arrays.
MailboxListFlagsThe mailbox flags in a mailbox listing.
MailboxListNameThe mailbox name in a mailbox listing.
MailboxListSeparatorThe Separator property contains the character that separates the different parts in the mailbox path hierarchy.
MailPortThe port of the IMAP server (default is 143).
MailServerThe name or address of the mail server (IMAP server).
MessageProvides the raw message content.
MessageContentEncodingThe ContentEncoding of the selected message.
MessageContentTypeThe ContentType of the message.
MessageCountThe total number of messages on the Mailbox .
MessageDateThe time the message was created.
MessageDeliveryTimeThe time the message was delivered to the mail server.
MessageFlagsContains the flags of the current message.
MessageFromThe address of the author of the message.
MessageHeaderCountThe number of records in the MessageHeader arrays.
MessageHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
MessageHeaderValueThis property contains the header contents.
MessageHeadersStringString version of RFC822-encoded headers of the message.
MessageIdThe message identifier of the current message.
MessageInfoCountThe number of records in the MessageInfo arrays.
MessageInfoDateThe date of a message in a message info listing.
MessageInfoFlagsMessage flag in a message info listing.
MessageInfoFromThe sender of a message in a message info listing.
MessageInfoMessageIdThe unique identifier of a message in a message info listing.
MessageInfoSizeThe size of a message in a message info listing.
MessageInfoSubjectThe subject of a message in a message info listing.
MessageInReplyToThe unique message identifier of the message this one is in reply to.
MessageNetIdThe globally unique identifier of the message.
MessagePartCountThe number of records in the MessagePart arrays.
MessagePartContentDispositionThis property shows the value of the Content-Disposition header of the message part.
MessagePartContentEncodingThis property shows how the data is encoded.
MessagePartContentIdThis property shows the value of the Content-Id header of the message part.
MessagePartContentTypeThis property shows the type of data contained in the message part.
MessagePartFilenameThis property shows the filename corresponding to the part (if the part was included in the message as an attached file).
MessagePartIdThis property contains the identifier of a part listing which may be identified in other parts or messages.
MessagePartMultipartModeThis property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.
MessagePartParametersThis property contains the additional parameters passed to the ContentType header such as the part charset etc.
MessagePartSizeThis property contains the size of a part in a message part listing.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
MessageReplyToEmail address(s) where replies to the message should be sent.
MessageSenderThe address of the sender of the message.
MessageSetThe set of messages to operate on.
MessageSizeThe size of the selected message.
MessageSubjectThe subject of the message.
MessageTextThe body of the retrieved message.
OverwriteIndicates whether or not the class should overwrite files during transfer.
PasswordThe password used to authenticate to the MailServer .
PeekModeWhen set to True, the message Seen flag is not changed during reading.
RecentMessageCountNumber of new messages in the Mailbox .
SortCriteriaSorts criteria to use for message retrieval operations.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderTBD.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLStartModeDetermines how the class starts the SSL negotiation.
StartByteThe byte index of the position where the transfer should start.
TimeoutA timeout for the class.
UIDModeIf true, permanent message identifiers are used instead of the default temporary identifiers.
UIDValidityThe UIDValidity parameter sent from the server in response to SelectMailbox command.
UserThe user name used to authenticate to the MailServer .

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddMessageFlagsAdds the specified flags to the messages specified by MessageSet .
AppendToMailboxAppends the message in MessageText to the mailbox specified by Mailbox .
CheckMailboxSends a 'CHECK' command to the server.
CloseMailboxRemoves all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox.
ConfigSets or retrieves a configuration setting.
ConnectConnects to an IMAP server.
CopyToMailboxCopies the messages specified by MessageSet to the mailbox specified by Mailbox .
CreateMailboxCreates a new mailbox specified by Mailbox .
DeleteFromMailboxMarks the messages specified by MessageSet as deleted.
DeleteMailboxDeletes a mailbox specified by Mailbox .
DeleteMailboxACLDeletes mailbox access control rights for a specific user.
DisconnectDisconnects from an IMAP server.
DoEventsProcesses events from the internal message queue.
ExamineMailboxSelects a Mailbox (Read-only mode).
ExpungeMailboxRemoves all messages marked with 'Deleted' flag from the currently selected mailbox.
FetchMessageHeadersRetrieves the message headers of messages specified by the MessageSet property.
FetchMessageInfoRetrieves information about messages specified by the MessageSet property.
FetchMessagePartRetrieves the message part specified by PartID.
FetchMessagePartHeadersRetrieves the headers of message part specified by PartID.
FetchMessageTextRetrieves the message text of messages specified by the MessageSet property.
GetMailboxACLRetrieves mailbox access control rights.
InterruptInterrupt the current method.
ListMailboxesLists all mailboxes matching all criteria in the Mailbox property.
ListSubscribedMailboxesLists all subscribed mailboxes matching all criteria in the Mailbox property.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
MoveToMailboxMoves the messages specified by MessageSet to the mailbox specified by Mailbox .
NoopSends a 'NOOP' command to the server.
RenameMailboxChange the name of Mailbox to NewName .
ResetReset the class.
ResetMessageFlagsReplaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
SearchMailboxSearch selected mailbox for specified text.
SelectMailboxSelect a Mailbox.
SendCommandSends the exact command directly to the server.
SetMailboxACLSets mailbox access control rights for a specific user.
StartIdleBegins idling.
StopIdleStops idling.
SubscribeMailboxSubscribes to the mailbox specified by Mailbox .
UnsetMessageFlagsRemoves the flags specified by MessageFlags from the messages specified by MessageSet .
UnsubscribeMailboxUnsubscribes from the mailbox specified by Mailbox .

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.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message or the part data finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
IdleInfoFires whenever responses from the server are received while idling.
MailboxACLFires for each set of access control rights returned by the server.
MailboxListFired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
MessageInfoFired with information for the message(s) retrieved by the server.
MessagePartFired for each message part when FetchMessageInfo is called.
PITrailTraces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the message or the part data starts transferring.
TransferFired while the message gets transferred from the MailServer .

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AlwaysReturnUIDsInstructs the server to return UIDs even if not in UIDMode.
AppendToMailboxDateTimeSpecifies the date-time parameter used in the initial APPEND request.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubjectInstructs the class to automatically decode message subjects.
AutoDecodeTextWhether to decode MessageText when AutoDecodeParts is True.
FetchAfterSearchDetermines if messages matching the SearchCriteria are fetched after calling SearchMailbox.
FetchTextAndHeadersSpecifies whether the message body and headers are fetched in a single request.
IncludeHeadersInstructs the class to include the headers in the LocalFile.
MaskSensitiveWhether sensitive properties should be masked when logging.
SendIDCommandInstructs class to send the ID command if the server advertises support for it.
UTF7MailboxNamesSpecifies whether or not to automatically encode and decode UTF-7 mailbox names.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13ProviderThe TLS 1.3 implementation to be used.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AuthMechanism Property (IPWorks_IMAP Class)

The authentication mechanism to be used when connecting to the mail server.

Object Oriented Interface


public function getAuthMechanism();


public function setAuthMechanism($value);

Procedural Interface


ipworks_imap_get($res, 1 );


ipworks_imap_set($res, 1, $value );

Default Value

0

Remarks

Auth Mechanism Description
0 (amUserPassword - Default) A user/password pair is sent in plaintext to login. (Default)
1 (amCRAMMD5) CRAM-MD5 authentication.
2 (amNTLM) NTLM authentication.
4 (amSASLPlain) SASLPlain. Note, that servers will often require SSL be used when this authentication mechanism is requested. See AuthorizationIdentity.
5 (amSASLDigestMD5) SASLDigestMD5. See AuthorizationIdentity.
6 (amKerberos) Kerberos authentication. This option is available in Windows or other platforms when using the Java edition.
7 (mXOAUTH) XOAUTH2 authentication. See AuthorizationIdentity.

Data Type

Integer

AutoDecodeParts Property (IPWorks_IMAP Class)

Determines whether to automatically decode message parts.

Object Oriented Interface


public function getAutoDecodeParts();


public function setAutoDecodeParts($value);

Procedural Interface


ipworks_imap_get($res, 2 );


ipworks_imap_set($res, 2, $value );

Default Value

false

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

Data Type

Boolean

Connected Property (IPWorks_IMAP Class)

Shows whether the class is connected.

Object Oriented Interface


public function getConnected();


public function setConnected($value);

Procedural Interface


ipworks_imap_get($res, 4 );


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

EndByte Property (IPWorks_IMAP Class)

The byte index of the position where the transfer should end.

Object Oriented Interface


public function getEndByte();


public function setEndByte($value);

Procedural Interface


ipworks_imap_get($res, 5 );


ipworks_imap_set($res, 5, $value );

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message part to be retrieved from the server.

When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

FirewallAutoDetect Property (IPWorks_IMAP 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


ipworks_imap_get($res, 6 );


ipworks_imap_set($res, 6, $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 (IPWorks_IMAP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


ipworks_imap_get($res, 7 );


ipworks_imap_set($res, 7, $value );

Default Value

0

Remarks

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (IPWorks_IMAP Class)

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

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


ipworks_imap_get($res, 8 );


ipworks_imap_set($res, 8, $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 (IPWorks_IMAP 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


ipworks_imap_get($res, 9 );


ipworks_imap_set($res, 9, $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 (IPWorks_IMAP Class)

This property contains the TCP port for the firewall Host .

Object Oriented Interface


public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface


ipworks_imap_get($res, 10 );


ipworks_imap_set($res, 10, $value );

Default Value

0

Remarks

This property contains the TCP port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note that 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 (IPWorks_IMAP 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


ipworks_imap_get($res, 11 );


ipworks_imap_set($res, 11, $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 (IPWorks_IMAP Class)

The current status of the class.

Object Oriented Interface


public function getIdle();


Procedural Interface


ipworks_imap_get($res, 12 );


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

LastReply Property (IPWorks_IMAP Class)

The last reply from the server.

Object Oriented Interface


public function getLastReply();


Procedural Interface


ipworks_imap_get($res, 13 );


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

The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).

Object Oriented Interface


public function getLocalFile();


public function setLocalFile($value);

Procedural Interface


ipworks_imap_get($res, 14 );


ipworks_imap_set($res, 14, $value );

Default Value

''

Remarks

This property is used when retrieving a message.

If this property is empty then the received data is provided through the parameters of the Transfer event.

Data Type

String

LocalHost Property (IPWorks_IMAP 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_imap_get($res, 15 );


ipworks_imap_set($res, 15, $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

Mailbox Property (IPWorks_IMAP Class)

Name of the mailbox selected on the server.

Object Oriented Interface


public function getMailbox();


public function setMailbox($value);

Procedural Interface


ipworks_imap_get($res, 16 );


ipworks_imap_set($res, 16, $value );

Default Value

'Inbox'

Remarks

This method contains the name of the mailbox selected on the server, and is also used as argument to most methods. Please refer to the class methods for more information.

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

Data Type

String

MailboxFlags Property (IPWorks_IMAP Class)

Defines flags in the selected mailbox.

Object Oriented Interface


public function getMailboxFlags();


Procedural Interface


ipworks_imap_get($res, 17 );


Default Value

''

Remarks

This method defines flags in the selected mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

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

Data Type

String

MailboxListCount Property (IPWorks_IMAP Class)

The number of records in the MailboxList arrays.

Object Oriented Interface


public function getMailboxListCount();


Procedural Interface


ipworks_imap_get($res, 18 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MailboxListFlags Property (IPWorks_IMAP Class)

The mailbox flags in a mailbox listing.

Object Oriented Interface


public function getMailboxListFlags($mailboxlistindex);


Procedural Interface


ipworks_imap_get($res, 19 , $mailboxlistindex);


Default Value

''

Remarks

The mailbox flags in a mailbox listing.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

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

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

Data Type

String

MailboxListName Property (IPWorks_IMAP Class)

The mailbox name in a mailbox listing.

Object Oriented Interface


public function getMailboxListName($mailboxlistindex);


Procedural Interface


ipworks_imap_get($res, 20 , $mailboxlistindex);


Default Value

''

Remarks

The mailbox name in a mailbox listing.

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

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

Data Type

String

MailboxListSeparator Property (IPWorks_IMAP Class)

The Separator property contains the character that separates the different parts in the mailbox path hierarchy.

Object Oriented Interface


public function getMailboxListSeparator($mailboxlistindex);


Procedural Interface


ipworks_imap_get($res, 21 , $mailboxlistindex);


Default Value

''

Remarks

The MailboxListSeparator property contains the character that separates the different parts in the mailbox path hierarchy.

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

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

Data Type

String

MailPort Property (IPWorks_IMAP Class)

The port of the IMAP server (default is 143).

Object Oriented Interface


public function getMailPort();


public function setMailPort($value);

Procedural Interface


ipworks_imap_get($res, 22 );


ipworks_imap_set($res, 22, $value );

Default Value

143

Remarks

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 993 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (IPWorks_IMAP Class)

The name or address of the mail server (IMAP server).

Object Oriented Interface


public function getMailServer();


public function setMailServer($value);

Procedural Interface


ipworks_imap_get($res, 23 );


ipworks_imap_set($res, 23, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the mail server. It must be 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, the MailServer 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 (IPWorks_IMAP Class)

Provides the raw message content.

Object Oriented Interface


public function getMessage();


public function setMessage($value);

Procedural Interface


ipworks_imap_get($res, 24 );


ipworks_imap_set($res, 24, $value );

Default Value

''

Remarks

This property is populated after calling FetchMessagePart 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 not available at design time.

Data Type

Binary String

MessageContentEncoding Property (IPWorks_IMAP Class)

The ContentEncoding of the selected message.

Object Oriented Interface


public function getMessageContentEncoding();


Procedural Interface


ipworks_imap_get($res, 25 );


Default Value

''

Remarks

The property is automatically set by the class when message information is retrieved via the FetchMessageInfo method.

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

Data Type

String

MessageContentType Property (IPWorks_IMAP Class)

The ContentType of the message.

Object Oriented Interface


public function getMessageContentType();


Procedural Interface


ipworks_imap_get($res, 26 );


Default Value

''

Remarks

This property denotes the type of content contained in the message, such as plain, multipart, multipart/alternative etc. You may also need to check the MessageContentEncoding property or read the individual message parts.

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

Data Type

String

MessageCount Property (IPWorks_IMAP Class)

The total number of messages on the Mailbox .

Object Oriented Interface


public function getMessageCount();


Procedural Interface


ipworks_imap_get($res, 27 );


Default Value

0

Remarks

This property contains the total number of messages on the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

MessageDate Property (IPWorks_IMAP Class)

The time the message was created.

Object Oriented Interface


public function getMessageDate();


Procedural Interface


ipworks_imap_get($res, 28 );


Default Value

''

Remarks

This property contains the date and time when the message was created. This value is taken from the ENVELOPE structure of the message corresponding to the date.

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

Data Type

String

MessageDeliveryTime Property (IPWorks_IMAP Class)

The time the message was delivered to the mail server.

Object Oriented Interface


public function getMessageDeliveryTime();


Procedural Interface


ipworks_imap_get($res, 29 );


Default Value

''

Remarks

This property contains the time the message was delivered to the mail server. This value is taken from the INTERNALDATE property of the message. The time format is defined in RFC821.

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

Data Type

String

MessageFlags Property (IPWorks_IMAP Class)

Contains the flags of the current message.

Object Oriented Interface


public function getMessageFlags();


public function setMessageFlags($value);

Procedural Interface


ipworks_imap_get($res, 30 );


ipworks_imap_set($res, 30, $value );

Default Value

''

Remarks

This property contains the flags of the current message. It is also used to specify flags when AppendToMailbox is called.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

Example (Setting MessageFlags)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

This property is not available at design time.

Data Type

String

MessageFrom Property (IPWorks_IMAP Class)

The address of the author of the message.

Object Oriented Interface


public function getMessageFrom();


Procedural Interface


ipworks_imap_get($res, 31 );


Default Value

''

Remarks

This property normally has the same value as MessageSender.

There are cases when a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property separated by commas.

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

Data Type

String

MessageHeaderCount Property (IPWorks_IMAP Class)

The number of records in the MessageHeader arrays.

Object Oriented Interface


public function getMessageHeaderCount();


public function setMessageHeaderCount($value);

Procedural Interface


ipworks_imap_get($res, 32 );


ipworks_imap_set($res, 32, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (IPWorks_IMAP Class)

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

Object Oriented Interface


public function getMessageHeaderField($messageheaderindex);


public function setMessageHeaderField($messageheaderindex, $value);

Procedural Interface


ipworks_imap_get($res, 33 , $messageheaderindex);


ipworks_imap_set($res, 33, $value , $messageheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (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 not available at design time.

Data Type

String

MessageHeaderValue Property (IPWorks_IMAP Class)

This property contains the header contents.

Object Oriented Interface


public function getMessageHeaderValue($messageheaderindex);


public function setMessageHeaderValue($messageheaderindex, $value);

Procedural Interface


ipworks_imap_get($res, 34 , $messageheaderindex);


ipworks_imap_set($res, 34, $value , $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 not available at design time.

Data Type

String

MessageHeadersString Property (IPWorks_IMAP Class)

String version of RFC822-encoded headers of the message.

Object Oriented Interface


public function getMessageHeadersString();


public function setMessageHeadersString($value);

Procedural Interface


ipworks_imap_get($res, 35 );


ipworks_imap_set($res, 35, $value );

Default Value

''

Remarks

This property contains the full headers of the message in RFC822 format. The headers are retrieved by calling the FetchMessageHeaders or the FetchMessagePartHeaders method.

This property is not available at design time.

Data Type

String

MessageId Property (IPWorks_IMAP Class)

The message identifier of the current message.

Object Oriented Interface


public function getMessageId();


Procedural Interface


ipworks_imap_get($res, 36 );


Default Value

''

Remarks

The class fills out this property when message information is retrieved from the MailServer.

The id is permanent if UIDMode is set, and temporary otherwise.

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

Data Type

String

MessageInfoCount Property (IPWorks_IMAP Class)

The number of records in the MessageInfo arrays.

Object Oriented Interface


public function getMessageInfoCount();


Procedural Interface


ipworks_imap_get($res, 37 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MessageInfoDate Property (IPWorks_IMAP Class)

The date of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoDate($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 38 , $messageinfoindex);


Default Value

''

Remarks

The date of a message in a message info listing. This date is taken from the ENVELOPE structure of the message.

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

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

Data Type

String

MessageInfoFlags Property (IPWorks_IMAP Class)

Message flag in a message info listing.

Object Oriented Interface


public function getMessageInfoFlags($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 39 , $messageinfoindex);


Default Value

''

Remarks

Message flag in a message info listing.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

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

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

Data Type

String

MessageInfoFrom Property (IPWorks_IMAP Class)

The sender of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoFrom($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 40 , $messageinfoindex);


Default Value

''

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoMessageId Property (IPWorks_IMAP Class)

The unique identifier of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoMessageId($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 41 , $messageinfoindex);


Default Value

''

Remarks

The unique identifier of a message in a message info listing.

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

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

Data Type

String

MessageInfoSize Property (IPWorks_IMAP Class)

The size of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoSize($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 42 , $messageinfoindex);


Default Value

0

Remarks

The size of a message in a message info listing.

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

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

Data Type

Long64

MessageInfoSubject Property (IPWorks_IMAP Class)

The subject of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoSubject($messageinfoindex);


Procedural Interface


ipworks_imap_get($res, 43 , $messageinfoindex);


Default Value

''

Remarks

The subject of a message in a message info listing.

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

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

Data Type

String

MessageInReplyTo Property (IPWorks_IMAP Class)

The unique message identifier of the message this one is in reply to.

Object Oriented Interface


public function getMessageInReplyTo();


Procedural Interface


ipworks_imap_get($res, 44 );


Default Value

''

Remarks

The class fills out this property with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message you are replying to.

The unique message identifier of the message itself is given by the MessageNetId property.

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

Data Type

String

MessageNetId Property (IPWorks_IMAP Class)

The globally unique identifier of the message.

Object Oriented Interface


public function getMessageNetId();


Procedural Interface


ipworks_imap_get($res, 45 );


Default Value

''

Remarks

This property contains the globally unique identifier of the message. The class fills the MessageNetId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

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

Data Type

String

MessagePartCount Property (IPWorks_IMAP Class)

The number of records in the MessagePart arrays.

Object Oriented Interface


public function getMessagePartCount();


Procedural Interface


ipworks_imap_get($res, 46 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MessagePartContentDisposition Property (IPWorks_IMAP Class)

This property shows the value of the Content-Disposition header of the message part.

Object Oriented Interface


public function getMessagePartContentDisposition($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 47 , $messagepartindex);


Default Value

''

Remarks

This property shows the value of the Content-Disposition header of the message part.

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

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

Data Type

String

MessagePartContentEncoding Property (IPWorks_IMAP Class)

This property shows how the data is encoded.

Object Oriented Interface


public function getMessagePartContentEncoding($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 48 , $messagepartindex);


Default Value

''

Remarks

This property shows how the data is encoded.

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

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

Data Type

String

MessagePartContentId Property (IPWorks_IMAP Class)

This property shows the value of the Content-Id header of the message part.

Object Oriented Interface


public function getMessagePartContentId($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 49 , $messagepartindex);


Default Value

''

Remarks

This property shows the value of the Content-Id header of the message part.

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

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

Data Type

String

MessagePartContentType Property (IPWorks_IMAP Class)

This property shows the type of data contained in the message part.

Object Oriented Interface


public function getMessagePartContentType($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 50 , $messagepartindex);


Default Value

''

Remarks

This property shows the type of data contained in the message part.

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

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

Data Type

String

MessagePartFilename Property (IPWorks_IMAP Class)

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

Object Oriented Interface


public function getMessagePartFilename($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 51 , $messagepartindex);


Default Value

''

Remarks

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

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

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

Data Type

String

MessagePartId Property (IPWorks_IMAP Class)

This property contains the identifier of a part listing which may be identified in other parts or messages.

Object Oriented Interface


public function getMessagePartId($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 52 , $messagepartindex);


Default Value

''

Remarks

This property contains the identifier of a part listing which may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

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

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

Data Type

String

MessagePartMultipartMode Property (IPWorks_IMAP Class)

This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.

Object Oriented Interface


public function getMessagePartMultipartMode($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 53 , $messagepartindex);


Default Value

''

Remarks

This property shows how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.).

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

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

Data Type

String

MessagePartParameters Property (IPWorks_IMAP Class)

This property contains the additional parameters passed to the ContentType header such as the part charset etc.

Object Oriented Interface


public function getMessagePartParameters($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 54 , $messagepartindex);


Default Value

''

Remarks

This property contains the additional parameters passed to the ContentType header such as the part charset etc.

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

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

Data Type

String

MessagePartSize Property (IPWorks_IMAP Class)

This property contains the size of a part in a message part listing.

Object Oriented Interface


public function getMessagePartSize($messagepartindex);


Procedural Interface


ipworks_imap_get($res, 55 , $messagepartindex);


Default Value

0

Remarks

This property contains the size of a part in a message part listing.

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

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

Data Type

Long64

MessageRecipientCount Property (IPWorks_IMAP Class)

The number of records in the MessageRecipient arrays.

Object Oriented Interface


public function getMessageRecipientCount();


Procedural Interface


ipworks_imap_get($res, 56 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property contains the email address of the recipient.

Object Oriented Interface


public function getMessageRecipientAddress($recipientindex);


Procedural Interface


ipworks_imap_get($res, 57 , $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 (IPWorks_IMAP Class)

This property contains name of the recipient.

Object Oriented Interface


public function getMessageRecipientName($recipientindex);


Procedural Interface


ipworks_imap_get($res, 58 , $recipientindex);


Default Value

''

Remarks

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

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

Object Oriented Interface


public function getMessageRecipientOptions($recipientindex);


Procedural Interface


ipworks_imap_get($res, 59 , $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 (IPWorks_IMAP Class)

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

Object Oriented Interface


public function getMessageRecipientType($recipientindex);


Procedural Interface


ipworks_imap_get($res, 60 , $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 (IPWorks_IMAP Class)

Email address(s) where replies to the message should be sent.

Object Oriented Interface


public function getMessageReplyTo();


Procedural Interface


ipworks_imap_get($res, 61 );


Default Value

''

Remarks

This property contains the email address(s) where replies to the message should be sent. There are cases when a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property separated by commas.

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

Data Type

String

MessageSender Property (IPWorks_IMAP Class)

The address of the sender of the message.

Object Oriented Interface


public function getMessageSender();


Procedural Interface


ipworks_imap_get($res, 62 );


Default Value

''

Remarks

This property contains the address of the sender of the message. Which is normally the same value as MessageFrom.

There are cases when a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property separated by commas.

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

Data Type

String

MessageSet Property (IPWorks_IMAP Class)

The set of messages to operate on.

Object Oriented Interface


public function getMessageSet();


public function setMessageSet($value);

Procedural Interface


ipworks_imap_get($res, 63 );


ipworks_imap_set($res, 63, $value );

Default Value

''

Remarks

This property indicates the set of messages to operate on. Used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example (Setting MessageSet)

IMAPControl.MessageSet = "1" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.FetchMessageInfo()

Data Type

String

MessageSize Property (IPWorks_IMAP Class)

The size of the selected message.

Object Oriented Interface


public function getMessageSize();


Procedural Interface


ipworks_imap_get($res, 64 );


Default Value

0

Remarks

The class fills out this property with the size of the selected message when message information is retrieved from the MailServer.

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

Data Type

Long64

MessageSubject Property (IPWorks_IMAP Class)

The subject of the message.

Object Oriented Interface


public function getMessageSubject();


Procedural Interface


ipworks_imap_get($res, 65 );


Default Value

''

Remarks

The class fills out this property with the subject of the message when message information is retrieved from the MailServer.

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

Data Type

String

MessageText Property (IPWorks_IMAP Class)

The body of the retrieved message.

Object Oriented Interface


public function getMessageText();


public function setMessageText($value);

Procedural Interface


ipworks_imap_get($res, 66 );


ipworks_imap_set($res, 66, $value );

Default Value

''

Remarks

The class fills out this property with the contents of the message body (in RFC822 format) when a call to FetchMessageText completes successfully.

This property is not available at design time.

Data Type

String

Overwrite Property (IPWorks_IMAP Class)

Indicates whether or not the class should overwrite files during transfer.

Object Oriented Interface


public function getOverwrite();


public function setOverwrite($value);

Procedural Interface


ipworks_imap_get($res, 67 );


ipworks_imap_set($res, 67, $value );

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite files when downloading the message text or a message part and LocalFile is set. If Overwrite is false, an error will be thrown whenever LocalFile exists.

Data Type

Boolean

Password Property (IPWorks_IMAP Class)

The password used to authenticate to the MailServer .

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


ipworks_imap_get($res, 68 );


ipworks_imap_set($res, 68, $value );

Default Value

''

Remarks

This property contains the password used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

PeekMode Property (IPWorks_IMAP Class)

When set to True, the message Seen flag is not changed during reading.

Object Oriented Interface


public function getPeekMode();


public function setPeekMode($value);

Procedural Interface


ipworks_imap_get($res, 69 );


ipworks_imap_set($res, 69, $value );

Default Value

false

Remarks

This property contains a true or false to determine whether or not this message should be seen. When this property is set to True, a "PEEK" option is added to all IMAP FETCH commands sent to the server. An RFC compliant IMAP server should not set the "Seen" flag on the message in this case.

This property is not available at design time.

Data Type

Boolean

RecentMessageCount Property (IPWorks_IMAP Class)

Number of new messages in the Mailbox .

Object Oriented Interface


public function getRecentMessageCount();


Procedural Interface


ipworks_imap_get($res, 70 );


Default Value

0

Remarks

This property contains the number of new messages that are in the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

SortCriteria Property (IPWorks_IMAP Class)

Sorts criteria to use for message retrieval operations.

Object Oriented Interface


public function getSortCriteria();


public function setSortCriteria($value);

Procedural Interface


ipworks_imap_get($res, 71 );


ipworks_imap_set($res, 71, $value );

Default Value

''

Remarks

This property sorts criteria to use for message retrieval operations. When set, the class will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the fetch operation will be sorted according to SortCriteria. The format of the SortCriteria property consists of a parenthesized list of one or more sort keys.

Example (Setting SortCriteria)

IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT"

Possible sort keys include:

ARRIVALInternal date and time of the message.
DATEThe value of the message's DATE header, adjusted by time zone
CC The value of the message's CC header.
FROM The value of the message's FROM header.
SUBJECT The value of the message's SUBJECT header.
TO The value of the message's TO header.
SIZEThe size of the message
REVERSE <criterion>Followed by another sort criterion, has the effect of that criterion but in reverse (descending) order

Please note that IMAP SORT functionality is relatively new and not all servers may implement it.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_IMAP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


ipworks_imap_get($res, 73 );


ipworks_imap_set($res, 73, $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 (IPWorks_IMAP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


ipworks_imap_get($res, 101 );


ipworks_imap_set($res, 101, $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 (IPWorks_IMAP 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


ipworks_imap_get($res, 117 );


ipworks_imap_set($res, 117, $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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_IMAP 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


ipworks_imap_get($res, 118 );


ipworks_imap_set($res, 118, $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 (IPWorks_IMAP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


ipworks_imap_get($res, 119 );


ipworks_imap_set($res, 119, $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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (IPWorks_IMAP Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


ipworks_imap_get($res, 120 );


ipworks_imap_set($res, 120, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLEnabled Property (IPWorks_IMAP Class)

Whether TLS/SSL is enabled.

Object Oriented Interface


public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface


ipworks_imap_get($res, 128 );


ipworks_imap_set($res, 128, $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 (IPWorks_IMAP Class)

TBD.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


ipworks_imap_get($res, 129 );


ipworks_imap_set($res, 129, $value );

Default Value

0

Remarks

TBD.

Data Type

Integer

SSLServerCertEncoded Property (IPWorks_IMAP Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


ipworks_imap_get($res, 131 );


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

Determines how the class starts the SSL negotiation.

Object Oriented Interface


public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface


ipworks_imap_get($res, 158 );


ipworks_imap_set($res, 158, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic)If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer

StartByte Property (IPWorks_IMAP Class)

The byte index of the position where the transfer should start.

Object Oriented Interface


public function getStartByte();


public function setStartByte($value);

Procedural Interface


ipworks_imap_get($res, 159 );


ipworks_imap_set($res, 159, $value );

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message part to be retrieved from the server.

When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

Timeout Property (IPWorks_IMAP Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


ipworks_imap_get($res, 160 );


ipworks_imap_set($res, 160, $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

UIDMode Property (IPWorks_IMAP Class)

If true, permanent message identifiers are used instead of the default temporary identifiers.

Object Oriented Interface


public function getUIDMode();


public function setUIDMode($value);

Procedural Interface


ipworks_imap_get($res, 161 );


ipworks_imap_set($res, 161, $value );

Default Value

false

Remarks

This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is true, permanent message identifiers are used instead.

The IMAP protocol operations where UID mode is used are the following: COPY, FETCH, STORE, SEARCH.

This property is not available at design time.

Data Type

Boolean

UIDValidity Property (IPWorks_IMAP Class)

The UIDValidity parameter sent from the server in response to SelectMailbox command.

Object Oriented Interface


public function getUIDValidity();


Procedural Interface


ipworks_imap_get($res, 162 );


Default Value

''

Remarks

Every time a mailbox is selected a UIDValidity is returned from the server. Most of the time this value will not change from call to call. In case it does change, it means that all previously returned UIDs for messages inside this mailbox are now invalid.

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

Data Type

String

User Property (IPWorks_IMAP Class)

The user name used to authenticate to the MailServer .

Object Oriented Interface


public function getUser();


public function setUser($value);

Procedural Interface


ipworks_imap_get($res, 163 );


ipworks_imap_set($res, 163, $value );

Default Value

''

Remarks

This property contains the user name used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

AddMessageFlags Method (IPWorks_IMAP Class)

Adds the specified flags to the messages specified by MessageSet .

Object Oriented Interface

public function doAddMessageFlags($flags);

Procedural Interface

ipworks_imap_do_addmessageflags($res, $flags);

Remarks

This method adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

Example (Setting Adding Message Flags)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

AppendToMailbox Method (IPWorks_IMAP Class)

Appends the message in MessageText to the mailbox specified by Mailbox .

Object Oriented Interface

public function doAppendToMailbox();

Procedural Interface

ipworks_imap_do_appendtomailbox($res);

Remarks

This method appends the RFC822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, it's contents are supplied with the 'APPEND' command sent to the server.

Example (Append Message to Mailbox)

IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox()

CheckMailbox Method (IPWorks_IMAP Class)

Sends a 'CHECK' command to the server.

Object Oriented Interface

public function doCheckMailbox();

Procedural Interface

ipworks_imap_do_checkmailbox($res);

Remarks

This method sends a 'CHECK' command to the server, asking it to perform any necessary 'housekeeping' operations on, and update the state of the currently selected mailbox.

CloseMailbox Method (IPWorks_IMAP Class)

Removes all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox.

Object Oriented Interface

public function doCloseMailbox();

Procedural Interface

ipworks_imap_do_closemailbox($res);

Remarks

This method permanently removes all messages that have the 'Deleted' flag set from the current (selected) mailbox, and then closes (deselect) the mailbox.

Config Method (IPWorks_IMAP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_imap_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 (IPWorks_IMAP Class)

Connects to an IMAP server.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworks_imap_do_connect($res);

Remarks

This method connects to the IMAP server specified by MailServer and authenticates using the user name and password supplied in the User and Password properties.

Example (Connect IMAP Server)

IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect()

CopyToMailbox Method (IPWorks_IMAP Class)

Copies the messages specified by MessageSet to the mailbox specified by Mailbox .

Object Oriented Interface

public function doCopyToMailbox();

Procedural Interface

ipworks_imap_do_copytomailbox($res);

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

CreateMailbox Method (IPWorks_IMAP Class)

Creates a new mailbox specified by Mailbox .

Object Oriented Interface

public function doCreateMailbox();

Procedural Interface

ipworks_imap_do_createmailbox($res);

Remarks

This method creates a new mailbox. The mailbox name is specified by the Mailbox property.

DeleteFromMailbox Method (IPWorks_IMAP Class)

Marks the messages specified by MessageSet as deleted.

Object Oriented Interface

public function doDeleteFromMailbox();

Procedural Interface

ipworks_imap_do_deletefrommailbox($res);

Remarks

This method marks the messages specified by MessageSet as deleted. Calling this method is equivalent to calling AddMessageFlags with "\Deleted" as the Flags parameter.

DeleteMailbox Method (IPWorks_IMAP Class)

Deletes a mailbox specified by Mailbox .

Object Oriented Interface

public function doDeleteMailbox();

Procedural Interface

ipworks_imap_do_deletemailbox($res);

Remarks

This method deletes a mailbox. The mailbox name is specified by the Mailbox property.

DeleteMailboxACL Method (IPWorks_IMAP Class)

Deletes mailbox access control rights for a specific user.

Object Oriented Interface

public function doDeleteMailboxACL($user);

Procedural Interface

ipworks_imap_do_deletemailboxacl($res, $user);

Remarks

This message asks the server to remove all rights associated with User from the mailbox specified in the Mailbox property. Refer to SetMailboxACL and GetMailboxACL for more information on mailbox access rights.

Disconnect Method (IPWorks_IMAP Class)

Disconnects from an IMAP server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworks_imap_do_disconnect($res);

Remarks

This method logs out and disconnects from the IMAP server.

DoEvents Method (IPWorks_IMAP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

ExamineMailbox Method (IPWorks_IMAP Class)

Selects a Mailbox (Read-only mode).

Object Oriented Interface

public function doExamineMailbox();

Procedural Interface

ipworks_imap_do_examinemailbox($res);

Remarks

This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

ExpungeMailbox Method (IPWorks_IMAP Class)

Removes all messages marked with 'Deleted' flag from the currently selected mailbox.

Object Oriented Interface

public function doExpungeMailbox();

Procedural Interface

ipworks_imap_do_expungemailbox($res);

Remarks

This method permanently removes all messages that have the 'Deleted' flag set from the current (selected) mailbox. Example (Set "Deleted" flag and Expunge)

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox()

FetchMessageHeaders Method (IPWorks_IMAP Class)

Retrieves the message headers of messages specified by the MessageSet property.

Object Oriented Interface

public function doFetchMessageHeaders();

Procedural Interface

ipworks_imap_do_fetchmessageheaders($res);

Remarks

This method retrieves RFC822 headers of the message specified by MessageSet and stores them in the MessageHeaders property.

FetchMessageInfo Method (IPWorks_IMAP Class)

Retrieves information about messages specified by the MessageSet property.

Object Oriented Interface

public function doFetchMessageInfo();

Procedural Interface

ipworks_imap_do_fetchmessageinfo($res);

Remarks

This method retrieves information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties such as: MessageSubject, MessageFrom, MessageRecipients, etc. If the message is a multipart message, one or more MessagePart events are fired before the MessageInfo event - one for each message part.

FetchMessagePart Method (IPWorks_IMAP Class)

Retrieves the message part specified by PartID.

Object Oriented Interface

public function doFetchMessagePart($partid);

Procedural Interface

ipworks_imap_do_fetchmessagepart($res, $partid);

Remarks

This method retrieves the contents of the message part specified by the PartId property of the message specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property, as well as provided through the Transfer event.

The part identifiers of each message part (if any) are provided through the corresponding MessagePart events.

FetchMessagePartHeaders Method (IPWorks_IMAP Class)

Retrieves the headers of message part specified by PartID.

Object Oriented Interface

public function doFetchMessagePartHeaders($partid);

Procedural Interface

ipworks_imap_do_fetchmessagepartheaders($res, $partid);

Remarks

This method retrieves RFC822 headers of the message part specified by PartID and stores them in the MessageHeaders property.

FetchMessageText Method (IPWorks_IMAP Class)

Retrieves the message text of messages specified by the MessageSet property.

Object Oriented Interface

public function doFetchMessageText();

Procedural Interface

ipworks_imap_do_fetchmessagetext($res);

Remarks

This method retrieves the RFC822-encoded text of the message specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property, as well as provided through the Transfer event.

GetMailboxACL Method (IPWorks_IMAP Class)

Retrieves mailbox access control rights.

Object Oriented Interface

public function doGetMailboxACL();

Procedural Interface

ipworks_imap_do_getmailboxacl($res);

Remarks

This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL events. Standard rights include:

lLookup (visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep seen/unseen information across sessions
wWrite (Store flags other than SEEN and DELETED)
iInsert (Can be appended, and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Store DELETED flag, perform EXPUNGE)
aAdminister (Set access permissions)

Interrupt Method (IPWorks_IMAP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_imap_do_interrupt($res);

Remarks

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

ListMailboxes Method (IPWorks_IMAP Class)

Lists all mailboxes matching all criteria in the Mailbox property.

Object Oriented Interface

public function doListMailboxes();

Procedural Interface

ipworks_imap_do_listmailboxes($res);

Remarks

This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Example (List All Mailboxes)

IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes()

Example (List All Mailboxes Inside INBOX)

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes()

ListSubscribedMailboxes Method (IPWorks_IMAP Class)

Lists all subscribed mailboxes matching all criteria in the Mailbox property.

Object Oriented Interface

public function doListSubscribedMailboxes();

Procedural Interface

ipworks_imap_do_listsubscribedmailboxes($res);

Remarks

This method lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Example (List All Subscribed Mailboxes)

IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes()

Example (List All Subscribed Mailboxes Inside INBOX)

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes()

LocalizeDate Method (IPWorks_IMAP Class)

Converts a valid RFC 822 message date to local date and time.

Object Oriented Interface

public function doLocalizeDate($datetime);

Procedural Interface

ipworks_imap_do_localizedate($res, $datetime);

Remarks

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

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

MoveToMailbox Method (IPWorks_IMAP Class)

Moves the messages specified by MessageSet to the mailbox specified by Mailbox .

Object Oriented Interface

public function doMoveToMailbox();

Procedural Interface

ipworks_imap_do_movetomailbox($res);

Remarks

This method moves the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

Noop Method (IPWorks_IMAP Class)

Sends a 'NOOP' command to the server.

Object Oriented Interface

public function doNoop();

Procedural Interface

ipworks_imap_do_noop($res);

Remarks

This method sends an IMAP 'NOOP' command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity).

RenameMailbox Method (IPWorks_IMAP Class)

Change the name of Mailbox to NewName .

Object Oriented Interface

public function doRenameMailbox($newname);

Procedural Interface

ipworks_imap_do_renamemailbox($res, $newname);

Remarks

This method allows the renaming of a mailbox. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.

Reset Method (IPWorks_IMAP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_imap_do_reset($res);

Remarks

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

ResetMessageFlags Method (IPWorks_IMAP Class)

Replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Object Oriented Interface

public function doResetMessageFlags();

Procedural Interface

ipworks_imap_do_resetmessageflags($res);

Remarks

This method replaces the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

SearchMailbox Method (IPWorks_IMAP Class)

Search selected mailbox for specified text.

Object Oriented Interface

public function doSearchMailbox($searchcriteria);

Procedural Interface

ipworks_imap_do_searchmailbox($res, $searchcriteria);

Remarks

This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the FetchMessageInfo method is called and a MessageInfo event is fired.

The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include:

<message set>Messages with message sequence numbers corresponding to the specified message sequence number set
ALLAll messages in the mailbox - this is the default initial key for AND-ing.
ANSWEREDMessages with the \Answered flag set.
BCC <string>Messages that contain the specified string in the envelope structure's BCC field.
BEFORE <date>Messages whose internal date is earlier than the specified date.
BODY <string> Messages that contain the specified string in the body of the message.
CC <string> Messages that contain the specified string in the envelope structure's CC field.
DELETED Messages with the \Deleted flag set.
DRAFT Messages with the \Draft flag set.
FLAGGED Messages with the \Flagged flag set.
FROM <string> Messages that contain the specified string in the envelope structure's FROM field.
HEADER <field-name> <string> Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body.
KEYWORD <flag> Messages with the specified keyword set.
LARGER <n> Messages with an RFC822.SIZE larger than the specified number of octets.
NEW Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)".
NOT <search-key> Messages that do not match the specified search key.
OLD Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
ON <date> Messages whose internal date is within the specified date.
OR <search-key1> <search-key2> Messages that match either search key.
RECENT Messages that have the \Recent flag set.
SEEN Messages that have the \Seen flag set.
SENTBEFORE <date> Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON <date> Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE <date> Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE <date> Messages whose internal date is within or later than the specified date.
SMALLER <n> Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT <string> Messages that contain the specified string in the envelope structure's SUBJECT field.
TEXT <string> Messages that contain the specified string in the header or body of the message.
TO <string> Messages that contain the specified string in the envelope structure's TO field.
UID <message set> Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED Messages that do not have the \Answered flag set.
UNDELETED Messages that do not have the \Deleted flag set.
UNDRAFT Messages that do not have the \Draft flag set.
UNFLAGGED Messages that do not have the \Flagged flag set.
UNKEYWORD <flag> Messages that do not have the specified keyword set.
UNSEEN Messages that do not have the \Seen flag set.

SelectMailbox Method (IPWorks_IMAP Class)

Select a Mailbox.

Object Oriented Interface

public function doSelectMailbox();

Procedural Interface

ipworks_imap_do_selectmailbox($res);

Remarks

This method asks the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).

Example (Open a Mailbox in Read/Write Mode)

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example (Open a Mailbox in Read-Only Mode)

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

SendCommand Method (IPWorks_IMAP Class)

Sends the exact command directly to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

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

SetMailboxACL Method (IPWorks_IMAP Class)

Sets mailbox access control rights for a specific user.

Object Oriented Interface

public function doSetMailboxACL($user, $rights);

Procedural Interface

ipworks_imap_do_setmailboxacl($res, $user, $rights);

Remarks

This method changes the access control list for the mailbox specified in the Mailbox property so that User is granted the permissions specified in Rights.

Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.

Standard rights include:

lLookup (visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep seen/unseen information across sessions
wWrite (Store flags other than SEEN and DELETED)
iInsert (Can be appended, and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Store DELETED flag, perform EXPUNGE)
aAdminister (Set access permissions)

StartIdle Method (IPWorks_IMAP Class)

Begins idling.

Object Oriented Interface

public function doStartIdle();

Procedural Interface

ipworks_imap_do_startidle($res);

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling call StopIdle.

If the class is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to make sure incoming events are processed.

StopIdle Method (IPWorks_IMAP Class)

Stops idling.

Object Oriented Interface

public function doStopIdle();

Procedural Interface

ipworks_imap_do_stopidle($res);

Remarks

This method stops idling if it was previously started via StartIdle. If the class is not idling this method does nothing.

SubscribeMailbox Method (IPWorks_IMAP Class)

Subscribes to the mailbox specified by Mailbox .

Object Oriented Interface

public function doSubscribeMailbox();

Procedural Interface

ipworks_imap_do_subscribemailbox($res);

Remarks

This method subscribes to the mailbox specified by the Mailbox property.

UnsetMessageFlags Method (IPWorks_IMAP Class)

Removes the flags specified by MessageFlags from the messages specified by MessageSet .

Object Oriented Interface

public function doUnsetMessageFlags();

Procedural Interface

ipworks_imap_do_unsetmessageflags($res);

Remarks

This method removes the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but can include:

\Deleted Mark a message as deleted (for removal by later ExpungeMailbox).
\Seen Mark a message as read.
\Answered Mark a message as answered.
\Flagged Mark a message as flagged.
\Draft Mark a message as being incomplete (under composition).

UnsubscribeMailbox Method (IPWorks_IMAP Class)

Unsubscribes from the mailbox specified by Mailbox .

Object Oriented Interface

public function doUnsubscribeMailbox();

Procedural Interface

ipworks_imap_do_unsubscribemailbox($res);

Remarks

This method unsubscribes from the mailbox specified by the Mailbox property.

ConnectionStatus Event (IPWorks_IMAP Class)

Fired to indicate changes in connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

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

Parameter List

 'connectionevent'
'statuscode'
'description'

Remarks

The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.

The ConnectionEvent parameter indicates the type of connection event. Values may include:

Firewall connection complete.
SSL or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (IPWorks_IMAP Class)

Fired when the message or the part data finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

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

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the requested message body or part 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 (IPWorks_IMAP Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

ErrorCode contains an error code and Description 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 (IPWorks_IMAP Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

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

Parameter List

 'field'
'value'

Remarks

The Field parameter contains the name of the HTTP header (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).

IdleInfo Event (IPWorks_IMAP Class)

Fires whenever responses from the server are received while idling.

Object Oriented Interface

public function fireIdleInfo($param);

Procedural Interface

ipworks_imap_register_callback($res, 5, array($this, 'fireIdleInfo'));

Parameter List

 'message'
'cancel'

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

Some possible values returned by the server are:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (IPWorks_IMAP Class)

Fires for each set of access control rights returned by the server.

Object Oriented Interface

public function fireMailboxACL($param);

Procedural Interface

ipworks_imap_register_callback($res, 6, array($this, 'fireMailboxACL'));

Parameter List

 'mailbox'
'user'
'rights'

Remarks

Fires for each set of access control rights returned by the server after a call to GetMailboxACL. Standard rights include:

lLookup (visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep seen/unseen information across sessions
wWrite (Store flags other than SEEN and DELETED)
iInsert (Can be appended, and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Store DELETED flag, perform EXPUNGE)
aAdminister (Set access permissions)

MailboxList Event (IPWorks_IMAP Class)

Fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Object Oriented Interface

public function fireMailboxList($param);

Procedural Interface

ipworks_imap_register_callback($res, 7, array($this, 'fireMailboxList'));

Parameter List

 'mailbox'
'separator'
'flags'

Remarks

This method is fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.

MessageInfo Event (IPWorks_IMAP Class)

Fired with information for the message(s) retrieved by the server.

Object Oriented Interface

public function fireMessageInfo($param);

Procedural Interface

ipworks_imap_register_callback($res, 8, array($this, 'fireMessageInfo'));

Parameter List

 'messageid'
'subject'
'messagedate'
'from'
'flags'
'size'

Remarks

The MessageInfo event is fired when messages are searched, listed, or message information is received.

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

More information may be received from the respective properties, such as: MessageContentType, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.

MessagePart Event (IPWorks_IMAP Class)

Fired for each message part when FetchMessageInfo is called.

Object Oriented Interface

public function fireMessagePart($param);

Procedural Interface

ipworks_imap_register_callback($res, 9, array($this, 'fireMessagePart'));

Parameter List

 'partid'
'size'
'contenttype'
'filename'
'contentencoding'
'parameters'
'multipartmode'
'contentid'
'contentdisposition'

Remarks

The PartId parameter denotes the PartId which may be identified in other parts or messages. The format of part id-s is specified by the IMAP RFCs.

The Size parameter gives the size of this part.

The ContentType parameter shows the type of data contained in the part.

The ContentEncoding parameter shows how the data is encoded.

The Filename parameter shows the filename corresponding to the part (if the part was included in the message as an attached file).

The Parameters parameter contains the additional parameters passed to the ContentType header such as the part charset etc.

The MultipartMode parameter shows the how this part relates to the message's whole multipart structure ('mixed', 'alternative', etc.).

The ContentId parameter shows the value of the Content-Id header for the part.

The ContentEncoding parameter shows the value of the Content-Encoding header for the part.

PITrail Event (IPWorks_IMAP Class)

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

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworks_imap_register_callback($res, 10, array($this, 'firePITrail'));

Parameter List

 'direction'
'message'

Remarks

The PITrail event is useful for debugging as well as learning 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:

0 (Client)The Message originates from the client.
1 (Server)The Message originates from the server.
2 (Information)The Message is an informative message originating from the client software (the class code).

SSLServerAuthentication Event (IPWorks_IMAP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_imap_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_imap_register_callback($res, 12, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (IPWorks_IMAP Class)

Fired when the message or the part data starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_imap_register_callback($res, 13, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the message body or the part data starts transferring from the server to the local host. Further progress information is provided by the Transfer and EndTransfer events.

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

Transfer Event (IPWorks_IMAP Class)

Fired while the message gets transferred from the MailServer .

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_imap_register_callback($res, 14, array($this, 'fireTransfer'));

Parameter List

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

Remarks

The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer

The Text parameter contains the portion of the message or the part data being 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. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event only 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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Configuration Settings (IMAP 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.

IMAP Configuration Settings

AlwaysReturnUIDs:   Instructs the server to return UIDs even if not in UIDMode.

If UIDMode is set to false the MessageSet contains session message ids, and the response from the server is going to contain session message ids as well. In some cases it is desirable that the server sends back UIDs; set the AlwaysReturnUIDs to True to instruct the server to do so.

The default value for this setting is False.

AppendToMailboxDateTime:   Specifies the date-time parameter used in the initial APPEND request.

When appending to a mailbox using the AppendToMailbox method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case.

The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013 at 12:34:56 PM EST.

By default, if this setting is not specified, no date-time is sent with the APPEND request and the server will use the current time.

AuthorizationIdentity:   The value to use as the authorization identity when SASL authentication is used.

When AuthMechanism is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2 you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2 this should be your OAUTH authorization string. For instance:

Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q

Note: When using amXOAUTH2 User must be specified, but Password is not required.

AutoDecodeSubject:   Instructs the class to automatically decode message subjects.

Subjects that have been Quoted-Printable or Base-64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded.

AutoDecodeText:   Whether to decode MessageText when AutoDecodeParts is True.

When AutoDecodeParts is True this setting controls whether MessageText is also decoded. When AutoDecodeText is True (default) MessageText is decoded. When set to False MessageText is not decoded. This setting is only applicable when AutoDecodeParts is set to True.

FetchAfterSearch:   Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox.

If set to False, FetchMessageInfo will not be called for messages matching the SearchCriteria after calling SearchMailbox. MessageInfo will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True.

FetchTextAndHeaders:   Specifies whether the message body and headers are fetched in a single request.

This setting specifies whether the FetchMessageText method fetches both the message headers and text, or just the message text. By default this value is false and FetchMessageText will fetch only the message text from the server. When set to true the class will fetch both the message text and headers in a single request from the server and populate both MessageHeadersString and MessageText.

IncludeHeaders:   Instructs the class to include the headers in the LocalFile.

When set to true, the headers for the message you are fetching will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file.

MaskSensitive:   Whether sensitive properties should be masked when logging.

By default, the PITrail event will include the raw commands sent to the IMAP server, including sensitive values like passwords. To prevent passwords from appearing in plain text when logging, set this option to True. The default value is False.

SendIDCommand:   Instructs class to send the ID command if the server advertises support for it.

This setting specifies whether the class will use the IMAP4 ID Extension defined in RFC 2971 and send the ID command to the server. When set to true the class will send the ID command with the value IPWorksIMAP if the server supports this as defined in the server's response to the CAPABILITY command.

The default value is false and this command will not be sent.

UTF7MailboxNames:   Specifies whether or not to automatically encode and decode UTF-7 mailbox names.

IMAP servers may represent some characters in a mailbox name in UTF-7 format. This setting determines whether or not the class should automatically encode and decode these values. When set to false no encoding or decoding will be performed by the class. The default value is true.

IPPort Configuration Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 setting 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).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Configuration Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if UseInternalSecurityAPI is False.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to true the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to false (default) the CRL check will not be performed by the class.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when UseInternalSecurityAPI is False (default) include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when UseInternalSecurityAPI is True: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when UseInternalSecurityAPI is True include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting.

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when UseInternalSecurityAPI is set to true.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when UseInternalSecurityAPI is set to True.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedProtocol:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedProtocol[connId]");

SSLProvider:   The name of the security provider to use.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed .

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13Provider:   The TLS 1.3 implementation to be used.

This setting specifies the TLS 1.3 implementation which will be used when TLS 1.3 is enabled via SSLEnabledProtocols. Possible values are:

  • 0 (Internal - Default)
  • 1 (Platform)

The platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (IMAP Class)

IMAP Errors

118   Firewall Error. Error message contains detailed description.
311   Protocol error.
312   Busy executing current method.
314   A Mailbox must be selected before calling this method.
315   Invalid argument. Please specify a valid MessageSet.
317   Unknown content encoding.
318   LocalFile already exists and Overwrite is False.

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

IPPort Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   Cannot change UseConnection option while the class is Active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 PHP Edition - Version 22.0 [Build 8171]