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


		<cfpop
    connection=string
    server=string
    uid=string
    port=number
    username=string
    password=string
    secure=boolean
    action=getHeaderOnly|getAll|delete
    name=string
    messageNumber=string
    attachmentPath=string
    timeout=number
    debug=boolean
    maxRows=number
    startRow=number
    generateUniqueFilenames=boolean
    delimiter=string
>

Attribute	Description	Default
action _{string, optional}	edit 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

Attribute

Description

Default

action

_{string, optional}

edit

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

Get Headers Only

action="getHeaderOnly" - Retrieve email headers without body content

Attribute	Description	Default
connection _{string, optional}	edit label for a connection.
server _{string, optional}	edit Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server.
port _{number, optional}	edit Defaults to the standard POP port, 110.
username _{string, optional}	edit If no user name is specified, the POP connection is anonymous.
password _{string, optional}	edit Password that corresponds to user name.
secure _{boolean, optional}	edit enables SSL for pop requests
timeout _{number, optional}	edit Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.
name _{string, optional}	edit Name for the index query. _{Alias: variable}
messageNumber _{string, optional}	edit Can be a comma-separated list of the message ids
uid _{string, optional}	edit UID or a comma-delimited list of UIDs to get or delete. Invalid UIDs are ignored.
maxRows _{number, optional}	edit Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.
startRow _{number, optional}	edit Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.
delimiter _{string, optional}	edit Character that separates uid list, The default value is comma(,). _{Alias: delimiters}

Get Full Messages

action="getAll" - Retrieve complete email messages including body and attachments

Attribute	Description	Default
connection _{string, optional}	edit label for a connection.
server _{string, optional}	edit Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server.
port _{number, optional}	edit Defaults to the standard POP port, 110.
username _{string, optional}	edit If no user name is specified, the POP connection is anonymous.
password _{string, optional}	edit Password that corresponds to user name.
secure _{boolean, optional}	edit enables SSL for pop requests
timeout _{number, optional}	edit Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.
name _{string, optional}	edit Name for the index query. _{Alias: variable}
messageNumber _{string, optional}	edit Can be a comma-separated list of the message ids
uid _{string, optional}	edit UID or a comma-delimited list of UIDs to get or delete. Invalid UIDs are ignored.
attachmentPath _{string, optional}	edit 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.
generateUniqueFilenames _{boolean, optional}	edit 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.
maxRows _{number, optional}	edit Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.
startRow _{number, optional}	edit Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.
delimiter _{string, optional}	edit Character that separates uid list, The default value is comma(,). _{Alias: delimiters}

Delete Messages

action="delete" - Delete email messages from POP server

Attribute	Description	Default
connection _{string, optional}	edit label for a connection.
server _{string, optional}	edit Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server.
port _{number, optional}	edit Defaults to the standard POP port, 110.
username _{string, optional}	edit If no user name is specified, the POP connection is anonymous.
password _{string, optional}	edit Password that corresponds to user name.
secure _{boolean, optional}	edit enables SSL for pop requests
timeout _{number, optional}	edit Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.
messageNumber _{string, optional}	edit Can be a comma-separated list of the message ids
uid _{string, optional}	edit UID or a comma-delimited list of UIDs to get or delete. Invalid UIDs are ignored.
delimiter _{string, optional}	edit Character that separates uid list, The default value is comma(,). _{Alias: delimiters}

Unimplemented Attribute(s)

Attribute	Description	Default
debug _{boolean, optional}	edit this attribute is deprecated and ignored, log control happens via the logging framework directly. * deprecated *

Examples