Actions

API17

Difference between revisions of "JMail"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (User contributed notes: bad link repair)
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} 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>
{{Description:JMail}}
 
===Defined in===
 
libraries/joomla/mail/mail.php
 
===Subpackage===
 
[[Subpackage Mail/11.1|Mail]]
 
===Extends===
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JMail::__construct/11.1|__construct]]
 
|[[JMail::__construct/11.1|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JMail::addAttachment/11.1|addAttachment]]
 
|[[JMail::addAttachment/11.1|addAttachment]]
 
|Add file attachments to the email.  
 
|Add file attachments to the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::addBCC/11.1|addBCC]]
 
|[[JMail::addBCC/11.1|addBCC]]
 
|Add blind carbon copy recipients to the email.  
 
|Add blind carbon copy recipients to the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::addCC/11.1|addCC]]
 
|[[JMail::addCC/11.1|addCC]]
 
|Add carbon copy recipients to the email.  
 
|Add carbon copy recipients to the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::addRecipient/11.1|addRecipient]]
 
|[[JMail::addRecipient/11.1|addRecipient]]
 
|Add recipients to the email.  
 
|Add recipients to the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::addReplyTo/11.1|addReplyTo]]
 
|[[JMail::addReplyTo/11.1|addReplyTo]]
 
|Add Reply to email address(es) to the email.  
 
|Add Reply to email address(es) to the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::Send/11.1|Send]]
 
|[[JMail::Send/11.1|Send]]
 
|Send the mail.  
 
|Send the mail.  
 
|-
 
|-
 +
|public
 
|[[JMail::sendAdminMail/11.1|sendAdminMail]]
 
|[[JMail::sendAdminMail/11.1|sendAdminMail]]
 
|Sends mail to administrator for approval of a user submission.  
 
|Sends mail to administrator for approval of a user submission.  
 
|-
 
|-
 +
|public
 
|[[JMail::sendMail/11.1|sendMail]]
 
|[[JMail::sendMail/11.1|sendMail]]
 
|Function to send an email.  
 
|Function to send an email.  
 
|-
 
|-
 +
|public
 
|[[JMail::setBody/11.1|setBody]]
 
|[[JMail::setBody/11.1|setBody]]
 
|Set the email body.  
 
|Set the email body.  
 
|-
 
|-
 +
|public
 
|[[JMail::setSender/11.1|setSender]]
 
|[[JMail::setSender/11.1|setSender]]
 
|Set the email sender.  
 
|Set the email sender.  
 
|-
 
|-
 +
|public
 
|[[JMail::setSubject/11.1|setSubject]]
 
|[[JMail::setSubject/11.1|setSubject]]
 
|Set the email subject.  
 
|Set the email subject.  
 
|-
 
|-
 +
|public
 
|[[JMail::useSendmail/11.1|useSendmail]]
 
|[[JMail::useSendmail/11.1|useSendmail]]
 
|Use sendmail for sending the email.  
 
|Use sendmail for sending the email.  
 
|-
 
|-
 +
|public
 
|[[JMail::useSMTP/11.1|useSMTP]]
 
|[[JMail::useSMTP/11.1|useSMTP]]
 
|Use SMTP for sending the email.  
 
|Use SMTP for sending the email.  
 
|-
 
|-
 +
|public static
 
|[[JMail::getInstance/11.1|getInstance]]
 
|[[JMail::getInstance/11.1|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===
* [[JMail|Other versions of this class]]
+
* {{JVer|11.1}} '''JMail source code''' on [[jplatform:mail/mail.php|BitBucket]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage Mail/11.1|Mail]]
 +
* [[JMail|Other versions of JMail]]
 
{{SeeAlso: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>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 78: Line 93:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JMail]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JMail]]</noinclude>

Revision as of 12:57, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JMail

Description

Description:JMail [Edit Descripton]

Methods

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

jimport( 'joomla.mail.mail' );

See also

SeeAlso:JMail [Edit See Also]

User contributed notes

<CodeExamplesForm />