API16

JMail/setBody: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JMail/setBody}}
 


===Syntax===
===Syntax===
Line 41: Line 41:




{{subst:SeeAlso:JMail/setBody}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=setBody
  category=setBody
  category=JMail
  category=JMail
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:53, 25 March 2017

Description

Set the E-Mail body



Syntax

setBody($content)
Parameter Name Default Value Description
$content $content Body of the e-mail

Returns

void

Defined in

libraries/joomla/mail/mail.php

Importing

jimport( 'joomla.mail.mail' );

Source Body

public function setBody($content)
{
        /*
         * Filter the Body
         * TODO: Check for XSS
         */
        $this->Body = JMailHelper::cleanText($content);
}



Examples

Code Examples