Référence de la classe JMail

Graphe d'héritage de JMail:

Graphe de collaboration de JMail:

Liste de tous les membres

Fonctions membres publiques

• JMail ()
• & Send ()
• setSender ($from)
• setSubject ($subject)
• setBody ($content)
• addRecipient ($recipient)
• addCC ($cc)
• addBCC ($bcc)
• addAttachment ($attachment)
• addReplyTo ($replyto)
• useSendmail ($sendmail=null)
• useSMTP ($auth=null, $host=null, $user=null, $pass=null, $secure=null, $port=25)

Fonctions membres publiques statiques

• & getInstance ($id= 'Joomla')

---

Documentation des fonctions membres

JMail::addAttachment

(

$

attachment

)

Add file attachments to the email

public

Paramètres:

mixed

$attachment

Either a string or array of strings [filenames]

Renvoie:

void

Depuis:

1.5

Références $file.

JMail::addBCC

(

$

bcc

)

Add blind carbon copy recipients to the email

public

Paramètres:

mixed

$cc

Either a string or array of strings [e-mail address(es)]

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine().

Voici le graphe d'appel pour cette fonction :

JMail::addCC

(

$

cc

)

Add carbon copy recipients to the email

public

Paramètres:

mixed

$cc

Either a string or array of strings [e-mail address(es)]

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine().

Voici le graphe d'appel pour cette fonction :

JMail::addRecipient

(

$

recipient

)

Add recipients to the email

public

Paramètres:

mixed

$recipient

Either a string or array of strings [e-mail address(es)]

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine().

Voici le graphe d'appel pour cette fonction :

JMail::addReplyTo

(

$

replyto

)

Add Reply to e-mail address(es) to the e-mail

public

Paramètres:

array

$reply

Either an array or multi-array of form array( [0] => E-Mail Address [1] => Name )

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine().

Voici le graphe d'appel pour cette fonction :

& JMail::getInstance

(

$

id = 'Joomla'

)

[static]

Returns a reference to a global e-mail object, only creating it if it doesn't already exist.

This method must be invoked as:

  $mail =& JMail::getInstance();

NOTE: If you need an instance to use that does not have the global configuration values, use an id string that is not 'Joomla'.

public

Paramètres:

string

$id

The id string for the JMail instance [optional]

Renvoie:

object The global JMail object

Depuis:

1.5

Références $id.

Référencé par JFactory::_createMailer().

Voici le graphe d'appel pour cette fonction :

JMail::JMail

(

)

Constructor

& JMail::Send

(

)

Renvoie:

mixed True if successful, a JError object otherwise

Réimplémentée à partir de PHPMailer.

Références JText::_(), et JError::raiseNotice().

Voici le graphe d'appel pour cette fonction :

JMail::setBody

(

$

content

)

Set the E-Mail body

public

Paramètres:

string

$content

Body of the e-mail

Renvoie:

void

Depuis:

1.5

Références $content, et JMailHelper::cleanText().

Voici le graphe d'appel pour cette fonction :

JMail::setSender

(

$

from

)

Set the E-Mail sender

public

Paramètres:

array

$from

E-Mail address and Name of sender array( [0] => E-Mail Address [1] => Name )

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine(), elseif, et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

JMail::setSubject

(

$

subject

)

Set the E-Mail subject

public

Paramètres:

string

$subject

Subject of the e-mail

Renvoie:

void

Depuis:

1.5

Références JMailHelper::cleanLine().

Voici le graphe d'appel pour cette fonction :

JMail::useSendmail

(

$

sendmail = null

)

Use sendmail for sending the e-mail

public

Paramètres:

string

$sendmail

Path to sendmail [optional]

Renvoie:

boolean True on success

Depuis:

1.5

JMail::useSMTP	(	$	auth = null,
		$	host = null,
		$	user = null,
		$	pass = null,
		$	secure = null,
		$	port = 25
	)

Use SMTP for sending the e-mail

public

Paramètres:

string	$auth	SMTP Authentication [optional]
string	$host	SMTP Host [optional]
string	$user	SMTP Username [optional]
string	$pass	SMTP Password [optional]
string	$secure	SMTP Secure ssl,tls [optinal]
string	$port	SMTP Port [optional]

Renvoie:

boolean True on success

Depuis:

1.5

Références $host, et $user.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• mail.php