<cfimap>

Retrieves and deletes e-mail messages from an IMAPmail server.

This tag works exactly the same way as the <cfmail> 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 e-mail retrieval, the other being POP3. Virtually all modern e-mail clients and servers support both protocols as a means of transferring e-mail messages from a server, such as those used by Gmail, to a client, such as Mozilla Thunderbird and Microsoft Outlook.

Many implementations of webmail use IMAP to retrieve e-mail 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>

Attribute Description Default
newfolder
string, optional
attachmentpath
string, optional

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.

server
string, optional

Host name biff.upperlip.com or IP address 192.1.2.225 of the Imap server.

uid
string, optional

Specifies the unique ID or a comma-delimited list of Uids to retrieve or delete. If you set invalid Uids, then they are ignored.

messagenumber
string, optional

Can be a comma-separated list of the message ids

recurse
boolean, optional
folder
string, optional
generateuniquefilenames
boolean, optional

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.

startrow
number, optional

Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.

password
string, optional

Password that corresponds to user name.

maxrows
number, optional

Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.

name
string, optional

Name for the index query.

port
number, optional

Defaults to the standard Imap port, 143.

timeout
number, optional

Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.

action
string, optional

Specifies the mail action.

getHeaderOnly

debug
boolean, optional

this attribute is deprecated and ignored, log control happens via the logging framwork directly.

secure
boolean, optional

enables SSL for pop requests

username
string, optional

If no user name is specified, the Imap connection is anonymous.

connection
string, optional

label for a connection.

<cfimap
    [newfolder=string]
    [attachmentpath=string]
    [server=string]
    [uid=string]
    [messagenumber=string]
    [recurse=boolean]
    [folder=string]
    [generateuniquefilenames=boolean]
    [startrow=number]
    [password=string]
    [maxrows=number]
    [name=string]
    [port=number]
    [timeout=number]
    [action=getHeaderOnly|getAll|delete]
    [debug=boolean]
    [secure=boolean]
    [username=string]
    [connection=string]
>

Examples

There are currently no examples for this tag.

See also