cfcookie

Overview ColdFusion Open BlueDragon Lucee

Defines web browser cookie variables, including expiration and security options.

Attributes

Name Required Type Default Description
10
casesensitive No Boolean false If cookie name is case sensitive or not
domain No String 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.
4
encode No if set to true, Railo url encodes the given name and value if necessary.
10
4
encodevalue No Boolean true If cookie value should be encoded or not
expires No Object Expiration of cookie variable. * The default: the cookie expires when the user closes the browser, that is, the cookie is "session only". * A date or date/time object (for example, 10/09/97) * A number of days (for example, 10, or 100) * now: deletes cookie from client cookie.txt file (but does not delete the corresponding variable the Cookie scope of the active page). * never: The cookie expires in 30 years from the time it was created (effectively never in web years).
9
4
httpOnly No Boolean Specify whether coockie is http coockie or not
name Yes String Name of cookie variable. CFML converts cookie names to all-uppercase. Cookie names set using this tag can include any printable ASCII characters except commas, semicolons or white space characters.
path No String 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"
10
4
preservecase No Boolean false Flag to indicate if case of the value should be preserved
secure No Boolean If browser does not support Secure Sockets Layer (SSL) security, the cookie is not sent. To use the cookie, the page must be accessed using the https protocol.
value No String Value to assign to cookie variable. Must be a string or variable that can be stored as a string.