[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/mail/ -> mail.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: mail.php 14401 2010-01-26 14:10:00Z louis $
File Size: 321 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JMail:: (12 methods):
  JMail()
  Send()
  setSender()
  setSubject()
  setBody()
  addRecipient()
  addCC()
  addBCC()
  addAttachment()
  addReplyTo()
  useSendmail()
  useSMTP()


Class: JMail  - X-Ref

E-Mail Class.  Provides a common interface to send e-mail from the Joomla! Framework

JMail()   X-Ref
Constructor


Send()   X-Ref
No description

setSender($from)   X-Ref
Set the E-Mail sender

param: array $from E-Mail address and Name of sender
return: void

setSubject($subject)   X-Ref
Set the E-Mail subject

param: string $subject Subject of the e-mail
return: void

setBody($content)   X-Ref
Set the E-Mail body

param: string $content Body of the e-mail
return: void

addRecipient($recipient)   X-Ref
Add recipients to the email

param: mixed $recipient Either a string or array of strings [e-mail address(es)]
return: void

addCC($cc)   X-Ref
Add carbon copy recipients to the email

param: mixed $cc Either a string or array of strings [e-mail address(es)]
return: void

addBCC($bcc)   X-Ref
Add blind carbon copy recipients to the email

param: mixed $cc Either a string or array of strings [e-mail address(es)]
return: void

addAttachment($attachment)   X-Ref
Add file attachments to the email

param: mixed $attachment Either a string or array of strings [filenames]
return: void

addReplyTo($replyto)   X-Ref
Add Reply to e-mail address(es) to the e-mail

param: array $reply Either an array or multi-array of form
return: void

useSendmail($sendmail = null)   X-Ref
Use sendmail for sending the e-mail

param: string $sendmail Path to sendmail [optional]
return: boolean True on success

useSMTP($auth = null, $host = null, $user = null, $pass = null,$secure = null, $port = 25)   X-Ref
Use SMTP for sending the e-mail

param: string $auth SMTP Authentication [optional]
param: string $host SMTP Host [optional]
param: string $user SMTP Username [optional]
param: string $pass SMTP Password [optional]
param: string $secure SMTP Secure ssl,tls [optinal]
param: string $port SMTP Port [optional]
return: boolean True on success



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1