User Guide

268 Chapter 2: ColdFusion Tags
Usage
The cfpop tag retrieves one or more mail messages from a POP server and populates a
ColdFusion query object with the resulting messages, one message per row. Alternatively, it
deletes one or more messages from the POP server.
To optimize performance, two retrieve options are available. 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.
action Optional getHeaderOnly • 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
name Required if
action =
"getAll"
or
"getHeaderOnly"
Name for query object that contains the
retrieved message information.
message
Number
Message number or comma-delimited list of
message numbers to get or delete. Invalid
message numbers are ignored.
Ignored if
uid is specified.
uid UID or a comma-delimited list of UIDs to get
or delete. Invalid UIDs are ignored..
attachment
Path
Optional If
action="getAll", specifies a directory in
which to save any attachments. If the
directory does not exist, ColdFusion creates
it.
If you omit this attribute, ColdFusion does not
save any attachments. If you specify a relative
path, the path root is the ColdFusion
temporary directory, which is returned by the
GetTempDirectory function..
timeout Optional 60 Maximum time, in seconds, to wait for mail
processing.
maxRows Optional retrieves all
available rows
Number of messages to return or delete,
starting with the number in
startRow. Ignored
if
messageNumber or uid is specified,
startRow Optional 1 First row number to get or delete. Ignored if
messageNumber or uid is specified,
generate
Unique
Filenames
Optional No • Yes: Generate unique filenames for files
attached to an e-mail message, to avoid
naming conflicts when files are saved
• No
Attribute Req/Opt Default Description