- Description
-
Class trees
Index of elements
Todo List
Interfaces
Phpfox_Cache_Interface- Phpfox_Database_Interface
- Phpfox_Gateway_Interface
- Phpfox_Image_Interface
- Phpfox_Mail_Interface
- Classes
Database_Driver_Mssql- Database_Driver_Oracle
- Database_Driver_Postgres
- Database_Driver_Sqlite
- Phpfox
- Phpfox_Ajax
- Phpfox_Api
- Phpfox_Archive
- Phpfox_Archive_Export
- Phpfox_Archive_Extension_Tar
- Phpfox_Archive_Extension_Xml
- Phpfox_Archive_Extension_Zip
- Phpfox_Archive_Import
- Phpfox_Archive_Support
- Phpfox_Cache
Phpfox_Cache_Abstract- Phpfox_Cache_Storage_File
- Phpfox_Cache_Storage_Memcache
- Phpfox_Cdn
- Phpfox_Cdn_Abstract
- Phpfox_Cdn_Module_S3
- Phpfox_Component
- Phpfox_Cron
- Phpfox_Database
- Phpfox_Database_Dba
- Phpfox_Database_Driver_Mysql
- Phpfox_Database_Driver_Mysqli
- Phpfox_Database_Export
- Phpfox_Database_Support
- Phpfox_Date
- Phpfox_Debug
- Phpfox_Diff_Md5
- Phpfox_Editor
- Phpfox_Error
- Phpfox_File
- Phpfox_File_Minimize
- Phpfox_Ftp
- Phpfox_Gateway
- Phpfox_Gateway_Api_2checkout
- Phpfox_Gateway_Api_Paypal
- Phpfox_Hash
- Phpfox_Image
- Phpfox_Image_Abstract
- Phpfox_Image_Helper
- Phpfox_Image_Library_Gd
- Phpfox_Locale
- Phpfox_Mail
- Phpfox_Mail_Driver_Phpmailer_Mail
- Phpfox_Mail_Driver_Phpmailer_Smtp
- Phpfox_Module
- Phpfox_Pager
- Phpfox_Parse_Bbcode
- Phpfox_Parse_Css
- Phpfox_Parse_Format
- Phpfox_Parse_Input
- Phpfox_Parse_Output
- Phpfox_Parse_Wiki
- Phpfox_Plugin
- Phpfox_Process
- Phpfox_Request
- Phpfox_Search
- Phpfox_Search_Inline
- Phpfox_Server
- Phpfox_Service
- Phpfox_Session
- Phpfox_Session_Handler
- Phpfox_Session_Handler_Default
- Phpfox_Session_Handler_File
- Phpfox_Session_Handler_Memcache
- Phpfox_Session_Storage_Cookie
- Phpfox_Session_Storage_Session
- Phpfox_Setting
- Phpfox_Spam
- Phpfox_Spam_Hash
- Phpfox_Template
- Phpfox_Url
- Phpfox_Validator
- Phpfox_Xml_Builder
- Phpfox_Xml_Parser
Functions
d- e
- p
Files
2checkout.class.php- abstract.class.php
- abstract.class.php
- abstract.class.php
- ajax.class.php
- api.class.php
- archive.class.php
- bbcode.class.php
- builder.class.php
- cache.class.php
- cdn.class.php
- component.class.php
- cookie.class.php
- cron.class.php
- css.class.php
- database.class.php
- date.class.php
- dba.class.php
- debug.class.php
- default.class.php
- editor.class.php
- error.class.php
- export.class.php
- export.class.php
- file.class.php
- file.class.php
- file.class.php
- format.class.php
- ftp.class.php
- gateway.class.php
- gd.class.php
- handler.class.php
- hash.class.php
- hash.class.php
- helper.class.php
- image.class.php
- import.class.php
- inline.class.php
- input.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- interface.class.php
- locale.class.php
- mail.class.php
- mail.class.php
- md5.class.php
- memcache.class.php
- memcache.class.php
- minimize.class.php
- module.class.php
- mssql.class.php
- mysql.class.php
- mysqli.class.php
- oracle.class.php
- output.class.php
- pager.class.php
- parser.class.php
- paypal.class.php
- phpfox.class.php
- plugin.class.php
- postgres.class.php
- process.class.php
- request.class.php
- s3.class.php
- search.class.php
- server.class.php
- service.class.php
- session.class.php
- session.class.php
- setting.class.php
- smtp.class.php
- spam.class.php
- sqlite.class.php
- support.class.php
- support.class.php
- tar.class.php
- template.class.php
- url.class.php
- validator.class.php
- wiki.class.php
- xml.class.php
- zip.class.php
Template-
- Classes
- Phpfox_Template_Cache
- Files
- cache.class.php
Phpfox_Mail
mixed
$_aMessage
= null (line 104)
ARRAY of loading a phrase or STRING of we are passing the message directly.
mixed
$_aMessagePlain
= null (line 83)
ARRAY of loading a phrase or STRING of we are passing the message directly.
mixed
$_aSubject
= null (line 48)
ARRAY if loading a phrase or STRING if we are passing a subject.
array
$_aUsers
= null (line 76)
ARRAY of users to email and their information.
bool
$_bMessageHeader
= true (line 97)
Controlls if we should include the default header in the message. Default is TRUE.
bool
$_bSendToSelf
= false (line 90)
TRUE to send the message to ourself and FALSE to not.
mixed
$_mTo
= null (line 41)
STRING or ARRAY of emails or users to send the emai to.
object
$_oMail
= null (line 34)
Object of the 3rd party library we are using to send the actual image.
string
$_sFromEmail
= null (line 62)
The email of the person sending the email.
string
$_sFromName
= null (line 55)
The name of the person sending the email.
string
$_sNotification
= null (line 69)
Notification ID to be used to check if a user has privacy settings on receiving an email.
Constructor __construct (line 111)
Class constructor that loads a specific method of sending emails (sendmail or smtp)
- string $sMethod: Method to send an email (sendmail or smtp)
aUser (line 254)
We load users information in our send() method, however you can also load users by passing an array of their information with this method.
- array $aUser: ARRAY of users information.
checkEmail (line 272)
Email address validator based on http://www.linuxjournal.com/article/9585 and RFC 2821 Uses recursion for arrays
- mixed $mEmail: array|string
fromEmail (line 188)
Email of the person sending out this email.
- string $sFromEmail: Email.
fromName (line 162)
The name of the person sending out the email.
- string $sFromName: Persons name.
message (line 214)
Message of the email.
- mixed $aMessage: ARRAY of loading a phrase or STRING of we are passing the message directly.
messageHeader (line 227)
Identify if we should load the message header we include by default.
- bool $bMessageHeader: Controlls if we should include the default header in the message. Default is TRUE.
messagePlain (line 240)
Message of the email (Plain Text).
- mixed $aMessage: ARRAY of loading a phrase or STRING of we are passing the message directly.
notification (line 201)
Notification param for this specific email to check a users privacy settings.
- string $sNotification: Param of the notification.
send (line 300)
Method to send out the email.
Checks: (message || to) === null -> return false; (sFromName || sFromEmail) === null -> getParam(core. (Notification) assumes to is an array of integers, otherwise return false
- $bDoCheck
sendToSelf (line 175)
Send a copy to our own email.
- bool $bSendToSelf: TRUE will send a copy and FALSE will not.
subject (line 149)
Subject of the email.
- mixed $aSubject: ARRAY if loading a phrase or STRING if we are passing a subject.
test (line 122)
Run a test if we are able to send out an email using the default method being loaded.
- array $aVals: ARRAY of values to test.
to (line 136)
Identify who this email will be sent to. Can be an actual email or a user ID or an array of emails or user IDs.
- mixed $mTo: ARRAY of emails/users or STRING of email/user
_cache (line 523)
- $sEmail
- $sSubject
- $sTexPlain
- $sTextHtml
- $sFromName
- $sFromEmail
_checkEmail (line 537)
Checks to validate an email.
- string $sEmail: email to check
- boolean $bDoDnsCheck: http://php.net/checkdnsrr check for domain name, this could slow down the function so use wisely
Documentation generated on Tue, 28 Sep 2010 10:36:41 +0200 by phpDocumentor 1.4.0a2