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

Tag <CFHTTPPARAM>

Required for cfhttp POST operations, cfhttpparam is used to specify the parameters necessary to build a cfhttp POST.

Body

This tag can't have a body.

Example

	<cfhttpparam
		[encoded="boolean"]
		[file="string"]
		[mimetype="string"]
		[name="string"]
		type="string"
		[value="any"]>
This tag is also supported within cfscript
	<cfscript>
		httpparam
		[encoded="boolean"]
		[file="string"]
		[mimetype="string"]
		[name="string"]
		type="string"
		[value="any"];
	</cfscript>

Attributes

The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name Type Required Description
encoded boolean No Applies to type "cgi" and "url", ignored for all other types.
Specifies whether to URL encode the the values defined with the tag, but only if necessary (no double encoding). 
file string No Required for type = "File". 
mimetype string No Applies to File type; invalid for all other types. Specifies the MIME media type of the file contents. The content type can include an identifier for the character encoding of the file; for example, text/html; charset=ISO-8859-1 indicates that the file is HTML text in the ISO Latin-1 character encoding. 
name string No A variable name for the data being passed. 
type string Yes valid values are:
  • header: specifies an HTTP header.
  • CGI: specifies an HTTP header. encodes the value depending on the attribute "encoded
  • body: specifies the body of the HTTP request.
  • XML: identifies the request as having a content-type of text/xml. Specifies that the value attribute contains the body of the HTTP request. Used to send XML to the destination URL.
  • file: tells Lucee to send the contents of the specified file.
  • URL: specifies a URL query string name-value pair to append to the cfhttp url attribute.
  • form,formField: specifies a form field to send.
  • cookie: specifies a cookie to send as an HTTP header. 
    		•
    value any No Specifies the value of the URL, FormField, Cookie, File, or CGI variable being passed.