JMailHelper: Difference between revisions
From Joomla! Documentation
Layout updates |
Updated to r1448:247ba8d88526 |
||
| 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> | ||
===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 source code | * {{JVer|11.1}} '''JMailHelper source code''' on [[jplatform:mail/helper.php|BitBucket]] | ||
* [[JMailHelper|Other versions of | * {{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> | ||
=== | ===User contributed notes=== | ||
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 53: | 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]][[Category:Platform 11.1]][[Category:JMailHelper]]</noinclude> | ||
Revision as of 23:06, 27 April 2011
JMailHelper
Description
Template: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
- JMailHelper source code on BitBucket
- Subpackage Mail
- Other versions of JMailHelper
Template:SeeAlso:JMailHelper [Edit See Also]
User contributed notes
<CodeExamplesForm />