Actions

API17

Difference between revisions of "JMailHelper"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (User contributed notes: bad link repair)
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JMailHelper==
 +
===Description===
 +
{{Description:JMailHelper}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JMailHelper|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JMailHelper|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JMailHelper}}
 
===Defined in===
 
libraries/joomla/mail/helper.php
 
===Subpackage===
 
[[Subpackage Mail/11.1|Mail]]
 
===Extends===
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::cleanAddress/11.1|cleanAddress]]
 
|[[JMailHelper::cleanAddress/11.1|cleanAddress]]
 
|Verifies that an email address does not have any extra headers injected into it.  
 
|Verifies that an email address does not have any extra headers injected into it.  
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::cleanBody/11.1|cleanBody]]
 
|[[JMailHelper::cleanBody/11.1|cleanBody]]
 
|Cleans any injected headers from the email body.  
 
|Cleans any injected headers from the email body.  
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::cleanLine/11.1|cleanLine]]
 
|[[JMailHelper::cleanLine/11.1|cleanLine]]
 
|Cleans single line inputs.  
 
|Cleans single line inputs.  
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::cleanSubject/11.1|cleanSubject]]
 
|[[JMailHelper::cleanSubject/11.1|cleanSubject]]
 
|Cleans any injected headers from the subject string.  
 
|Cleans any injected headers from the subject string.  
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::cleanText/11.1|cleanText]]
 
|[[JMailHelper::cleanText/11.1|cleanText]]
 
|Cleans multi-line inputs.  
 
|Cleans multi-line inputs.  
 
|-
 
|-
 +
|public static
 
|[[JMailHelper::isEmailAddress/11.1|isEmailAddress]]
 
|[[JMailHelper::isEmailAddress/11.1|isEmailAddress]]
 
|Verifies that the string is in a proper email address format.  
 
|Verifies that the string is in a proper email address format.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/mail/helper.php
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.mail.helper' );</source>
 
<source lang="php">jimport( 'joomla.mail.helper' );</source>
 
===See also===
 
===See also===
* [[JMailHelper|Other versions of this class]]
+
* {{JVer|11.1}} '''JMailHelper source code''' on [[jplatform:mail/helper.php|BitBucket]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage Mail/11.1|Mail]]
 +
* [[JMailHelper|Other versions of JMailHelper]]
 
{{SeeAlso:JMailHelper}}
 
{{SeeAlso:JMailHelper}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JMailHelper|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JMailHelper|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 51: Line 57:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JMailHelper]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JMailHelper]]</noinclude>

Revision as of 13:57, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JMailHelper

Description

Description:JMailHelper [Edit Descripton]

Methods

Visibility Method name Description
public static cleanAddress Verifies that an email address does not have any extra headers injected into it.
public static cleanBody Cleans any injected headers from the email body.
public static cleanLine Cleans single line inputs.
public static cleanSubject Cleans any injected headers from the subject string.
public static cleanText Cleans multi-line inputs.
public static isEmailAddress Verifies that the string is in a proper email address format.
  • Defined in libraries/joomla/mail/helper.php

Importing

jimport( 'joomla.mail.helper' );

See also

SeeAlso:JMailHelper [Edit See Also]

User contributed notes

<CodeExamplesForm />