<CFPOP SERVER="servername"
PORT="port_number"
USERNAME="username"
PASSWORD="password"
ACTION="action"
NAME="queryname"
MESSAGENUMBER="number"
ATTACHMENTPATH="path"
TIMEOUT="seconds"
MAXROWS="number"
STARTROW="number">
SERVER
Required. Host name (biff.upperlip.com) or IP address (192.1.2.225) of the POP server.
PORT
Optional. Defaults to the standard POP port, 110.
USERNAME
Optional. If no user name is specified, the POP connection is anonymous.
PASSWORD
Optional. Password corresponds to user name.
ACTION
Optional. Specifies the mail action. There are three possible values:
- GetHeaderOnly -- (Default) Returns message header information only.
- GetAll -- Returns message header information, message text, and attachments if ATTACHMENTPATH is specified.
- Delete -- Deletes messages on the POP server.
Note: Two retrieve options are offered to maximize performance. Message header information is typically short and therefore quick to transfer. Message text and attachments can be very long and therefore take longer to process.
NAME
Optional. The name you assign to the index query. Required for ACTION="GetHeaderOnly" and ACTION="GetAll".
MESSAGENUMBER
Optional. Specifies the message number(s) for the given action. MESSAGENUMBER is required for ACTION="Delete". If it is provided for ACTION="GetHeaderOnly" or ACTION="GetAll", only referenced messages will be retrieved. If it is omitted for ACTION="GetHeaderOnly"or ACTION="GetAll", all messages available on the server are returned.
MESSAGENUMBER can contain individual message numbers or a comma-separated list of message numbers. Invalid message numbers will be ignored.
ATTACHMENTPATH
Optional. Allows attachments to be written to the specified directory when ACTION="GetAll". If an invalid ATTACHMENTPATH is specified, no attachment files are written to the server.
TIMEOUT
Optional. Specifies the maximum amount of time in seconds to wait for mail processing. Defaults to 60 seconds.
MAXROWS
Optional. Specifies the maximum number of entries for mail queries. This attribute is ignored if MESSAGENUMBER is specified.
STARTROW
Optional. Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if MESSAGENUMBER is specified.
|