JMail/setSender

The "API16" 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[edit]

Set the E-Mail sender

Syntax[edit]

setSender($from)

Parameter Name	Default Value	Description
$from		$from E-Mail address and Name of sender

Returns[edit]

void

Defined in[edit]

libraries/joomla/mail/mail.php

Importing[edit]

jimport( 'joomla.mail.mail' );

Source Body[edit]

public function setSender($from)
{
        // If $from is an array we assume it has an address and a name
        if (is_array($from))
        {
                $this->From     = JMailHelper::cleanLine($from[0]);
                $this->FromName = JMailHelper::cleanLine($from[1]);
        // If it is a string we assume it is just the address
        } elseif (is_string($from)) {
                $this->From = JMailHelper::cleanLine($from);
        // If it is neither, we throw a warning
        } else {
                JError::raiseWarning(0, "JMail::  Invalid E-Mail Sender: $from", "JMail::setSender($from)");
        }
}

Examples[edit]

Code Examples[edit]

API16