Difference between revisions of "JMail"
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}} JMail== | |
| − | + | ===Description=== | |
| − | + | ||
| − | {{ | + | |
| − | == | ||
| − | |||
| − | === | ||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| − | |[[JMail::__construct | + | |public |
| + | |[[API17:JMail::__construct|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| − | |[[JMail::addAttachment | + | |public |
| + | |[[API17:JMail::addAttachment|addAttachment]] | ||
|Add file attachments to the email. | |Add file attachments to the email. | ||
|- | |- | ||
| − | |[[JMail::addBCC | + | |public |
| + | |[[API17:JMail::addBCC|addBCC]] | ||
|Add blind carbon copy recipients to the email. | |Add blind carbon copy recipients to the email. | ||
|- | |- | ||
| − | |[[JMail::addCC | + | |public |
| + | |[[API17:JMail::addCC|addCC]] | ||
|Add carbon copy recipients to the email. | |Add carbon copy recipients to the email. | ||
|- | |- | ||
| − | |[[JMail::addRecipient | + | |public |
| + | |[[API17:JMail::addRecipient|addRecipient]] | ||
|Add recipients to the email. | |Add recipients to the email. | ||
|- | |- | ||
| − | |[[JMail::addReplyTo | + | |public |
| + | |[[API17:JMail::addReplyTo|addReplyTo]] | ||
|Add Reply to email address(es) to the email. | |Add Reply to email address(es) to the email. | ||
|- | |- | ||
| − | |[[JMail::Send | + | |public |
| + | |[[API17:JMail::Send|Send]] | ||
|Send the mail. | |Send the mail. | ||
|- | |- | ||
| − | |[[JMail::sendAdminMail | + | |public |
| + | |[[API17:JMail::sendAdminMail|sendAdminMail]] | ||
|Sends mail to administrator for approval of a user submission. | |Sends mail to administrator for approval of a user submission. | ||
|- | |- | ||
| − | |[[JMail::sendMail | + | |public |
| + | |[[API17:JMail::sendMail|sendMail]] | ||
|Function to send an email. | |Function to send an email. | ||
|- | |- | ||
| − | |[[JMail::setBody | + | |public |
| + | |[[API17:JMail::setBody|setBody]] | ||
|Set the email body. | |Set the email body. | ||
|- | |- | ||
| − | |[[JMail::setSender | + | |public |
| + | |[[API17:JMail::setSender|setSender]] | ||
|Set the email sender. | |Set the email sender. | ||
|- | |- | ||
| − | |[[JMail::setSubject | + | |public |
| + | |[[API17:JMail::setSubject|setSubject]] | ||
|Set the email subject. | |Set the email subject. | ||
|- | |- | ||
| − | |[[JMail::useSendmail | + | |public |
| + | |[[API17:JMail::useSendmail|useSendmail]] | ||
|Use sendmail for sending the email. | |Use sendmail for sending the email. | ||
|- | |- | ||
| − | |[[JMail::useSMTP | + | |public |
| + | |[[API17:JMail::useSMTP|useSMTP]] | ||
|Use SMTP for sending the email. | |Use SMTP for sending the email. | ||
|- | |- | ||
| − | |[[JMail::getInstance | + | |public static |
| + | |[[API17:JMail::getInstance|getInstance]] | ||
|Returns the global email object, only creating it if it doesn't already exist. | |Returns the global email object, only creating it if it doesn't already exist. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/mail/mail.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.mail.mail' );</source> | <source lang="php">jimport( 'joomla.mail.mail' );</source> | ||
===See also=== | ===See also=== | ||
| − | * [[ | + | * {{JVer|11.1}} '''JMail source code''' on [[jplatform:mail/mail.php|BitBucket]] |
| − | {{ | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Mail|Mail]] |
| − | + | * [[API17:JMail|Other versions of JMail]] | |
| − | + | ||
| − | + | ||
| − | ===Examples=== | + | ===User contributed notes=== |
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JMail | category=JMail | ||
| − | + | 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 22:25, 24 March 2017
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.
JMail[edit]
Description[edit]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor. |
| public | addAttachment | Add file attachments to the email. |
| public | addBCC | Add blind carbon copy recipients to the email. |
| public | addCC | Add carbon copy recipients to the email. |
| public | addRecipient | Add recipients to the email. |
| public | addReplyTo | Add Reply to email address(es) to the email. |
| public | Send | Send the mail. |
| public | sendAdminMail | Sends mail to administrator for approval of a user submission. |
| public | sendMail | Function to send an email. |
| public | setBody | Set the email body. |
| public | setSender | Set the email sender. |
| public | setSubject | Set the email subject. |
| public | useSendmail | Use sendmail for sending the email. |
| public | useSMTP | Use SMTP for sending the email. |
| public static | getInstance | Returns the global email object, only creating it if it doesn't already exist. |
- Defined in libraries/joomla/mail/mail.php
Importing[edit]
jimport( 'joomla.mail.mail' );See also[edit]
- JMail source code on BitBucket
- Subpackage Mail
- Other versions of JMail
User contributed notes[edit]
Code Examples[edit]