These constants are used in the function sqgetGlobalVar(). See sqgetGlobalVar() for a description of what they mean.

• since: 1.4.0

returns true if current php version is at mimimum a.b.c

Called: check_php_version(4,1)

• int $a: a major version number
• int $b: b minor version number
• int $c: c release number

Endeavor to detect what user and group PHP is currently running as. Probably only works in non-Windows environments.

• return: Boolean FALSE is returned if something went wrong, otherwise an array is returned with the following elements: uid The current process' UID (integer) euid The current process' effective UID (integer) gid The current process' GID (integer) egid The current process' effective GID (integer) name The current process' name/handle (string) ename The current process' effective name/handle (string) group The current process' group name (string) egroup The current process' effective group name (string) Note that some of these elements may have empty values, especially if they could not be determined.
• since: 1.5.2

Detect whether or not we have a SSL secured (HTTPS) connection connection to the browser

It is thought to be so if you have 'SSLOptions +StdEnvVars' in your Apache configuration, OR if you have HTTPS set to a non-empty value (except "off") in your HTTP_SERVER_VARS, OR if you have HTTP_X_FORWARDED_PROTO=https in your HTTP_SERVER_VARS, OR if you are on port 443.

Note: HTTP_X_FORWARDED_PROTO could be sent from the client and therefore possibly spoofed/hackable. Thus, SquirrelMail ignores such headers by default. The administrator can tell SM to use such header values by setting $sq_ignore_http_x_forwarded_headers to boolean FALSE in config/config.php or by using config/conf.pl.

Note: It is possible to run SSL on a port other than 443, and if that is the case, the administrator should set $sq_https_port in config/config.php or by using config/conf.pl.

• return: TRUE if the current connection is SSL-encrypted; FALSE otherwise.
• since: 1.4.17 and 1.5.2

php_self

Attempts to determine the path and filename and any arguments for the currently executing script. This is usually found in $_SERVER['REQUEST_URI'], but some environments may differ, so this function tries to standardize this value.

Note that before SquirrelMail version 1.5.1, this function was stored in function/strings.php.

• return: The path, filename and any arguments for the current script
• since: 1.2.3

Print variable

sm_print_r($some_variable, [$some_other_variable [, ...]]);

Debugging function - does the same as print_r, but makes sure special characters are converted to htmlentities first. This will allow values like <[email protected]> to be displayed. The output is wrapped in <pre> and </pre> tags. Since 1.4.2 accepts unlimited number of arguments.

• since: 1.4.1

Retrieves a form variable, from a set of possible similarly named

form variables, based on finding a different, single field. This is intended to allow more than one same-named inputs in a single <form>, where the submit button that is clicked tells us which input we should retrieve. An example is if we have: <select name="startMessage_1"> <select name="startMessage_2"> <input type="submit" name="form_submit_1" /> <input type="submit" name="form_submit_2" /> and we want to know which one of the select inputs should be returned as $startMessage (without the suffix!), this function decides by looking for either "form_submit_1" or "form_submit_2" (both should not appear). In this example, $name should be "startMessage" and $indicator_field should be "form_submit".

NOTE that form widgets must be named with the suffix "_1", "_2", "_3" and so on, or this function will not work.

If more than one of the indicator fields is found, the first one (numerically) will win.

If an indicator field is found without a matching input ($name) field, FALSE is returned.

If no indicator fields are found, a field of $name *without* any suffix is searched for (but only if $fallback_no_suffix is TRUE), and if not found, FALSE is ultimately returned.

It should also be possible to use the same string for both $name and $indicator_field to look for the first possible widget with a suffix that can be found (and possibly fallback to a widget without a suffix).

• return: whether variable is found.

• string $name: name the name of the var to search
• mixed &$value: value the variable to return
• string $indicator_field: indicator_field the name of the field upon which to base our decision upon (see above)
• int $search: search constant defining where to look
• bool $fallback_no_suffix: fallback_no_suffix whether or not to look for $name with no suffix when nothing else is found
• mixed $default: default the value to assign to $value when nothing is found
• int $typecast: typecast force variable to be cast to given type (please use SQ_TYPE_XXX constants or set to FALSE (default) to leave variable type unmolested)

Function to verify a session has been started. If it hasn't

start a session up. php.net doesn't tell you that $_SESSION (even though autoglobal), is not created unless a session is started, unlike $_POST, $_GET and such Update: (see #1685031) the session ID is left over after the session is closed in some PHP setups; this function just becomes a passthru to sqsession_start(), but leaving old code in for edification.

Add a variable to the session.

• mixed $var: the variable to register
• string $name: the name to refer to this variable

Delete a variable from the session.

• string $name: the name of the var to delete

Recursively strip slashes from the values of an array.

• array &$array: array the array to strip, passed by reference

Sanitize a value using sm_encode_html_special_chars() or similar, but also recursively run sm_encode_html_special_chars() (or similar) on array keys and values.

If $value is not a string or an array with strings in it, the value is returned as is.

• return: The sanitized value.
• since: 1.5.2

• mixed $value: The value to be sanitized.
• mixed $quote_style: Either boolean or an integer. If it is an integer, it must be the PHP constant indicating if/how to escape quotes: ENT_QUOTES, ENT_COMPAT, or ENT_NOQUOTES. If it is a boolean value, it must be TRUE and thus indicates that the only sanitizing to be done herein is to replace single and double quotes with &#039; and &quot;, no other changes are made to $value. If it is boolean and FALSE, behavior reverts to same as if the value was ENT_QUOTES (OPTIONAL; default is ENT_QUOTES).