cfpop

Description

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

Category

Communications tags, Internet protocol tags

Syntax

<cfpop  
    server = "server name" 
    action = "getHeaderOnly|getAll|delete" 
    attachmentPath = "path" 
    debug = "yes|no"> 
    generateUniqueFilenames = "yes|no" 
    maxRows = "number" 
    messageNumber = "number" 
    name = "query name" 
    password = "password" 
    port = "port number" 
    startRow = "number" 
    timeout = "seconds" 
    uid = "number" 
    username = "user name">

See also

cfftp, cfhttp, cfldap, cfmail, cfmailparam, SetLocale; Sending and Receiving E-Mail in the Developing ColdFusion Applications

History

ColdFusion MX 7.01: Added cids query variable.

ColdFusion MX 6.1:

• Added support for multipart mail messages with Text and HTML parts.

• Changed the attachment name separator: the TAB character is now the separator between attachment names in the attachments and attachmentfiles query fields if a message has multiple attachments. This behavior is identical to ColdFusion 5 and earlier versions.

ColdFusion MX: Changed the attachment name separator: the comma separates names in the attachments and attachmentfiles query fields if a message has multiple attachments.

Attributes

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 long, and therefore take longer to process.

Attachmentpath attribute

Use the following syntax to specify an in-memory directory in the attachmentpath attribute. In-memory files speed processing of transient data.

ram:///path

The path can include multiple directories, for example ram:///petStore/mail/attachments You must create the directories in the path before you specify the file. For more information on using in-memory files, see Working with in-memory files in the Developing ColdFusion Applications.

The cfpop query variables

The following table describes the variables that provide information about the query that is returned by cfpop:

Query message header and body columns

The following table lists the message header and body columns that are returned if action = "getHeaderOnly" or "getAll":

If the mail message includes a part with a Content-Type of text/plain, the queryname.textBody column contains the part’s message content. If the mail message includes a part with a Content-Type of text/HTML, the queryname.HTMLBody column contains the part’s message content. If no Content-Type matches these types, the columns are empty. The queryname.Body column always contains the first message body found.

The queryname.attachments column contains a tab-separated list of all the attachment names. The queryname.attachmentfiles column contains a tab-separated list of the locations of the attachment files. Use the cffile tag to delete these temporary files when you have processed them.

To create a ColdFusion date/time object from the date-time string that is extracted from a mail message in the queryname.date column, use the following table:

For more information on cfpop, see Sending and Receiving E-Mail in the Developing ColdFusion Applications.

Example

<!--- This view-only example shows the use of cfpop. ---> 
<h3>cfpop Example</h3> 
<p>cfpop lets you retrieve and manipulate mail in a POP3 mailbox.  
    This view-only example shows how to create one feature of  
    a mail client, to display the mail headers in a POP3 mailbox. 
<p>To execute this, un-comment this code and run with a mail-enabled CF Server. 
<!---  
<cfif IsDefined("form.server")> 
    <!--- Make sure server, username are not empty. ---> 
    <cfif form.server is not "" and form.username is not ""> 
        <cfpop server = "#form.popserver# " username = #form.username# password = #form.pwd# 
        action = "getHeaderOnly" name = "GetHeaders "> 
        <h3>Message Headers in Your Inbox</h3> 
        <p>Number of Records:  
        <cfoutput>#GetHeaders.recordCount#</cfoutput></p> 
 
        <ul> 
            <cfoutput query = "GetHeaders"> 
            <li>Row: #currentRow#: From: #From# -- Subject: #Subject# 
            </cfoutput> 
        </ul> 
    </cfif> 
</cfif> 
 
<form action = "cfpop.cfm " method = "post"> 
    <p>Enter your mail server:</p> 
    <p><input type = "Text" name = "popserver"></p> 
    <p>Enter your username:</p> 
    <p><input type = "Text" name = "username"></p> 
    <p>Enter your password:</p> 
    <p><input type = "password" name = "pwd"></p> 
    <p><input type = "Submit" name = "get message headers"></p> 
</form>  
--->