<CFPOP SERVER="servername" PORT="port_number" USERNAME="username" PASSWORD="password" ACTION="action" NAME="queryname" MESSAGENUMBER="number" ATTACHMENTPATH="path" TIMEOUT="seconds" MAXROWS="number" STARTROW="number" GENERATEUNIQUEFILENAMES="boolean">
CFPOP retrieves and deletes email messages from a POP mail server. See also CFMAIL.
Required. Host name (biff.upperlip.com) or IP address (192.1.2.225) of the POP server.
Optional. Defaults to the standard POP port, 110.
Optional. If no user name is specified, the POP connection is anonymous.
Optional. Password corresponds to user name.
Optional. Specifies the mail action. There are three possible values:
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. See the Message Header and Body Columns table, which follows the CFPOP attribute descriptions, for information on retrieving header and body information form the query when you specify GetHeaderOnly or GetAll.
Optional. The name you assign to the index query. Required for ACTION="GetHeaderOnly" and ACTION="GetAll".
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.
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.
Optional. Specifies the maximum amount of time in seconds to wait for mail processing. Defaults to 60 seconds.
Optional. Specifies the maximum number of entries for mail queries. This attribute is ignored if MESSAGENUMBER is specified.
Optional. Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if MESSAGENUMBER is specified.
Optional. Boolean indicating whether to generate unique file names for the files attached to an email message in order to avoid naming conflicts when the files are saved. The default is NO.
See CFML Language Reference for details on CFPOP Query Variables.