Lucee Tag Reference

<cfpop>

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

Body

This tag can't have a body.

Example

<cfpop
	[action=getHeaderOnly|getAll|delete]
	[attachmentpath=string]
	[connection=string]
	[debug=boolean]
	[generateuniquefilenames=boolean]
	[maxrows=number]
	[messagenumber=string]
	[name=string]
	[password=string]
	[port=number]
	[secure=boolean]
	[server=string]
	[startrow=number]
	[timeout=number]
	[uid=string]
	[username=string]>
This tag is also supported within cfscript
<cfscript>
	pop
		[action=getHeaderOnly|getAll|delete]
		[attachmentpath=string]
		[connection=string]
		[debug=boolean]
		[generateuniquefilenames=boolean]
		[maxrows=number]
		[messagenumber=string]
		[name=string]
		[password=string]
		[port=number]
		[secure=boolean]
		[server=string]
		[startrow=number]
		[timeout=number]
		[uid=string]
		[username=string];
</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Default Value Description
action string No getHeaderOnly Specifies the mail action. 
attachmentpath string No 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. 
connection string No label for a connection. 
debug boolean No This Attribute is deprecated 
generateuniquefilenames boolean No 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 No Sets the number of messages returned, starting with the number in the startRow attribute.
This attribute is ignored if messageNumber is specified. 
messagenumber string No Can be a comma-separated list of the message ids 
name string No Name for the index query. 
password string No Password that corresponds to user name. 
port number No Defaults to the standard POP port, 110. 
secure boolean No enables SSL for pop requests 
server string No Host name biff.upperlip.com or IP address 192.1.2.225 of the POP server. 
startrow number No Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if
messageNumber is specified. 
timeout number No Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds. 
uid string No UID or a comma-delimited list of UIDs to get or delete.
Invalid UIDs are ignored. 
username string No If no user name is specified, the POP connection is anonymous.