POP server identifier: A host name; for example, "biff.upperlip.com" An IP address; for example, "192.1.2.225"
port
numeric
POP port
username
string
Overrides username.
password
string
Overrides password
action
string
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 markRead: marks the message as read
Values:
getHeaderOnly
getAll
delete
markRead
name
string
Name for query object that contains the retrieved message information.
messagenumber
numeric
Message number or comma-delimited list of message numbers to get or delete. Invalid message numbers are ignored. Ignored if uid is specified.
uid
string
UID or a comma-delimited list of UIDs to get or delete. Invalid UIDs are ignored.
attachmentpath
string
If action="getAll", specifies a directory in which to save any attachments. If the directory does not exist, CFML creates it.
If you omit this attribute, CFML does not save any attachments. If you specify a relative path, the path root is the CFML temporary directory, which is returned by the GetTempDirectory function.
timeout
numeric
Maximum time, in seconds, to wait for mail processing
maxrows
numeric
Number of messages to return or delete, starting with the number in startRow. Ignored if messageNumber or uid is specified.
startrow
numeric
First row number to get or delete. Ignored if messageNumber or uid is specified.
generateUniqueFileNames
boolean
Yes: Generate unique filenames for files attached to an e-mail message, to avoid naming conflicts when files are saved
Values:
true
false
secure
boolean
Default:false
CF 10+ Enables SSL for pop requests.
delimiter
string
CF 11+ The value of the uid attribute can be a comma-separated list of UIDs. If the delimiter attribute is specified, the value of delimiter will be used as a delimiter instead of comma.
Examples
Sample code using the cfpop tag
Add an Example for: cfpop
Use this form to create the Serialized JSON string needed to add an example into the docs.