JMailHelper: Difference between revisions
From Joomla! Documentation
Bulk upload by Doxiki2 |
m preparing for archive only |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
=={{JVer|11.1}} JMailHelper== | |||
===Description=== | |||
{{ | |||
== | |||
=== | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
!Visibility | |||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
|[[JMailHelper::cleanAddress | |public static | ||
|[[API17:JMailHelper::cleanAddress|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. | ||
|- | |- | ||
|[[JMailHelper::cleanBody | |public static | ||
|[[API17:JMailHelper::cleanBody|cleanBody]] | |||
|Cleans any injected headers from the email body. | |Cleans any injected headers from the email body. | ||
|- | |- | ||
|[[JMailHelper::cleanLine | |public static | ||
|[[API17:JMailHelper::cleanLine|cleanLine]] | |||
|Cleans single line inputs. | |Cleans single line inputs. | ||
|- | |- | ||
|[[JMailHelper::cleanSubject | |public static | ||
|[[API17:JMailHelper::cleanSubject|cleanSubject]] | |||
|Cleans any injected headers from the subject string. | |Cleans any injected headers from the subject string. | ||
|- | |- | ||
|[[JMailHelper::cleanText | |public static | ||
|[[API17:JMailHelper::cleanText|cleanText]] | |||
|Cleans multi-line inputs. | |Cleans multi-line inputs. | ||
|- | |- | ||
|[[JMailHelper::isEmailAddress | |public static | ||
|[[API17:JMailHelper::isEmailAddress|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=== | ||
* [[ | * {{JVer|11.1}} '''JMailHelper source code''' on [[jplatform:mail/helper.php|BitBucket]] | ||
{{ | * {{JVer|11.1}} Subpackage [[API17:Subpackage Mail|Mail]] | ||
* [[API17:JMailHelper|Other versions of JMailHelper]] | |||
===Examples=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JMailHelper | category=JMailHelper | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude> | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> | ||
Latest revision as of 03:25, 25 March 2017
JMailHelper
Description
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
User contributed notes
Code Examples