Allowed inside cfhttp tag bodies only. Required for cfhttp POST operations. Optional for all others. Specifies parameters to build an HTTP request.
<cfhttpparam |
Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys. The cfhttpparam tag ignores -_.!~*'() characters while encoding. If these characters are used as its values, then these characters are not encoded. This feature helps to avoid any issues with the URL at the receiving end. |
cfhttp, GetHttpRequestData, cfftp, cfldap, cfmail, cfmailparam, cfpop
ColdFusion MX 6.1:
Attribute |
Req/Opt |
Default |
Description |
---|---|---|---|
type |
Required |
|
Information type:
|
encoded |
Optional |
yes |
Applies to FormField and CGI types; ignored for all other types. Specifies whether to URL encode the form field or header. |
file |
Required only if type="File" |
|
Applies to File type; ignored for all other types. The absolute path to the file that is sent in the request body. |
mimeType |
Optional |
|
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 |
Required. Optional (and ignored) for Body and XML types |
|
Variable name for data that is passed. Ignored for Body and XML types. For File type, specifies the filename to send in the request. |
value |
Required. Optional (and ignored) for File type |
|
Value of the data that is sent. Ignored for File type. The value must contain string data or data that ColdFusion can convert to a string for all type attributes except Body. Body types can have string or binary values. |
Specifies header or body data to send in the HTTP request. The type attribute identifies the information that the parameter specifies. A cfhttp tag can have multiple cfhttpparam tags, subject to the following limitations:
<!--- This example consists of two CFML pages. The first page posts to the second. ---> <!--- The first, posting page. This page posts variables to another page and displays the body of the response from the second page. Change the URL and port as necessary for your environment. ---> <cfhttp method="post" url="http://127.0.0.1/tests/http/cfhttpparamexample.cfm" port="8500" throwonerror="Yes"> <cfhttpparam name="form_test" type="FormField" value="This is a form variable"> <cfhttpparam name="url_test" type="URL" value="This is a URL variable"> <cfhttpparam name="cgi_test" type="CGI" value="This is a CGI variable"> <cfhttpparam name="cookie_test" type="Cookie" value="This is a cookie"> </cfhttp> <!--- Output the results returned by the posted-to page. ---> <cfoutput> #cfhttp.fileContent# </cfoutput> <!--- This is the cfhttpparamexample.cfm page that receives and processes the Post request. Its response body is the generated HTML output. ---> <h3>Output the passed variables</h3> <cfoutput> Form variable: #form.form_test# <br>URL variable: #URL.url_test# <br>Cookie variable: #Cookie.cookie_test# <br>CGI variable: #CGI.cgi_test#<br> <br>Note that the CGI variable is URL encoded. </cfoutput>
Sign in to your account