cfheader

Description

Generates custom HTTP response headers to return to the client.

Category

Data output tags, Page processing tags

Syntax

<cfheader 
   name = "header_name"
   value = "header_value"
   charset="charset">
or
<cfheader 
   statusCode = "status_code"
   statusText = "status_text">

See also

cfcache, cfflush, cfhtmlhead, cfinclude, cfsetting, cfsilent, cfcontent

History

ColdFusion MX 6.1: Changed behavior for the name attribute: cfheader name="Content-Disposition" uses the default file character encoding to encode this header's value, so the name of a file can include characters in the character encoding used in the file.

Attributes

Attribute Req/Opt Default Description

name

Required if statusCode not specified

 

Header name.

value

Optional

 

HTTP header value.

charset

Optional

UTF-8

The character encoding in which to encode the header value. The following list includes commonly used values:

  • utf-8
  • iso-8859-1
  • windows-1252
  • us-ascii
  • shift_jis
  • iso-2022-jp
  • euc-jp
  • euc-kr
  • big5
  • euc-cn
  • utf-16

For more information about character encodings, see
www.w3.org/International/O-charset.html.

statusCode

Required if name not specified

 

Number. HTTP status code.

statusText

Optional

 

Explains the status code.

Usage

If you use this tag after the cfflush tag on a page, an error is thrown.

Example

<h3>cfheader Example</h3>

<p>cfheader generates custom HTTP response headers to return to the client. 
<p>This example forces browser client to purge its cache of requested file. 
<cfheader name="Expires" value="#GetHttpTimeString(Now())#">

View comments in LiveDocs