Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
Fonctions membres publiques | |
Send () | |
setFrom ($address, $name='', $auto=true) | |
setSender ($from) | |
setSubject ($subject) | |
setBody ($content) | |
addRecipient ($recipient, $name='') | |
addCc ($cc, $name='') | |
addBcc ($bcc, $name='') | |
addAttachment ($path, $name='', $encoding='base64', $type='application/octet-stream', $disposition='attachment') | |
clearAttachments () | |
removeAttachment ($index=0) | |
addReplyTo ($replyto, $name='') | |
isHtml ($ishtml=true) | |
isSendmail () | |
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 hérités de PHPMailer | |
__construct ($exceptions=null) | |
__destruct () | |
isHTML ($isHtml=true) | |
isSMTP () | |
isMail () | |
isSendmail () | |
isQmail () | |
addAddress ($address, $name='') | |
addCC ($address, $name='') | |
addBCC ($address, $name='') | |
addReplyTo ($address, $name='') | |
parseAddresses ($addrstr, $useimap=true) | |
setFrom ($address, $name='', $auto=true) | |
getLastMessageID () | |
idnSupported () | |
punyencodeAddress ($address) | |
send () | |
preSend () | |
postSend () | |
getSMTPInstance () | |
smtpConnect ($options=null) | |
smtpClose () | |
setLanguage ($langcode='en', $lang_path='') | |
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='', $disposition='attachment') | |
getAttachments () | |
encodeString ($str, $encoding='base64') | |
encodeHeader ($str, $position='text') | |
hasMultiBytes ($str) | |
has8bitChars ($text) | |
base64EncodeWrapMB ($str, $linebreak=null) | |
encodeQP ($string, $line_max=76) | |
encodeQPphp ( $string, $line_max=76, $space_conv=false) | |
encodeQ ($str, $position='text') | |
addStringAttachment ( $string, $filename, $encoding='base64', $type='', $disposition='attachment') | |
addEmbeddedImage ($path, $cid, $name='', $encoding='base64', $type='', $disposition='inline') | |
addStringEmbeddedImage ( $string, $cid, $name='', $encoding='base64', $type='', $disposition='inline') | |
inlineImageExists () | |
attachmentExists () | |
alternativeExists () | |
clearQueuedAddresses ($kind) | |
clearAddresses () | |
clearCCs () | |
clearBCCs () | |
clearReplyTos () | |
clearAllRecipients () | |
clearAttachments () | |
clearCustomHeaders () | |
isError () | |
fixEOL ($str) | |
addCustomHeader ($name, $value=null) | |
getCustomHeaders () | |
msgHTML ($message, $basedir='', $advanced=false) | |
html2text ($html, $advanced=false) | |
set ($name, $value='') | |
secureHeader ($str) | |
sign ($cert_filename, $key_filename, $key_pass, $extracerts_filename='') | |
DKIM_QP ($txt) | |
DKIM_Sign ($signHeader) | |
DKIM_HeaderC ($signHeader) | |
DKIM_BodyC ($body) | |
DKIM_Add ($headers_line, $subject, $body) | |
quotedString ($str) | |
getToAddresses () | |
getCcAddresses () | |
getBccAddresses () | |
getReplyToAddresses () | |
getAllRecipientAddresses () | |
Fonctions membres publiques statiques | |
static | getInstance ($id='Joomla', $exceptions=true) |
Fonctions membres publiques statiques hérités de PHPMailer | |
static | validateAddress ($address, $patternselect=null) |
static | rfcDate () |
static | _mime_types ($ext='') |
static | filenameToType ($filename) |
static | mb_pathinfo ($path, $options=null) |
static | normalizeBreaks ($text, $breaktype="\") |
static | hasLineLongerThanMax ($str) |
Fonctions membres protégées | |
add ($recipient, $name='', $method='addAddress') | |
Fonctions membres protégées hérités de PHPMailer | |
edebug ($str) | |
addOrEnqueueAnAddress ($kind, $address, $name) | |
addAnAddress ($kind, $address, $name='') | |
sendmailSend ($header, $body) | |
mailSend ($header, $body) | |
smtpSend ($header, $body) | |
generateId () | |
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, $from) | |
Attributs protégés statiques | |
static | $instances = array() |
Membres hérités additionnels | |
Attributs publics statiques hérités de PHPMailer | |
static | $validator = 'auto' |
Fonctions membres protégées statiques hérités de PHPMailer | |
static | isShellSafe ($string) |
static | isPermittedPath ($path) |
Attributs protégés hérités de PHPMailer | |
$MIMEBody = '' | |
$MIMEHeader = '' | |
$mailHeader = '' | |
$smtp = null | |
$to = array() | |
$cc = array() | |
$bcc = array() | |
$ReplyTo = array() | |
$all_recipients = array() | |
$RecipientsQueue = array() | |
$ReplyToQueue = array() | |
$attachment = array() | |
$CustomHeader = array() | |
$lastMessageID = '' | |
$message_type = '' | |
$boundary = array() | |
$language = array() | |
$error_count = 0 | |
$sign_cert_file = '' | |
$sign_key_file = '' | |
$sign_extracerts_file = '' | |
$sign_key_pass = '' | |
$exceptions = false | |
$uniqueid = '' | |
Email Class. Provides a common interface to send email from the Joomla! Platform
|
protected |
Add recipients to the email.
mixed | $recipient | Either a string or array of strings [email address(es)] |
mixed | $name | Either a string or array of strings [name(s)] |
string | $method | The parent method's name. |
Références $name, PHPMailer\$to, Log\add(), MailHelper\cleanLine(), et Log\WARNING.
Référencé par Mail\addBcc(), Mail\addCc(), Mail\addRecipient(), et Mail\addReplyTo().
addAttachment | ( | $path, | |
$name = '' , |
|||
$encoding = 'base64' , |
|||
$type = 'application/octet-stream' , |
|||
$disposition = 'attachment' |
|||
) |
Add file attachment to the email
mixed | $path | Either a string or array of strings [filenames] |
mixed | $name | Either a string or array of strings [names]. N.B. if this is an array it must contain the same number of elements as the array of paths supplied. |
mixed | $encoding | The encoding of the attachment |
mixed | $type | The mime type |
string | $disposition | The disposition of the attachment |
Références $file, $key, $name, $path, $type, Log\add(), et Log\WARNING.
Référencé par Mail\sendMail().
addBcc | ( | $bcc, | |
$name = '' |
|||
) |
Add blind carbon copy recipients to the email
mixed | $bcc | Either a string or array of strings [email address(es)] |
mixed | $name | Either a string or array of strings [name(s)] |
Références PHPMailer\$bcc, $name, et Mail\add().
Référencé par Mail\sendMail().
addCc | ( | $cc, | |
$name = '' |
|||
) |
Add carbon copy recipients to the email
mixed | $cc | Either a string or array of strings [email address(es)] |
mixed | $name | Either a string or array of strings [name(s)] |
Références PHPMailer\$cc, $name, et Mail\add().
Référencé par Mail\sendMail().
addRecipient | ( | $recipient, | |
$name = '' |
|||
) |
Add recipients to the email
mixed | $recipient | Either a string or array of strings [email address(es)] |
mixed | $name | Either a string or array of strings [name(s)] |
Références $name, et Mail\add().
Référencé par Mail\sendAdminMail(), et Mail\sendMail().
addReplyTo | ( | $replyto, | |
$name = '' |
|||
) |
Add Reply to email address(es) to the email
mixed | $replyto | Either a string or array of strings [email address(es)] |
mixed | $name | Either a string or array of strings [name(s)] |
Références $name, et Mail\add().
Référencé par Mail\sendMail().
clearAttachments | ( | ) |
|
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'.
string | $id | The id string for the Mail instance [optional] |
boolean | $exceptions | Flag if Exceptions should be thrown [optional] |
Références PHPMailer\$exceptions, et $id.
Référencé par Factory\createMailer().
isHtml | ( | $ishtml = true | ) |
Sets message type to HTML
boolean | $ishtml | Boolean true or false. |
Référencé par Mail\sendMail().
isSendmail | ( | ) |
Send messages using $Sendmail.
This overrides the parent class to remove the restriction on the executable's name containing the word "sendmail"
Références Factory\getConfig().
Référencé par Mail\useSendmail().
removeAttachment | ( | $index = 0 | ) |
Unset file attachments specified by array index.
integer | $index | The numerical index of the attachment to remove |
Send | ( | ) |
Send the mail
mailonline
configuration is set to 0, or a JException object if the mail function does not exist or sending the message fails.PHPMailer has an issue with servers with invalid certificates
See: https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting#opportunistic-tls
Références Factory\getApplication(), Factory\getConfig(), et JError\raiseNotice().
Référencé par Mail\sendAdminMail(), et Mail\sendMail().
sendAdminMail | ( | $adminName, | |
$adminEmail, | |||
$email, | |||
$type, | |||
$title, | |||
$author, | |||
$url = null |
|||
) |
Sends mail to administrator for approval of a user submission
string | $adminName | Name of administrator |
string | $adminEmail | Email address of administrator |
string | [NOT USED TODO: Deprecate?] | |
string | $type | Type of item to approve |
string | $title | Title of item to approve |
string | $author | Author of item to approve |
string | $url | A URL to included in the mail |
Références $author, $message, $subject, $title, $type, $url, Mail\addRecipient(), Mail\Send(), Mail\setBody(), et Mail\setSubject().
sendMail | ( | $from, | |
$fromName, | |||
$recipient, | |||
$subject, | |||
$body, | |||
$mode = false , |
|||
$cc = null , |
|||
$bcc = null , |
|||
$attachment = null , |
|||
$replyTo = null , |
|||
$replyToName = null |
|||
) |
Function to send an email
string | $from | From email address |
string | $fromName | From name |
mixed | $recipient | Recipient email address(es) |
string | $subject | email subject |
string | $body | Message body |
boolean | $mode | false = plain text, true = HTML |
mixed | $cc | CC email address(es) |
mixed | $bcc | BCC email address(es) |
mixed | $attachment | Attachment file name(s) |
mixed | $replyTo | Reply to email address(es) |
mixed | $replyToName | Reply to name(s) |
Références PHPMailer\$attachment, PHPMailer\$bcc, PHPMailer\$cc, $config, $i, $mode, $subject, Mail\addAttachment(), Mail\addBcc(), Mail\addCc(), Mail\addRecipient(), Mail\addReplyTo(), elseif, Factory\getConfig(), Mail\isHtml(), Mail\Send(), Mail\setBody(), Mail\setSender(), et Mail\setSubject().
setBody | ( | $content | ) |
Set the email body
string | $content | Body of the email |
Références $content, et MailHelper\cleanText().
Référencé par Mail\sendAdminMail(), et Mail\sendMail().
setFrom | ( | $address, | |
$name = '' , |
|||
$auto = true |
|||
) |
Set the From and FromName properties.
string | $address | The sender email address |
string | $name | The sender name |
boolean | $auto | Whether to also set the Sender address, defaults to true |
Références $name, Log\add(), et Log\WARNING.
Référencé par Mail\setSender().
setSender | ( | $from | ) |
Set the email sender
mixed | $from | email address and Name of sender array([0] => email Address, [1] => Name) or as a string |
Références Log\add(), MailHelper\cleanLine(), elseif, Mail\setFrom(), et Log\WARNING.
Référencé par Mail\sendMail().
setSubject | ( | $subject | ) |
Set the email subject
string | $subject | Subject of the email |
Références $subject, et MailHelper\cleanLine().
Référencé par Mail\sendAdminMail(), et Mail\sendMail().
useSendmail | ( | $sendmail = null | ) |
Use sendmail for sending the email
string | $sendmail | Path to sendmail [optional] |
Références PHPMailer\isMail(), et Mail\isSendmail().
Use SMTP for sending the email
string | $auth | SMTP Authentication [optional] |
string | $host | SMTP Host [optional] |
string | $user | SMTP Username [optional] |
string | $pass | SMTP Password [optional] |
string | $secure | Use secure methods |
integer | $port | The SMTP port |
Références $user, PHPMailer\isMail(), PHPMailer\isSMTP(), et null.
$CharSet = 'utf-8' |
|
staticprotected |