Default Settings
The default settings file (defaults.ini in the root of your tmda-cgi
install) determines the default look and feel for each user. Feel free to
modify these settings. Users can always override the defaults file with their
own preferences.
The default settings file is broken into sections for easy organization. The
value of each parameter is as follows:
NoOverride:InstallBackupTGZ
Filename of an archive the installer can create to backup any files which
will be overritten in the install process. This file will be used again
to restore these files if the user ever uninstalls.
Example:
[NoOverride]
InstallBackupTGZ = backup.tgz |
Default: TMDA_backup.tgz
NoOverride:InstallInstruct
Any special instructions your users will need after installing TMDA. If
left blank, no special instructions will be given
Example:
[NoOverride]
InstallInstruct = |
Default: You will need to change the outgoing mail settings on your e-mail
client to make full use of TMDA's features. Please set your SMTP port to
8025 (instead of 25). Contact the helpdesk if you need some assistance in
doing this.
NoOverride:MayEditFilters
Allow users to edit their filter files with tmda-cgi.
Example:
[NoOverride]
MayEditFilters = No |
Default: Yes
NoOverride:MayEditLocalConfig
Allow users to edit their local config files in file view
mode with tmda-cgi. Setting this to "No" will still allow users
to edit in form view mode or view (but not save) in file view mode.
Example:
[NoOverride]
MayEditLocalConfig = No |
Default: Yes
NoOverride:MayEditTemplates
Allow users to edit their template files with tmda-cgi.
Example:
[NoOverride]
MayEditTemplates = No |
Default: Yes
NoOverride:MayInstall
Allow users to install TMDA on their account with tmda-cgi.
Example:
[NoOverride]
MayInstall = No |
Default: Yes
NoOverride:MaySearchPendList
Allow users to search their pending lists.
Note, due to the average large pending list size, searches may take
great amounts of CPU time. Administrators of systems with limited
resources may want to disable this.
Example:
[NoOverride]
MaySearchPendList = No |
Default: Yes
NoOverride:Sendmail
Override the default location of sendmail (/usr/sbin/sendmail).
This parameter is used to forward spam to
SpamCop
Example:
[NoOverride]
Sendmail = /usr/local/bin/sendmail |
Default: None.
NoOverride:SpamCopFilter
Optional message filter to use before reporting spam.
The filter program should expect data on stdin and output to stdout.
Example:
[NoOverride]
SpamCopFilter = /home/user/sausr/bin/spamassassin -x -d |
Default: None.
NoOverride:UninstallBackupTGZ
Filename of an archive the uninstaller can create to backup any files
which will be overritten in the uninstall process. This file will be used
again to restore these files if the user ever re-installs.
Example:
[NoOverride]
UninstallBackupTGZ = backup.tgz |
Default: TMDA_restore.tgz
NoOverride:UninstallInstruct
Any special instructions your users will need after uninstalling TMDA. If
left blank, no special instructions will be given.
Example:
[NoOverride]
UninstallInstruct = |
Default: You will need to change the outgoing mail settings on your e-mail
client. Please set your SMTP port to 25 (instead of 8025). Contact the
helpdesk if you need some assistance in doing this.
NoOverride:UserSplit
Regular expression to split virtual user login names.
Default: ^(.+)[%@](.+)$ (split on "@" or "%")
NoOverride:VPop
Path to real virtual user home directory. (Available for use in skel files.)
Default: /home/vpopmail
NoOverride:VPopBin
Path to virtual user binaries directory. (Available for use in skel files.)
Default: /home/vpopmail/bin
NoOverride:WhichTar
Path to tar program.
Default: /bin/tar
General:CSEncoding
Set the default encoding for all tmda-cgi pages. It's generally safe to
leave this one set to the defaults. Internationally encoded e-mails which
do not identify their codeset will not render correctly unless this setting
matches the content.
If many international e-mails are not rendering correctly, try resetting
this to match their character set.
Example:
[General]
CSEncoding = big5 |
Default: iso-8859-1
General:SpamCopAddr
E-mail address to use when forwarding spam to
SpamCop
I recommend you leave this setting blank. Instead of providing a single
e-mail address for all your users to share, encourage them to get their own
SpamCop address.
Default: None.
General:Theme
Theme to use if the user has not yet selected one of their own.
Example:
Default: Blue
General:UseJSConfirm
Enables a pop-up confirmation box before any irreversible actions, such as
deleting or blacklisting a message. Disable this option if most of your
users have browsers without Javascript or where Javascript is disabled.
Such users will have to disable Javascript confirmation to be able to
delete or blacklist messages.
Example:
[General]
UseJSConfirm = 0 |
Default: 1 (enabled)
GenAddr:Keyword
Default keyword to use on first run.
Default: None.
GenAddr:ExpireNum
Default expiration to use on first run.
Default: 30
GenAddr:ExpireUnit
Default expiration to use on first run.
Default: d (days)
GenAddr:Sender
Default to keyword to use on first run.
Default: None.
Login:InitPage
First page to present to a user after they log in. Almost any cmd
(look at the URL when selecting a page in tmda-cgi) is valid, but I
recommend you use either pending or gen_addr.
Example:
[Login]
InitPage = gen_addr |
Default: pending
PendingList:CropDest
Maximum length of an e-mail recipient before it will be cropped in list
view.
Please note that the theme which ships with tmda-cgi does not display
e-mail recipient. This parameter will only be of interest if you create
a theme which includes %(To)s.
Example:
[PendingList]
CropDest = 40 |
Default: 25
PendingList:CropSender
Maximum length of a sender's e-mail address before it will be cropped in
list view.
Example:
[PendingList]
CropSender = 40 |
Default: 25
PendingList:CropSubject
Maximum length of an e-mail subject before it will be cropped in list
view.
Example:
[PendingList]
CropSubject = 50 |
Default: 40
PendingList:DateFormat
Format string for time.strftime(),
used when displaying message dates in pending list view.
time.strftime() pads numeric fields with zeros to make them fixed-width
fields. To suppress the zero-padding behavior, prefix any of the listed
directives with "Z-".
Example:
[PendingList]
DateFormat = %m/%d/%y |
Default: %a Z-%m/Z-%d
PendingList:PagerSize
Number of e-mails to show on a page.
Example:
[PendingList]
PagerSize = 25 |
Default: 15
PendingList:ShowAddr
Method for displaying e-mail addresses in list mode. May be
"Name", "Address", or "All".
Example:
[PendingList]
ShowAddr = All |
Default: Name
PendingList:ShowDelete
Whether or not to show the delete column in the pending list. May be
"Yes" or "No".
Example:
[PendingList]
ShowDelete = Yes |
Default: No
PendingList:ShowBlack
Whether or not to show the blacklist column in the pending list. May be
"Yes" or "No".
Example:
[PendingList]
ShowBlack = Yes |
Default: No
ViewPending:AltPref
Specify a preferred e-mail format if multiple options are present.
Example:
[ViewPending]
AltPref = text/html |
Default: text/plain
ViewPending:AllowTags
Specify which tags may be included when displaying an HTML-formatted
e-mail. Any tag not listed will be removed.
Example:
[ViewPending]
AllowTags = br,p |
Default: a,b,br,center,div,font,hr,i,p,table,td,th,tr
ViewPending:BlockRemove
Specify which blocks of HTML must be removed before displaying an
HTML-formatted e-mail. Not only will any tag listed be removed, all text
and/or tags between the start and end tags will also be
removed.
Example:
[ViewPending]
BlockRemove = script |
Default: head,noframes,noscript,script,title
ViewPending:EmailClass
Default font used when viewing e-mails. These fonts may be customized in
the styles.css file.
Example:
[ViewPending]
EmailClass = fixed |
Default: proportional
ViewPending:Headers
Show only headers listed in SUMMARY_HEADERS
(short) or show all headers (all).
Example:
[ViewPending]
Headers = all |
Default: short
AccessPaths
tmda-cgi allows users to view and/or edit text files such as filters,
lists, configuration files, and templates. These editors/viewers could be
exploited by a devious user. To minimize your risk, the AccessPaths
section allows you to specify where these files may be located. Unless a
full file path matches one of the regular expressions listed, it will not be
brought up in an text box.
Note: If you do not trust your users, be sure to set
either
defaults.ini:
[NoOverride]
MayEditLocalConfig = No |
or
/etc/tmdarc:
A devious user could easily put executable code in their local
configuration file which would allow them access to any file not protected
by restrictive file permissions.
Default:
[AccessPaths]
A = ^%(Home)s/
B = ^/etc/tmdarc$ |
|
