Class: Base_MailCommon

Source Location: /modules/Base/Mail/MailCommon_0.php

Class Base_MailCommon

Class Overview

Default abstract class for AdminInterface...

You can use it for default admin_access and admin_caption functions. Access: Module administrator Caption: <module_name> module

Located in /modules/Base/Mail/MailCommon_0.php [line 18]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_AdminModuleCommon
            |
            --Base_MailCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Base_AdminModuleCommon

Base_AdminModuleCommon::admin_access()

Base_AdminModuleCommon::admin_caption()

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	admin_access()	For internal use only.
static void	admin_caption()	For internal use only.
static void	new_mailer()
static true	send()	Sends an email.

[ Top ]

Methods

static method admin_access [line 29]

static void admin_access(
)

For internal use only.

API Tags:

Access:

public

Redefinition of:

Base_AdminModuleCommon::admin_access()

[ Top ]

static method admin_caption [line 22]

static void admin_caption(
)

For internal use only.

API Tags:

Access:

public

Redefinition of:

Base_AdminModuleCommon::admin_caption()

[ Top ]

static method new_mailer [line 73]

static void new_mailer(
)

API Tags:

Access:

public

[ Top ]

static method send [line 46]

static true send(
string
$to, string
$subject, string
$body, [string
$from_addr = null], [string
$from_name = null] 
)

Sends an email.

Server settings are stored in epesi variables and can be changed by administrator.

Parameters:

string	$to:	recipent
string	$subject:	subject
string	$body:	email message
string	$from_addr:	sender
string	$from_name:	sender's name

API Tags:

Return:	on success, false otherwise
Access:	public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:43:29 -0500 by phpDocumentor 1.4.2

	epesi-base mail

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]