File/plugins/html_mail/config_sample.php

Description
Description | Variables

Sample html_mail plugin configuration file

  • version: $Id: config_sample.php 633 2007-08-20 07:59:55Z tokul $
Variables
Description | Variables
boolean $allowEmoticons (line 170)

Emoticons controls

if you have patched the SquirrelMail source to allow the use of emoticons functionality and want to allow users to make use of them, set this value to

  1. set to zero to disable

string $customStyle (line 160)

Editor style

if you'd like to customize the HTML editor, you may define its CSS style here... leave as an empty string for default behavior

note that a font-size of about 16 seems to be more appropriate than the default size

$customStyle = ''; $customStyle = 'body { background-color: yellow; color: black; font-family: verdana,sans-serif; font-size:12 } p { font-width: bold; }';

integer $fck_spell_checker (line 54)

FCKeditor: used spellchecking utility

Allows to select used spellchecking utility. ieSpell does not require any server-side configuration, but only runs in Microsoft Internet Explorer on Windows operating systems. ASpell is a much better choice if you are able to install it on your server

  1. = ASpell
  2. = ieSpell

boolean $fully_loaded (line 189)

Plugin controls

set this to 1 if you want to turn on all bells and whistles, including all HTMLArea plugins

integer $html_editor_style (line 18)

Common: html editor type

Sets default html editor type. 1 - FCKeditor, 2 - HTMLarea, 3 - TinyMCE, any other value - FCKeditor. End users see editor selection options only when advanced_settings plugin is installed.

  • since: 2.6
string $html_mail_aspell_path (line 73)

FCKeditor|TinyMCE: used Aspell binary

set the path to your ASpell binary. name without path can be used, if binary is available in PATH.

Examples are included here for both Windows and Linux users. Setting is used, if you select ASpell as your FCKEditor's spell checker or PspellShell spellcheck in TinyMCE configuration.

Linux: $html_mail_aspell_path = 'aspell';

Windows: $html_mail_aspell_path = '"C:\Program Files\Aspell\bin\aspell.exe"';

integer $html_mail_browser (line 126)

FCKeditor: file browser controls

Setting is a sum of four values. Zero value disables setting.

  1. - disable all
  2. - enable link browser
  3. - enable image browser
4 - enable flash browser

For example: if you want only image and flash, you should set it to 6 (0+0+2+4=6)

Setting is always evaluated bitwise. For example 15 will turn on all three settings (0+1+2+4+8=15) and 16 will turn off all settings (0+0+0+0+0+16=16). Don't set it to value higher that 7, if you don't want to turn on new upload features that might be introduced in future FCKeditor and HTML Mail plugin versions.

Setting depends on $html_mail_upload_dir and $html_mail_upload_path settings. If these settings are empty, interface won't enable browser and upload features.

  • since: 2.6
string $html_mail_dicts (line 229)

TinyMCE: Available speller dictionaries. First dictionary is default one.

Multiple speller dictionaries are separated with commas.

Dictionaries must be supported by used speller library. Pspell and PspellShell libraries depend on dictionaries installed on webserver. GoogleSpell depends on languages supported by Google Spell API.

NOX spell supports English (en), German(de), Spanish (es), French (fr), Italian (it), Dutch (nl), Portuguese (pt), Russian (ru), Indonesian (id), Catalan (ca), Czech (cs), Estonian (et), Greek (el), Hindi (hi), Hebrew (he), Croatian (hr), Lithuanian (lt), Latvian (lv), Polish (pl), Ukrainian (uk), Romanian (ro), Slovak (sk), Slovenian (sl), Turkish (tr), Danish (da), Norwegian (no), Finish (fi), Svedish (sv). I don't have information about languages supported in GoogleSpell.

  • since: 2.6
string $html_mail_link_server (line 34)

Common: address of link server

String, no trailing slash. If setting is set to empty string, plugin will calculate it from NaSMail get_location() function.

Link server allows to link to files without revealing webmail location and without using https:// links. Server must support same uploads path as the one used in $html_mail_upload_path and $html_mail_upload_dir settings. It should also store images from plugins/html_mail/fckeditor/editor/images/smiley/msn directory. See warnings in $html_mail_upload_dir comments.

  • since: 2.6
string $html_mail_tinymce_speller (line 209)

TinyMCE: Speller library used by TinyMCE spellchecker plugin

Possible values '' - (default) empty setting. Spellcheck is disabled 'PspellShell' - Use command line ispell/aspell|pspell utility. See also $html_mail_aspell_path setting. 'GoogleSpell' - Use google spell api. If you want to use NOX spellcheck API instead of Google Spell, you must modify tinymce/plugins/spellchecker/classes/TinyGoogleSpell.class.php library. 'Pspell' - Use PHP Pspell extension. See also $html_mail_aspell_path

Case sensitivity depends on used OS. Scripts must be able to locate appropriate plugins/html_mail/tinymce/plugins/spellchecker/classes/Tiny*.class.php library based on setting value.

  • since: 2.6
integer $html_mail_uploads (line 140)

FCKeditor: file upload controls

Setting is a sum of four values.

  1. - disable all
  2. - upload links
  3. - upload images
4 - upload flash See $html_mail_browser for more information.

  • since: 2.6
string $html_mail_upload_dir (line 101)

FCKeditor: full path to uploads directory full path with trailing slash.

If scripts are used on Windows, don't use backslashes. All directory delimiters must use slashes. For example: 'c:/uploads/' and not 'c:\\uploads\\' or 'c:\uploads\'

WARNING: uploads directory should not allow any kind of server side scripting. directory indexes should be disabled. It is strongly recommended to set some quotas on uploads directory or use dedicated partition and perform periodic cleanups. It is strongly recommended to inform users that older files will be removed from uploads directory after some time and their html emails with inline images/flash files will display broken links instead of linked images/flash files.

  • since: 2.6
string $html_mail_upload_path (line 81)

FCKeditor: absolute url to uploads directory

absolute url with trailing slash

  • since: 2.6
boolean $use_spell_checker (line 180)

Spellchecker controls

set this to 1 if you'd like to use the integrated spell checker (make sure you've got your web server and Perl interpreter set up correctly, for more info, see the README file)... set to zero to disable

Documentation generated on Sun, 22 Nov 2009 17:36:22 +0200 by phpDocumentor 1.4.3