API16:JMail/getInstance
From Joomla! Documentation
Description
Returns the global e-mail object, only creating it if it doesn't already exist.
Syntax
static getInstance($id= 'Joomla')
| Parameter Name | Default Value | Description |
|---|---|---|
| $id | 'Joomla' | $id The id string for the instance [optional] |
Returns
object The global object
Defined in
libraries/joomla/mail/mail.php
Importing
jimport( 'joomla.mail.mail' );
Source Body
public static function getInstance($id = 'Joomla')
{
static $instances;
if (!isset ($instances)) {
$instances = array ();
}
if (empty($instances[$id])) {
$instances[$id] = new JMail();
}
return $instances[$id];
}
Examples
Code Examples