User Guide
92 Chapter 2: ColdFusion Tags
Usage
If this tag specifies that a cookie is to be saved beyond the current browser session, the client
browser writes or updates the cookie in its local cookies file. Until the browser is closed, the
cookie resides in browser memory. If the
expires attribute is not specified, the cookie is not
written to the browser cookies file.
If you use this tag after the
cfflush tag on a page, ColdFusion does not send the cookie to the
browser; however, the value you set is available to ColdFusion in the Cookie scope during the
browser session.
Note: You can also create a cookie that expires when the current browser session expires by using
the cfset tag or a CFScript assignment statement to set a variable in the Cookie scope, as in <cfset
Cookie.mycookie="sugar">. To get a cookie’s value, refer to the cookie name in the Cookie
scope, as in <cfif Cookie.mycookie="oatmeal">.
You can use dots in cookie names, as the following examples show:
<cfcookie name="person.name" value="wilson, john">
<cfset cookie.person.lastname="Santiago">
To access cookies, including cookies that you set and all cookies that are sent by the client, use the
Cookie scope. For example, to display the value of the person.name cookie set in the preceding
code, use the following line:
<cfoutput>#cookie.person.name#</cfoutput>
Example
<!--- This example shows how to set/delete a cfcookie variable --->
<!--- Select users who have entered comments into sample database --->
<cfquery name = "GetAolUser" dataSource = "cfsnippets">
SELECT EMail, FromUser, Subject, Posted
FROM Comments
</cfquery>
<html>
<body>
<h3>cfcookie Example</h3>
path Optional URL, within a domain, to which the cookie applies; typically a
directory. Only pages in this path can use the cookie. By default,
all pages on the server that set the cookie can access the cookie.
path = "/services/login"
To specify multiple URLs, use multiple
cfcookie tags.
If you specify path, you must also specify
domain.
domain Required if
path
attribute is
specified.
Optional
otherwise
Domain in which cookie is valid and to which cookie content can
be sent from the user’s system. By default, the cookie is only
available to the server that set it. Use this attribute to make the
cookie available to other servers.
Must start with a period. If the value is a subdomain, the valid
domain is all domain names that end with this string. This attribute
sets the available subdomains on the site upon which the cookie
can be used.
For a
domain value that ends in a country code, the specification
must contain at least three periods; for example,
".mongo.state.us". For top-level domains, two periods are
required; for example,
".mgm.com".
You cannot use an IP address as a domain.
Attribute Req/Opt Default Description