Actions

API17

Difference between revisions of "JMail::sendMail"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JMail::sendMail|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JMail::sendMail|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JMail->sendMail ($from, $fromName, $recipient, $subject, $body, $mode=0, $cc=null, $bcc=null, $attachment=null, $replyTo=null, $replyToName=null)
+
public function sendMail (
 +
        $from
 +
        $fromName
 +
        $recipient
 +
        $subject
 +
        $body
 +
        $mode=0
 +
        $cc=null
 +
        $bcc=null
 +
        $attachment=null
 +
        $replyTo=null
 +
        $replyToName=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 77: Line 86:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True on success
boolean True on success
+
* '''Defined''' on line 368 of libraries/joomla/mail/mail.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/mail/mail.php
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JMail::sendMail source code''' on [[jplatform:mail/mail.php#cl-360|BitBucket]]
 +
* {{JVer|11.1}} Class [[JMail/11.1|JMail]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Mail/11.1|Mail]]
 +
* [[JMail::sendMail|Other versions of JMail::sendMail]]
 +
{{SeeAlso:JMail::sendMail}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JMail::sendMail|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JMail::sendMail|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JMail/11.1|JMail]]
+
===User contributed notes===
* [[JMail::sendMail|Other versions of this method]]
+
{{SeeAlso:JMail::sendMail}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 97: Line 106:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JMail]][[Category:JMail::sendMail]]</noinclude>
 
<noinclude>[[Category:JMail]][[Category:JMail::sendMail]]</noinclude>

Revision as of 20:21, 27 April 2011

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::sendMail

Description

Function to send an email.

Description:JMail::sendMail [Edit Descripton]

public function sendMail (
        $from
        $fromName
        $recipient
        $subject
        $body
        $mode=0
        $cc=null
        $bcc=null
        $attachment=null
        $replyTo=null
        $replyToName=null
)
Parameter Type Default Description
$from string From email address
$fromName string From name
$recipient mixed Recipient email address(es)
$subject string email subject
$body string Message body
$mode boolean 0 false = plain text, true = HTML
$cc mixed null CC email address(es)
$bcc mixed null BCC email address(es)
$attachment mixed null Attachment file name(s)
$replyTo mixed null Reply to email address(es)
$replyToName mixed null Reply to name(s)
  • Returns boolean True on success
  • Defined on line 368 of libraries/joomla/mail/mail.php
  • Since Joomla 11.1

See also

SeeAlso:JMail::sendMail [Edit See Also]

User contributed notes

<CodeExamplesForm />