Joomla! Documentation™

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Returns a reference to a global e-mail object, only creating it if it doesn't already exist.

<! removed transcluded page call, red link never existed >

Syntax

& 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

function & getInstance($id = 'Joomla')
{
        static $instances;

        if (!isset ($instances)) {
                $instances = array ();
        }

        if (empty ($instances[$id])) {
                $instances[$id] = new JMail();
        }

        return $instances[$id];
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />