Docs for page sasql

Description

API functions:

Check addresses against the white/blacklists (stubbed)
Add/remove addresses to the lists (stubbed)
Get/set preferences (stubbed)
Purge spam folder (done)

one to remove whitelist entries not in the address book.)

This file is part of NaSMail sasql plugin. It is based on SquirrelMail sasql 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: sasql_api.php 921 2007-10-16 11:48:30Z tokul $

Includes

include_once (SM_PATH.'plugins/sasql/functions.php') (line 41)

include_once (SM_PATH.'plugins/sasql/sasql_db.php') (line 40)

include_once (SM_PATH.'include/load_prefs.php') (line 39)

Functions

sasql_addAddressToWBList (line 158)

void sasql_addAddressToWBList ( $username, $address, $list)

$username
$address
$list

sasql_addressInWBList (line 120)

void sasql_addressInWBList ( $username, $address, $list)

$username
$address
$list

sasql_getPreference (line 168)

void sasql_getPreference ( $username, $preference)

$username
$preference

sasql_getPreference_multiple (line 173)

void sasql_getPreference_multiple ( $username, $preference)

$username
$preference

sasql_purgeSpam (line 58)

Delete the contents of the user's Spam folder and all sub folders.

return: Always returns true.

boolean sasql_purgeSpam ([string $folder = ''])

string $folder: If not passed, the global variable, $spam_folder, will be used.

sasql_removeAddressFromWBList (line 163)

void sasql_removeAddressFromWBList ( $username, $address, $list)

$username
$address
$list

sasql_setPreference (line 178)

void sasql_setPreference ( $username, $preference, $value)

$username
$preference
$value

sasql_setPreference_multiple (line 183)

void sasql_setPreference_multiple ( $username, $preference, $values)

$username
$preference
$values

sasql_syncABookWithWList (line 125)

void sasql_syncABookWithWList ( $username, [ $remove = 0])

$username
$remove

/plugins/sasql/sasql_api.php