JMail/1.5
From Joomla! Documentation
< JMail(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|1.5}} JMail== | ||
| + | ===Description=== | ||
| + | {{Description:JMail}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JMail|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JMail|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JMail::addAttachment/1.5|addAttachment]] | |[[JMail::addAttachment/1.5|addAttachment]] | ||
|Add file attachments to the email. | |Add file attachments to the email. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::addBCC/1.5|addBCC]] | |[[JMail::addBCC/1.5|addBCC]] | ||
|Add blind carbon copy recipients to the email. | |Add blind carbon copy recipients to the email. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::addCC/1.5|addCC]] | |[[JMail::addCC/1.5|addCC]] | ||
|Add carbon copy recipients to the email. | |Add carbon copy recipients to the email. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::addRecipient/1.5|addRecipient]] | |[[JMail::addRecipient/1.5|addRecipient]] | ||
|Add recipients to the email. | |Add recipients to the email. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::addReplyTo/1.5|addReplyTo]] | |[[JMail::addReplyTo/1.5|addReplyTo]] | ||
|Add Reply to e-mail address(es) to the e-mail. | |Add Reply to e-mail address(es) to the e-mail. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::JMail/1.5|JMail]] | |[[JMail::JMail/1.5|JMail]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::Send/1.5|Send]] | |[[JMail::Send/1.5|Send]] | ||
| | | | ||
|- | |- | ||
| + | |public | ||
|[[JMail::setBody/1.5|setBody]] | |[[JMail::setBody/1.5|setBody]] | ||
|Set the E-Mail body. | |Set the E-Mail body. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::setSender/1.5|setSender]] | |[[JMail::setSender/1.5|setSender]] | ||
|Set the E-Mail sender. | |Set the E-Mail sender. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::setSubject/1.5|setSubject]] | |[[JMail::setSubject/1.5|setSubject]] | ||
|Set the E-Mail subject. | |Set the E-Mail subject. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::useSendmail/1.5|useSendmail]] | |[[JMail::useSendmail/1.5|useSendmail]] | ||
|Use sendmail for sending the e-mail. | |Use sendmail for sending the e-mail. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::useSMTP/1.5|useSMTP]] | |[[JMail::useSMTP/1.5|useSMTP]] | ||
|Use SMTP for sending the e-mail. | |Use SMTP for sending the e-mail. | ||
|- | |- | ||
| + | |public | ||
|[[JMail::getInstance/1.5|getInstance]] | |[[JMail::getInstance/1.5|getInstance]] | ||
|Returns a reference to a global e-mail object, only creating it if it doesn't already exist. | |Returns a reference to a global e-mail 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|1.5}} '''JMail''' on [http://api.joomla.org/Joomla-Framework/Mail/JMail.html api.joomla.org] | ||
| + | * {{JVer|1.5}} '''JMail source code''' on [[jframework15:mail/mail.php|JoomlaCode]] | ||
| + | * {{JVer|1.5}} Subpackage [[Subpackage Mail/1.5|Mail]] | ||
| + | * [[JMail|Other versions of JMail]] | ||
| + | {{SeeAlso:JMail}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JMail|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JMail|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 73: | Line 86: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JMail]]</noinclude> | <noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JMail]]</noinclude> | ||
Revision as of 18:11, 25 April 2011
JMail
Description
Description:JMail [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| 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 e-mail address(es) to the e-mail. |
| public | JMail | Constructor. |
| public | Send | |
| public | setBody | Set the E-Mail body. |
| public | setSender | Set the E-Mail sender. |
| public | setSubject | Set the E-Mail subject. |
| public | useSendmail | Use sendmail for sending the e-mail. |
| public | useSMTP | Use SMTP for sending the e-mail. |
| public | getInstance | Returns a reference to a global e-mail object, only creating it if it doesn't already exist. |
- Defined in libraries/joomla/mail/mail.php
Importing
jimport( 'joomla.mail.mail' );
See also
- JMail on api.joomla.org
- JMail source code on JoomlaCode
- Subpackage Mail
- Other versions of JMail
User contributed notes
<CodeExamplesForm />
