API17:JMail::useSMTP
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JMail::useSMTP|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JMail::useSMTP|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function useSMTP ( |
| + | $auth=null | ||
| + | $host=null | ||
| + | $user=null | ||
| + | $pass=null | ||
| + | $secure=null | ||
| + | $port=25 | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 42: | Line 46: | ||
|- | |- | ||
|$secure | |$secure | ||
| − | | | + | |string |
|null | |null | ||
| | | | ||
| Line 52: | Line 56: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True on success | |
| − | boolean True on success | + | * '''Defined''' on line 324 of libraries/joomla/mail/mail.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/mail/mail.php | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JMail::useSMTP source code''' on [[jplatform:mail/mail.php#cl-316|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JMail/11.1|JMail]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Mail/11.1|Mail]] | ||
| + | * [[JMail::useSMTP|Other versions of JMail::useSMTP]] | ||
| + | {{SeeAlso:JMail::useSMTP}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JMail::useSMTP|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JMail::useSMTP|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 72: | Line 76: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JMail]][[Category:JMail::useSMTP]]</noinclude> | <noinclude>[[Category:JMail]][[Category:JMail::useSMTP]]</noinclude> | ||
Revision as of 21:21, 27 April 2011
JMail::useSMTP
Description
Use SMTP for sending the email.
Description:JMail::useSMTP [Edit Descripton]
public function useSMTP ( $auth=null $host=null $user=null $pass=null $secure=null $port=25 )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $auth | string | null | SMTP Authentication [optional] |
| $host | string | null | SMTP Host [optional] |
| $user | string | null | SMTP Username [optional] |
| $pass | string | null | SMTP Password [optional] |
| $secure | string | null | |
| $port | int | 25 | $port |
- Returns boolean True on success
- Defined on line 324 of libraries/joomla/mail/mail.php
- Since
See also
- JMail::useSMTP source code on BitBucket
- Class JMail
- Subpackage Mail
- Other versions of JMail::useSMTP
SeeAlso:JMail::useSMTP [Edit See Also]
User contributed notes
<CodeExamplesForm />
