Tags · Functions · Objects
Lucee Tag Reference
Choose a tag:
see all tags

Tag <CFFEED>

Reads or creates an RSS or Atom syndication feed. This tag can read various RSS and Atom 0.3 versions. It can create RSS 2.0 or Atom 1.0 feeds.

Body

This tag can't have a body.

Example

	<cffeed
		[action="string"]
		[columnmap="struct"]
		[enclosuredir="string"]
		[ignoreenclosureerror="boolean"]
		[name="any"]
		[outputfile="string"]
		[overwrite="boolean"]
		[overwriteenclosure="boolean"]
		[properties="any"]
		[proxypassword="string"]
		[proxyport="number"]
		[proxyserver="string"]
		[proxyuser="string"]
		[query="any"]
		[source="string"]
		[timeout="number"]
		[useragent="string"]
		[xmlvar="string"]>
This tag is also supported within cfscript
	<cfscript>
		feed
		[action="string"]
		[columnmap="struct"]
		[enclosuredir="string"]
		[ignoreenclosureerror="boolean"]
		[name="any"]
		[outputfile="string"]
		[overwrite="boolean"]
		[overwriteenclosure="boolean"]
		[properties="any"]
		[proxypassword="string"]
		[proxyport="number"]
		[proxyserver="string"]
		[proxyuser="string"]
		[query="any"]
		[source="string"]
		[timeout="number"]
		[useragent="string"]
		[xmlvar="string"];
	</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
action string No The name to use for the JavaScript proxy class.
The action to take, one of the following values:
- create: Creates an RSS 2.0 or Atom 1.0 feed XML document and saves it in a variable, writes it to a file, or both.
- read (default): Parses an RSS or Atom feed from a URL or an XML file and saves it in a structure or query.
You can also get query metadata in a separate structure. 
columnmap struct No Used only for the create action with a query attribute.
A structure specifying a mapping between the names of the columns in the object specified by the query attribute
and the columns of the feed format, as described in the Query attribute section.
The key for each field must be a column name listed in the Query columns section. The value of the field must be
the name of the corresponding column in the query object used as input to the create action. 
enclosuredir string No Used only for the read action.
Path to the directory in which to save any enclosures that are available in the feed being read.
The path can be absolute or relative to the CFML file.
If the directory does not exist, Lucee generates an error.
If you omit this attribute, Lucee does not save enclosures.
To specify the directory that contains the current page, set this attribute to .(period). 
ignoreenclosureerror boolean No If this attribute is true, Lucee attempts to save all enclosures.
If it encounters an error downloading one enclosure, it continues downloading other enclosures and writes the
error information in the server log.
If this attribute is false, Lucee stops downloading all enclosures and generates an error when it encounters
an error downloading an enclosure.
Note: Enclosure errors can occur if the specified enclosure is of a type that the web server does not allow to be
downloaded. (optional, default=false) 
name any No A structure that contains complete feed data:
The output of a read action.
The input definition of the feed to create.
This structure contains complete feed information.
When you specify the name attribute for a create action, you must put it in pound signs (#). 
outputfile string No Path of the file in which to write the feed as XML text.
The path can be absolute, or relative to the CFML file. 
overwrite boolean No Whether to overwrite the XML feed file if it already exists.
If you do not set this attribute to true and the cffeed tag tries to write to a file that exists, Lucee
generates an error. (optional, default=false) 
overwriteenclosure boolean No Used only for the read action.
Whether to overwrite files in the enclosure directory if they already exist.
If you do not set this attribute to true and the cffeed tag tries to write to a file that exists, Lucee
generates an error. (optional, default=false) 
properties any No A structure containing the feed metadata, the information about the entire feed.
Can contain either of the following:
The output of a read action.
Input to a create action.
The properties and query attributes combined provide complete feed information.
When you specify the properties attribute for a create action, you must put it in pound signs (#) 
proxypassword string No Password required by the proxy server. 
proxyport number No The port to connect to on the proxy server. 
proxyserver string No Host name or IP address of a proxy server to which to send the request. 
proxyuser string No User name to provide to the proxy server. 
query any No A query object containing the Atom entries or RSS items in the feed. Can contain either of the following:
The output of a read action.
Input to a create action.
The properties and query attributes combined provide complete feed information.
When you specify the query attribute for a create action, you must put it in pound signs (#) 
source string No Used only for the read action.
The URL of the feed or the path to the XML file that contains the feed contents.
A path can be absolute, or relative to the CFML file. 
timeout number No The number of seconds to wait for a response from the feed source. A value of 0 specifies that the request does not time out. 
useragent string No Text to put in the HTTP User-Agent request header field. Used to identify the request client software. 
xmlvar string No A variable in which to save the read or created feed as XML text.