JMailHelper: Difference between revisions
From Joomla! Documentation
m →User contributed notes: moving preparation |
m preparing for archive only |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JMailHelper== | =={{JVer|11.1}} JMailHelper== | ||
===Description=== | ===Description=== | ||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::cleanAddress | |[[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. | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::cleanBody | |[[API17:JMailHelper::cleanBody|cleanBody]] | ||
|Cleans any injected headers from the email body. | |Cleans any injected headers from the email body. | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::cleanLine | |[[API17:JMailHelper::cleanLine|cleanLine]] | ||
|Cleans single line inputs. | |Cleans single line inputs. | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::cleanSubject | |[[API17:JMailHelper::cleanSubject|cleanSubject]] | ||
|Cleans any injected headers from the subject string. | |Cleans any injected headers from the subject string. | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::cleanText | |[[API17:JMailHelper::cleanText|cleanText]] | ||
|Cleans multi-line inputs. | |Cleans multi-line inputs. | ||
|- | |- | ||
|public static | |public static | ||
|[[JMailHelper::isEmailAddress | |[[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. | ||
|- | |- | ||
| Line 43: | Line 41: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JMailHelper source code''' on [[jplatform:mail/helper.php|BitBucket]] | * {{JVer|11.1}} '''JMailHelper source code''' on [[jplatform:mail/helper.php|BitBucket]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage Mail | * {{JVer|11.1}} Subpackage [[API17:Subpackage Mail|Mail]] | ||
* [[JMailHelper|Other versions of JMailHelper]] | * [[API17:JMailHelper|Other versions of JMailHelper]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JMailHelper | category=JMailHelper | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
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