Willkommen

Einführung

Verzeichnis-Struktur

Regeln zur Datei-Benennung

Die Plugin-PHP-Datei

Plugin-Klassen

Plugin-Klassen-Registrierung

Zeichensätze / UTF-8

Bestimmung des Zeichensatzes

Zeichensatz-Konvertierung

Hinweise

Hinweise und Tipps zur Entwicklung

Plugin-Verteilung

Erstellung von b1gMail-Plugin-Paketen

void OnUserPasswordChange($userID, $oldPasswordMD5, $newPasswordMD5, $newPasswordPlain)

array OnSearch($query)

array GetSearchCategories()

bool HandleSearchMassAction($category, $action, $items)

bool ActivateOrderItem($orderID, $userID, $cartItem)

mixed OnAuthenticate($userName, $userDomain, $passwordMD5)

int OnReceiveMail(&$mail, &$mailbox, &$user)

void BeforePageTabsAssign(&$pageTabs)

void BeforeDisplayTemplate($resourceName, &$tpl)

void AfterReceiveMail(&$mail, &$mailbox, &$user)

void AfterSuccessfulSignup($userid, $usermail)

void OnGetMail($id, $user)

void OnStartMailList($user, $draftList)

void OnEndMailList($user, $draftList)

void OnSignup($userid, $usermail)

void OnCreateTemplate(&$tpl)

void OnReadLang(&$lang_user, &$lang_client, &$lang_custom, &$lang_admin, $lang)

void OnSendMail(&$mail, $html)

void AfterSendMail($userID, $from, $to)

void OnCron()

void AfterStoreMail($mailID, &$mail, &$mailbox)

void AfterDeleteMail($mailID, &$mailbox)

void AfterMoveMails($mailIDs, $destFolderID, &$mailbox)

void AfterChangeMailFlags($mailID, $newFlags, &$mailbox)

void AfterSendSMS($success, $gatewayResult, $outboxID)

void OnSendSMS(&$text, &$type, &$from, &$to)

void OnLogin($userID)

void OnLoginFailed($userMail, $password, $reason)

void OnLogout($userID)

void OnDeleteUser($userID)

void AfterInit()

mixed DataFilename($id, $fx)

void OnMailWithoutValidRecipient(&$mail)

void FileHandler($file, $action)

void AdminHandler()

bool UserPrefsPageHandler($action)

void OnLoad()

mixed OnGetMessageFP($id, $allowOverride, &$mail)

array getNotices()

mixed getClassReplacement($class)

array getUserPages($loggedin)

bool isWidgetSuitable($for)

void renderWidget()

void renderWidgetPrefs()

Hilfs-Funktionen

string _adminLink($withSID = false)

string _templatePath($template)

string _resourcePath($template, $type)

void _closeWidgetPrefs($reload)

string GetGroupOptionValue($key, $group = 0)

void RegisterGroupOption($key, $type, $desc, $options, $default)

Verfügbare Feld-Typen

Globale Variablen

Nützliche Funktionen

void PutLog($msg, $prio, $file, $line)

string GetPostmasterMail()

bool SysteMail($from, $to, $subject, $templateName, $vars, $forUser = -1)

object _new($class, $args = array())

string getFileContents($fileName)

string DataFilename($id, $fx = ‚msg')

void ModuleFunction($function, $args = false)

void DisplayError($number, $title, $description, $text, $file, $line)

int RequestTempFile($userID, $expires = -1)

string TempFileName($tempID)

bool ReleaseTempFile($userID, $tempID)

bool ValidTempFile($userID, $tempID)

MySQL-Zugriff

Die MySQL_DB-Klasse

mixed Query($query, …)

int InsertId()

int AffectedRows()

Die MySQL_Result-Klasse

array FetchArray($type = MYSQL_BOTH)

Datei: plugins/example.skeleton.php

Einfaches Widget

Datei: plugins/example.hellowidget.php

Datei: plugins/templates/hello.widget.tpl

Datei: plugins/templates/hello.widget.prefs.tpl

Einfacher Such-Provider

Datei: plugins/example.searchfaq.php

Plugin mit Administrations-Bereich

Datei: plugins/example.acp.php

Datei: plugins/templates/acpsample.page1.tpl

Datei: plugins/templates/acpsample.page2.tpl

Plugin mit Benutzer-Einstellungen

Datei: plugins/example.userprefs.php

Datei: plugins/templates/userperfs.prefspage.tpl

Plugin mit Zeichensatz-Konvertierung

Datei: plugins/example.encoding.php

Datei: plugins/templates/encex.admin.tpl

Authentifikations-Plugin

Aktivierung des Debug-Modus

Änderungen in b1gMail 7.2