Docs for page functions.php

Description

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 this plugin; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA

version: $Id: functions.php 921 2007-10-16 11:48:30Z tokul $

Includes

include_once (SM_PATH.'functions/imap.php') (line 30)

include_once (SM_PATH.'functions/forms.php') (line 29)

Required functions

Functions

archive_mail_bottom_do (line 47)

Adds archive button in NaSMail 1.0-1.2

void archive_mail_bottom_do ()

archive_mail_do (line 33)

Adds archive button in NaSMail 1.3+

void archive_mail_do ()

archive_mail_loading_constants_do (line 105)

Sets plugin constants

void archive_mail_loading_constants_do ()

archive_mail_loading_prefs_do (line 77)

Loads plugin preferences

void archive_mail_loading_prefs_do ()

archive_mail_move_before_move_do (line 159)

Processes mailbox listing form actions

void archive_mail_move_before_move_do ()

archive_mail_optpage_do (line 86)

Registers option block in NaSMail options page

void archive_mail_optpage_do ()

archive_mail_save_settings (line 132)

Saves plugin settings

void archive_mail_save_settings ()

archive_mail_trim_crlf (line 635)

Callback function used to remove trailing CRLF in archive_mail_trim_fetch_response()

void archive_mail_trim_crlf ( &$value, int $key, string $value)

string $value
int $key
&$value

archive_mail_trim_fetch_response (line 583)

Removes unneed parts from untagged FETCH response

Function removes starting and trailing FETCH response tags. It also strips attachments according to user preferences.

array archive_mail_trim_fetch_response (array $aBody)

array $aBody

archive_names (line 299)

Returns string formated according to $archivefilenames setting

string archive_names (int $archivefilenames, string $email, string $date, int $c, string $subject)

int $archivefilenames: Name format. See NSM_ARCHIVE_NAME_* constants
string $email: email address
string $date: date
int $c: message counter
string $subject: subject

archive_replace_str (line 266)

Sanitizes string for unacceptable characters

return: Sanitized string

string archive_replace_str (string $temp, [string $temp2 = ' '])

string $temp: Original string
string $temp2: replacement symbol

checkincrement (line 276)

void checkincrement ( $tempsuffix)

$tempsuffix

/plugins/archive_mail/functions.php