File/plugins/folder_notes/config_sample.php

Description

Sample Folder Notes plugin configuration file

Copyright (c) 2007 The NaSMail Project This file is part of NaSMail folder_notes plugin.

This plugin is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This plugin is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with plugin; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  • version: $Id: config_sample.php 1029 2007-11-25 07:41:42Z tokul $
Variables
array $folder_notes (line 44)

Folder notes

Setting uses multidimentional array. First array key must match mailbox name. Second array key is index. It allows to store multiple messages for same mailbox. Array value can store custom text or predefined FNOTE_* constant. All FNOTE_* constants are integers and custom messages can't be equal to integer.

FNOTE constants allow to use standard translated messages.

Currently supported FNOTE constants: FNOTE_TRASH or 1 = "This folder stores deleted messages." FNOTE_SPAM or 2 = "This folder stores spam messages." FNOTE_PURGE_TRASH or 3 = "Messages older than %d day(s) are automatically removed."

Plugin defaults to empty array

integer $folder_notes_trash_purge (line 60)

Days of automatic trash cleanup

Setting is used for "Messages older than %d day(s) are automatically removed." message. It allows to warn end users about automatic mailbox cleanup functions used in some IMAP servers.

Plugin defaults to 7 days.

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