JMail/setSender: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Set the E-Mail sender
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki>
</span>
... |
m removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 50: | Line 50: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 65: | Line 65: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API15]] | |||
Revision as of 18:35, 12 May 2013
Description
Set the E-Mail sender
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
setSender($from)
| Parameter Name | Default Value | Description |
|---|---|---|
| $from | $from E-Mail address and Name of sender |
Returns
void
Defined in
libraries/joomla/mail/mail.php
Importing
jimport( 'joomla.mail.mail' );
Source Body
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)");
}
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />