Contents

cfimap

Description

Retrieves and deletes e-mail messages from a Imap mail server.

Category

Other

Implemented

Usage Syntax

<cfimap  
	server="String"
	[uid="String"]
	[port="number"]
	[username="String"]
	[password="String"]
	[action="String"]
	[name="String"]
	[messageNumber="String"]
	[attachmentPath="String"]
	[timeout="number"]
	[maxRows="number"]
	[startRow="number"]
	[generateUniqueFilenames="Boolean"]
 />

[] = Optional attribute

Attributes

Name Type Required Default Description
server String Yes Host name biff.upperlip.com or IP address 192.1.2.225 of the Imap server.
uid String No
port number No Defaults to the standard Imap port, 143.
username String No If no user name is specified, the Imap connection is anonymous.
password String No Password that corresponds to user name.
action String No Specifies the mail action.
name String No Name for the index query.
messageNumber String No Can be a comma-separated list of the message ids
attachmentPath String No 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 No Specifies the maximum time, in seconds, to wait for mail processing. Defaults is 60 seconds.
maxRows number No Sets the number of messages returned, starting with the number in the startRow attribute. This attribute is ignored if messageNumber is specified.
startRow number No Specifies the first row number to be retrieved. Default is 1. This attribute is ignored if messageNumber is specified.
generateUniqueFilenames Boolean No 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.

Example Usage