CFPOP | |||||||||||||||||||||||||||||||||||||||||||||
Description
Retrieves and deletes e-mail messages from a POP mail server. |
|||||||||||||||||||||||||||||||||||||||||||||
Category
Forms tags, Internet Protocol tags | |||||||||||||||||||||||||||||||||||||||||||||
Syntax<cfpop server = "servername" port = "port_number" username = "username" password = "password" action = "action" name = "queryname" messageNumber = "number" uid = "number" attachmentPath = "path" timeout = "seconds" maxRows = "number" startRow = "number" generateUniqueFilenames = "boolean"> | |||||||||||||||||||||||||||||||||||||||||||||
See also
cfftp, cfhttp, cfldap, cfmail, cfmailparam, SetLocale
|
|||||||||||||||||||||||||||||||||||||||||||||
Usage
|
|||||||||||||||||||||||||||||||||||||||||||||
cfpop query variables
The following table describes the query variables that are returned by cfpop:
|
|||||||||||||||||||||||||||||||||||||||||||||
Message header and body columns
The following table lists the message header and body columns that are returned if action = "getHeaderOnly" or "getAll":
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 Developing ColdFusion MX Applications with CFML. |
|||||||||||||||||||||||||||||||||||||||||||||
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 = "#server# " username = #UserName# password = #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><input type = "Text" name = "server"> <p>Enter your username: <p><input type = "Text" name = "username"> <p>Enter your password: <p><input type = "password" name = "pwd"> <input type = "Submit" name = "get message headers"> </form> ---> |
SERVER | |
Required | |
POP server identifier:
|
PORT | |
Optional | |
Default value: "110"
POP port |
USERNAME | |
Optional | |
Default value: "Anonymous"
|
PASSWORD | |
Optional | |
Password that corresponds to username. |
ACTION | |
Optional | |
Default value: "getHeaderOnly"
|
NAME | |
Required if action = "getAll" or "getHeaderOnly" | |
Name for index query. |
MESSAGENUMBER | |
If action = "delete", this attribute, or uid, is required | |
Message number or comma-delimited list of message numbers to get. Applies to action ="getAll" and "getHeaderOnly". For these actions, if it is omitted, all messages are returned. Invalid message numbers are ignored. |
UID | |
If action = "delete", this attribute, or messageNumber, is required | |
UID or a comma-delimited list of UIDs to get. Applies to action = "getHeaderOnly" and action = "getAll". For these actions, if it is omitted, all messages are returned. Invalid UIDs are ignored. |
ATTACHMENTPATH | |
Optional | |
If action = "getAll", allows attachments to be written to directory. If this value is invalid, no attachment files are written to server. |
TIMEOUT | |
Optional | |
Default value: "60"
Maximum time, in seconds, to wait for mail processing. |
MAXROWS | |
Optional | |
Default value: "999999"
Number of messages to return, starting with the number in startRow. If messageNumber is specified, this attribute is ignored. |
STARTROW | |
Optional | |
Default value: "1"
First row number to get. If messageNumber is specified, this attribute is ignored. |
GENERATEUNIQUEFILENAMES | |
Optional | |
Default value: "No"
|