<cfpop>

Retrieves and deletes e-mail messages from a POP mail server.

This tag cannot have a body.

This tag is also supported within <cfscript>

Attribute Description Default
attachmentpath
string, 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.

server
string, optional

Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server.

uid
string, optional

UID or a comma-delimited list of UIDs to get or delete. Invalid UIDs are ignored.

messagenumber
string, optional

Can be a comma-separated list of the message ids

generateuniquefilenames
boolean, optional

Boolean indicating whether to generate unique filenames for the files attached to an e-mail message to avoid naming conflicts when the files are saved. Default is NO.

startrow
number, optional

Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.

password
string, optional

Password that corresponds to user name.

maxrows
number, optional

Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.

name
string, optional

Name for the index query.

port
number, optional

Defaults to the standard POP port, 110.

timeout
number, optional

Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.

action
string, optional

Specifies the mail action. getHeaderOnly: returns message header information only getAll: returns message header information, message text, and attachments if attachmentPath is specified delete: deletes messages on POP server

getHeaderOnly

debug
boolean, optional

this attribute is deprecated and ignored, log control happens via the logging framework directly.

secure
boolean, optional

enables SSL for pop requests

username
string, optional

If no user name is specified, the POP connection is anonymous.

connection
string, optional

label for a connection.

<cfpop
    [attachmentpath=string]
    [server=string]
    [uid=string]
    [messagenumber=string]
    [generateuniquefilenames=boolean]
    [startrow=number]
    [password=string]
    [maxrows=number]
    [name=string]
    [port=number]
    [timeout=number]
    [action=getHeaderOnly|getAll|delete]
    [debug=boolean]
    [secure=boolean]
    [username=string]
    [connection=string]
>

Examples

There are currently no examples for this tag.

See also