You create ColdFusion pages to access a Post Office Protocol (POP) server to retrieve e-mail message information. ColdFusion can then display the messages (or just header information), write information to a database, or perform other actions.
The cfpop
tag lets you add Internet mail client features and e-mail consolidation to applications. Although a conventional mail client provides an adequate interface for personal mail, there are many cases in which an alternative interface to some mailboxes is advantageous. You use cfpop
to develop targeted mail clients to suit the specific needs of a wide range of applications. The cfpop
tag does not work with the other major e-mail protocol, Internet Mail Access Protocol (IMAP).
Here are three instances in which implementing POP mail makes sense:
Using cfpop
on your POP server is like running a query on your mailbox contents. You set its action
attribute to retrieve either headers (using the GetHeaderOnly
value) or entire messages (using the GetAll
value) and assign it a name
value. You use the name to refer to the record set that cfpop
returns, for example, when using cfoutput
. To access a POP server, you also must define the server
, username
, and password
attributes.
For more information on cfpop
syntax and variables, see CFML Reference.
Use the following steps to add POP mail to your application.
cfpop
tag in your application and create a user interface for accessing a mailbox.
You use the cfoutput
tag with the HTMLCodeFormat
and HTMLEditFormat
functions to control output to the browser. These functions convert characters with special meanings in HTML, such as the less than (<), greater than (>), and ampersand (&) symbols, into HTML-escaped characters, such as <, >, and &. The HTMLCodeFormat
tag also surrounds the text in a pre
tag block. The examples in this chapter use these functions.
Like any ColdFusion query, each cfpop
query returns two variables that provide record number information:
RecordCount
The total number of records returned by the query.
CurrentRow
The current row of the query being processed by cfoutput
or cfloop
in a query-driven loop.
You can reference these properties in a cfoutput
tag by prefixing the query variable with the query name in the name
attribute of cfpop
:
<cfoutput
>
This operation returned #Sample.RecordCount# messages.
</cfoutput
>