<cfimap>

Retrieves and deletes email messages from an IMAP email server.

This tag works exactly the same way as the <cfpop> tag. It has the same attributes.

The Internet Message Access Protocol or IMAP is one of two of the most prevalent Internet standard protocols for email retrieval, the other being POP3. Virtually all modern email clients and servers support both protocols as a means of transferring email messages from a server, such as those used by Gmail, or to a client such as Mozilla Thunderbird and Microsoft Outlook.

Many implementations of webmail use IMAP to retrieve email messages from a server and display them within a web browser, making the use of this protocol transparent to the user.

This tag cannot have a body.

This tag is also supported within <cfscript>


		<cfimap
    connection=string
    server=string
    port=number
    uid=string
    username=string
    password=string
    secure=boolean
    action=getHeaderOnly|getAll|delete|open|close|markRead|createFolder|deleteFolder|renameFolder|listAllFolders|moveMail
    name=string
    messageNumber=string
    attachmentPath=string
    timeout=number
    maxRows=number
    startRow=number
    debug=boolean
    generateUniqueFilenames=boolean
    folder=string
    newFolder=string
    recurse=boolean
    delimiter=string
    stopOnError=boolean
>

Attribute	Description	Default
connection _{string, optional}	edit label for a connection.
server _{string, optional}	edit Host name biff.upperlip.com or IP address 192.1.2.225 of the Imap server.
port _{number, optional}	edit Defaults to the standard Imap port, 143.
uid _{string, optional}	edit Specifies the unique ID or a comma-delimited list of Uids to retrieve or delete. If you set invalid Uids, then they are ignored.
username _{string, optional}	edit If no user name is specified, the Imap connection is anonymous.
password _{string, optional}	edit Password that corresponds to user name.
secure _{boolean, optional}	edit enables SSL for pop requests
action _{string, optional}	edit Specifies the IMAP action to perform. getHeaderOnly getAll delete open close markread createfolder deletefolder renamefolder listallfolders movemail	getHeaderOnly
name _{string, optional}	edit Name for the index query. _{Alias: variable}
messageNumber _{string, optional}	edit Can be a comma-separated list of the message ids
attachmentPath _{string, optional}	edit Allows attachments to be written to the specified directory when action = "getAll". If an invalid attachmentPath is specified, no attachment files are written to the server.
timeout _{number, optional}	edit Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.
maxRows _{number, optional}	edit Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.
startRow _{number, optional}	edit Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.
generateUniqueFilenames _{boolean, optional}	edit Boolean indicating whether to generate unique filenames for the files attached to an e-mail message to avoid naming conflicts when the files are saved. Default is NO.
folder _{string, optional}	edit Folder for action, default is INBOX
newFolder _{string, optional}	edit Name of new folder, used by action renameFolder and moveMail
recurse _{boolean, optional}	edit Used for action listAllFolders
delimiter _{string, optional}	edit Character that separates uid list, The default value is comma(,). _{Alias: delimiters}
stopOnError _{boolean, optional}	edit Stop execution on error, default is true Introduced: 7.0.0.340

Unimplemented Attribute(s)

Attribute	Description	Default
debug _{boolean, optional}	edit this attribute is deprecated and ignored, log control happens via the logging framework directly. * deprecated *

Examples

edit

Action getAll

<cfimap
	action="getAll"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#"
	name="getAll" maxrows ="10" attachmentpath="#expandpath('./')#" generateuniquefilenames="true">
<cfdump var="#getAll#" />

Action getHeaderOnly

<cfimap
	action="getHeaderOnly"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#"
	name="getHeader" maxrows ="10">
<cfdump var="#getHeader#" />

Action CreateFolder

<cfimap
	action="CreateFolder"
	folder="NewFolderFromIMAP_Test"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#"
	name="CreateFolder">

Action ListAllFolders

<cfimap
	action="ListAllFolders"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#"
	name="ListAllFolders" maxrows ="10">
<cfdump var="#ListAllFolders#" />

Action renamefolder

	<cfimap
	action="renamefolder"
	folder="NewFolderFromIMAP_Test"
	newFolder="RenameFolderFromIMAP"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#">

Action deletefolder

	<cfimap
	action="deletefolder"
	folder="NewFolderFromIMAP_Test"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#"
	maxrows ="10">

Action MoveMail

<cfimap
	action="MoveMail"
	Newfolder="newfolder"
	messagenumber ="1"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#">

Action MarkRead

<cfimap
	action="MarkRead"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#">

Action open

<cfimap
	action="open"
	connection="openConnc"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#">

Action close

<cfimap action="close" connection="openConnc">

Action Delete

<cfimap
	action="delete"
	folder=""
	messagenumber ="1"
	server="#Imap.Server#"
	port="#Imap.Port#"
	username="#Imap.Username#"
	password="#Imap.Password#"
	secure="#Imap.Secure#">