Retrieves and deletes e-mail messages from a POP mail server.
Forms tags, Internet Protocol tags
<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">
cfftp,
cfhttp,
cfldap,
cfmail,
cfmailparam,
SetLocale
Note: 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.
The following table describes the query variables that are returned by cfpop
:
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:
Locale | How to create a ColdFusion date/time object from queryname.date |
---|---|
English (US) |
Use the ParseDateTime function, which converts a date-time value to UTC |
Other |
Extract the date part of string; pass it to the LSParseDateTime function |
Note: To set the default display format of date, time, number, and currency values, use the SetLocale function.
For more information on cfpop
, see Developing ColdFusion MX Applications with CFML.
<!--- 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> --->