API17

Difference between revisions of "JMailHelper::cleanBody"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by the same user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JMailHelper::cleanBody|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JMailHelper::cleanBody|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JMailHelper::cleanBody ($body)
+
public static function cleanBody ($body)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 27: Line 24:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string Cleaned email body string.
string Cleaned email body string.
+
* '''Defined''' on line 58 of libraries/joomla/mail/helper.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/mail/helper.php
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JMailHelper::cleanBody source code''' on [[jplatform:mail/helper.php#cl-50|BitBucket]]
 +
* {{JVer|11.1}} Class [[JMailHelper/11.1|JMailHelper]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Mail/11.1|Mail]]
 +
* [[JMailHelper::cleanBody|Other versions of JMailHelper::cleanBody]]
 +
{{SeeAlso:JMailHelper::cleanBody}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JMailHelper::cleanBody|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JMailHelper::cleanBody|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JMailHelper/11.1|JMailHelper]]
+
===User contributed notes===
* [[JMailHelper::cleanBody|Other versions of this method]]
 
{{SeeAlso:JMailHelper::cleanBody}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 47: Line 44:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JMailHelper]][[Category:JMailHelper::cleanBody]]</noinclude>
 
<noinclude>[[Category:JMailHelper]][[Category:JMailHelper::cleanBody]]</noinclude>

Revision as of 21:21, 27 April 2011

The "API17" 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.

Joomla 11.1 JMailHelper::cleanBody[edit]

Description[edit]

Cleans any injected headers from the email body.

Template:Description:JMailHelper::cleanBody [Edit Descripton]

public static function cleanBody ($body)
Parameter Type Default Description
$body string email body string.
  • Returns string Cleaned email body string.
  • Defined on line 58 of libraries/joomla/mail/helper.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JMailHelper::cleanBody [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />