Lucee Function Reference

Function ESAPIENCODE

This Function is deprecated
Encodes the given string for safe output to reduce the risk of Cross Site Scripting attacks.

Example

esapiencode(string encodeFor,string string,[boolean canonicalize,[string dialect]]):string

Category

ESAPI,CSS,DN,HTML,JavaScript,ldap,URL,SQL,VBScript,XML

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
encodeFor string  Yes   encode for what, valid values are:
  • css: for output inside Cascading Style Sheets (CSS)
  • dn: for output in LDAP Distinguished Names
  • html: for output inside HTML
  • html_attr: for output inside HTML Attributes
  • javascript: for output inside Javascript
  • ldap: for output in LDAP queries
  • url: for output in URL
  • sql: for output in a query
  • vbscript: for output inside vbscript
  • xml: for output inside XML
  • xml_attr: for output inside XML Attributes
  • xpath: for output in XPath  
    • string string  Yes   string to encode  
    canonicalize boolean  No false If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.  
    dialect string  No   Only used when "encodeFor" is set to "sql". This defines the SQL dialect used. Possible values are:
    * db2
    * mysql_ansi
    * mysql
    * oracle