Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Attributs publics | Attributs protégés statiques
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

 __construct ()
 Send ()
 setSender ($from)
 setSubject ($subject)
 setBody ($content)
 addRecipient ($recipient, $name= '')
 addCC ($cc, $name= '')
 addBCC ($bcc, $name= '')
 addAttachment ($attachment, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
 addReplyTo ($replyto, $name= '')
 useSendmail ($sendmail=null)
 useSMTP ($auth=null, $host=null, $user=null, $pass=null, $secure=null, $port=25)
 sendMail ($from, $fromName, $recipient, $subject, $body, $mode=false, $cc=null, $bcc=null, $attachment=null, $replyTo=null, $replyToName=null)
 sendAdminMail ($adminName, $adminEmail, $email, $type, $title, $author, $url=null)
- Fonctions membres publiques inherited from PHPMailer
 __construct ($exceptions=false)
 IsHTML ($ishtml=true)
 IsSMTP ()
 IsMail ()
 IsSendmail ()
 IsQmail ()
 AddAddress ($address, $name= '')
 AddCC ($address, $name= '')
 AddBCC ($address, $name= '')
 AddReplyTo ($address, $name= '')
 SetFrom ($address, $name= '', $auto=1)
 SmtpConnect ()
 SmtpClose ()
 SetLanguage ($langcode= 'en', $lang_path= 'language/')
 GetTranslations ()
 AddrAppend ($type, $addr)
 AddrFormat ($addr)
 WrapText ($message, $length, $qp_mode=false)
 UTF8CharBoundary ($encodedText, $maxLength)
 SetWordWrap ()
 CreateHeader ()
 GetMailMIME ()
 GetSentMIMEMessage ()
 CreateBody ()
 HeaderLine ($name, $value)
 TextLine ($value)
 AddAttachment ($path, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
 GetAttachments ()
 EncodeString ($str, $encoding= 'base64')
 EncodeHeader ($str, $position= 'text')
 HasMultiBytes ($str)
 Base64EncodeWrapMB ($str)
 EncodeQPphp ($input= '', $line_max=76, $space_conv=false)
 EncodeQP ($string, $line_max=76, $space_conv=false)
 EncodeQ ($str, $position= 'text')
 AddStringAttachment ($string, $filename, $encoding= 'base64', $type= 'application/octet-stream')
 AddEmbeddedImage ($path, $cid, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
 AddStringEmbeddedImage ($string, $cid, $filename= '', $encoding= 'base64', $type= 'application/octet-stream')
 InlineImageExists ()
 AttachmentExists ()
 AlternativeExists ()
 ClearAddresses ()
 ClearCCs ()
 ClearBCCs ()
 ClearReplyTos ()
 ClearAllRecipients ()
 ClearAttachments ()
 ClearCustomHeaders ()
 IsError ()
 FixEOL ($str)
 AddCustomHeader ($custom_header)
 MsgHTML ($message, $basedir= '')
 set ($name, $value= '')
 SecureHeader ($str)
 Sign ($cert_filename, $key_filename, $key_pass)
 DKIM_QP ($txt)
 DKIM_Sign ($s)
 DKIM_HeaderC ($s)
 DKIM_BodyC ($body)
 DKIM_Add ($headers_line, $subject, $body)

Fonctions membres publiques statiques

static getInstance ($id= 'Joomla')
- Fonctions membres publiques statiques inherited from PHPMailer
static ValidateAddress ($address)
static RFCDate ()
static _mime_types ($ext= '')

Attributs publics

 $CharSet = 'utf-8'
- Attributs publics inherited from PHPMailer
 $Priority = 3
 $ContentType = 'text/plain'
 $Encoding = '8bit'
 $ErrorInfo = ''
 $From = 'root@localhost'
 $FromName = 'Root User'
 $Sender = ''
 $Subject = ''
 $Body = ''
 $AltBody = ''
 $WordWrap = 0
 $Mailer = 'mail'
 $Sendmail = '/usr/sbin/sendmail'
 $PluginDir = ''
 $ConfirmReadingTo = ''
 $Hostname = ''
 $MessageID = ''
 $Host = 'localhost'
 $Port = 25
 $Helo = ''
 $SMTPSecure = ''
 $SMTPAuth = false
 $Username = ''
 $Password = ''
 $Timeout = 10
 $SMTPDebug = false
 $SMTPKeepAlive = false
 $SingleTo = false
 $SingleToArray = array()
 $LE = "\n"
 $DKIM_selector = 'phpmailer'
 $DKIM_identity = ''
 $DKIM_passphrase = ''
 $DKIM_domain = ''
 $DKIM_private = ''
 $action_function = ''
 $Version = '5.2.1'
 $XMailer = ''
const STOP_MESSAGE = 0
const STOP_CONTINUE = 1
const STOP_CRITICAL = 2

Attributs protégés statiques

static $instances = array()

Additional Inherited Members

- Fonctions membres protégées inherited from PHPMailer
 AddAnAddress ($kind, $address, $name= '')
 PreSend ()
 PostSend ()
 SendmailSend ($header, $body)
 MailSend ($header, $body)
 SmtpSend ($header, $body)
 GetBoundary ($boundary, $charSet, $contentType, $encoding)
 EndBoundary ($boundary)
 SetMessageType ()
 AttachAll ($disposition_type, $boundary)
 EncodeFile ($path, $encoding= 'base64')
 SetError ($msg)
 ServerHostname ()
 Lang ($key)
 doCallback ($isSent, $to, $cc, $bcc, $subject, $body)
- Attributs protégés inherited from PHPMailer
 $MIMEBody = ''
 $MIMEHeader = ''
 $SentMIMEMessage = ''
 $smtp = NULL
 $to = array()
 $cc = array()
 $bcc = array()
 $ReplyTo = array()
 $all_recipients = array()
 $attachment = array()
 $CustomHeader = array()
 $message_type = ''
 $boundary = array()
 $language = array()
 $error_count = 0
 $sign_cert_file = ''
 $sign_key_file = ''
 $sign_key_pass = ''
 $exceptions = false

Documentation des constructeurs et destructeur

JMail::__construct ( )

Constructor

Documentation des fonctions membres

JMail::addAttachment (   $attachment,
  $name = '',
  $encoding = 'base64',
  $type = 'application/octet-stream' 
)

Add file attachments to the email

Paramètres:
mixed$attachmentEither a string or array of strings [filenames]
mixed$nameEither a string or array of strings [names]
mixed$encodingThe encoding of the attachment
mixed$typeThe mime type
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références $file, $name, et $type.

JMail::addBCC (   $bcc,
  $name = '' 
)

Add blind carbon copy recipients to the email

Paramètres:
mixed$bccEither a string or array of strings [email address(es)]
mixed$nameEither a string or array of strings [name(s)]
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine().

+ Voici le graphe d'appel pour cette fonction :

JMail::addCC (   $cc,
  $name = '' 
)

Add carbon copy recipients to the email

Paramètres:
mixed$ccEither a string or array of strings [email address(es)]
mixed$nameEither a string or array of strings [name(s)]
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine().

+ Voici le graphe d'appel pour cette fonction :

JMail::addRecipient (   $recipient,
  $name = '' 
)

Add recipients to the email

Paramètres:
mixed$recipientEither a string or array of strings [email address(es)]
mixed$nameEither a string or array of strings [name(s)]
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine().

+ Voici le graphe d'appel pour cette fonction :

JMail::addReplyTo (   $replyto,
  $name = '' 
)

Add Reply to email address(es) to the email

Paramètres:
array$replytoEither an array or multi-array of form array([0] => email Address [1] => Name)
mixed$nameEither an array or single string
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine().

+ Voici le graphe d'appel pour cette fonction :

static JMail::getInstance (   $id = 'Joomla')
static

Returns the global email object, only creating it if it doesn't already exist.

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

Paramètres:
string$idThe id string for the JMail instance [optional]
Renvoie:
JMail The global JMail object
Depuis:
11.1

Références $id.

Référencé par JFactory\createMailer().

+ Voici le graphe des appelants de cette fonction :

JMail::Send ( )

Send the mail

Renvoie:
mixed True if successful, a JError object otherwise
Depuis:
11.1

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

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

+ Voici le graphe d'appel pour cette fonction :

JMail::sendAdminMail (   $adminName,
  $adminEmail,
  $email,
  $type,
  $title,
  $author,
  $url = null 
)

Sends mail to administrator for approval of a user submission

Paramètres:
string$adminNameName of administrator
string$adminEmailEmail address of administrator
string$email[NOT USED TODO: Deprecate?]
string$typeType of item to approve
string$titleTitle of item to approve
string$authorAuthor of item to approve
string$urlA URL to included in the mail
Renvoie:
boolean True on success
Depuis:
11.1

Références $author, $message, $title, $type, $url, JText\_(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JMail::sendMail (   $from,
  $fromName,
  $recipient,
  $subject,
  $body,
  $mode = false,
  $cc = null,
  $bcc = null,
  $attachment = null,
  $replyTo = null,
  $replyToName = null 
)

Function to send an email

Paramètres:
string$fromFrom email address
string$fromNameFrom name
mixed$recipientRecipient email address(es)
string$subjectemail subject
string$bodyMessage body
boolean$modefalse = plain text, true = HTML
mixed$ccCC email address(es)
mixed$bccBCC email address(es)
mixed$attachmentAttachment file name(s)
mixed$replyToReply to email address(es)
mixed$replyToNameReply to name(s)
Renvoie:
boolean True on success
Depuis:
11.1

Références $i, $mode, et elseif.

JMail::setBody (   $content)

Set the email body

Paramètres:
string$contentBody of the email
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanText().

+ Voici le graphe d'appel pour cette fonction :

JMail::setSender (   $from)

Set the email sender

Paramètres:
array$fromemail address and Name of sender array([0] => email Address [1] => Name)
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine(), elseif, JError\raiseWarning(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JMail::setSubject (   $subject)

Set the email subject

Paramètres:
string$subjectSubject of the email
Renvoie:
JMail Returns this object for chaining.
Depuis:
11.1

Références JMailHelper\cleanLine().

+ Voici le graphe d'appel pour cette fonction :

JMail::useSendmail (   $sendmail = null)

Use sendmail for sending the email

Paramètres:
string$sendmailPath to sendmail [optional]
Renvoie:
boolean True on success
Depuis:
11.1
JMail::useSMTP (   $auth = null,
  $host = null,
  $user = null,
  $pass = null,
  $secure = null,
  $port = 25 
)

Use SMTP for sending the email

Paramètres:
string$authSMTP Authentication [optional]
string$hostSMTP Host [optional]
string$userSMTP Username [optional]
string$passSMTP Password [optional]
string$secureUse secure methods
integer$portThe SMTP port
Renvoie:
boolean True on success
Depuis:
11.1

Références $user, et null.

Documentation des données membres

JMail::$CharSet = 'utf-8'

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

JMail::$instances = array()
staticprotected
La documentation de cette classe a été générée à partir du fichier suivant :