电子邮件类。提供从 Joomla! 平台发送电子邮件的通用接口
| 自 |
1.7.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数
__construct( exceptions = true) :
| 自 |
1.7.0 |
|---|
参数
- 异常
bool是否应抛出异常的标志
响应
混合
add
将收件人添加到电子邮件中。
add( recipient, name = '', method = 'addAddress') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- 收件人
混合字符串或字符串数组 [电子邮件地址(es)]- 姓名
混合字符串或字符串数组 [姓名(s)]- 方法
string父方法的名称。
响应
Mail|bool成功时返回此对象以进行链式操作，或失败时返回布尔值 false。
addAttachment
将文件附件添加到电子邮件
addAttachment( path, name = '', encoding = 'base64', type = 'application/octet-stream', disposition = 'attachment') : \Joomla\CMS\Mail\Mail|bool
| 自 |
3.0.1 |
|---|---|
| 抛出 |
|
参数
- 路径
混合字符串或字符串数组 [文件名(s)]- 姓名
混合字符串或字符串数组 [名称(s)]。注意，如果这是一个数组，它必须包含与提供的路径数组相同数量的元素。- 编码
混合附件的编码- 类型
混合MIME 类型- 处置
string附件的处置
响应
Mail|bool成功时返回此对象以进行链式操作，或禁用异常抛出时返回布尔值 false。
addBcc
将密件抄送收件人添加到电子邮件
addBcc( bcc, name = '') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- bcc
混合字符串或字符串数组 [电子邮件地址(es)]- 姓名
混合字符串或字符串数组 [姓名(s)]
响应
Mail|bool成功时返回此对象以进行链式操作，或禁用异常抛出时返回布尔值 false。
addCc
将抄送收件人添加到电子邮件
addCc( cc, name = '') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- cc
混合字符串或字符串数组 [电子邮件地址(es)]- 姓名
混合字符串或字符串数组 [姓名(s)]
响应
Mail|bool成功时返回此对象以进行链式操作，或启用异常抛出时返回布尔值 false。
addRecipient
将收件人添加到电子邮件
addRecipient( recipient, name = '') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- 收件人
混合字符串或字符串数组 [电子邮件地址(es)]- 姓名
混合字符串或字符串数组 [姓名(s)]
响应
Mail|bool成功时返回此对象以进行链式操作，或禁用异常抛出时返回 false。
addReplyTo
将回复电子邮件地址(es)添加到电子邮件
addReplyTo( replyto, name = '') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- replyto
混合字符串或字符串数组 [电子邮件地址(es)]- 姓名
混合字符串或字符串数组 [姓名(s)]
响应
Mail|bool成功时返回此对象以进行链式操作，或禁用异常抛出时返回布尔值 false。
clearAttachments
取消设置电子邮件中的所有文件附件
clearAttachments() : \Joomla\CMS\Mail\Mail
getInstance
返回全局电子邮件对象，仅在它不存在时创建它。
getInstance( id = 'Joomla', exceptions = true) : \Joomla\CMS\Mail\Mail
注意：如果您需要一个不包含全局配置值的实例，请使用一个不是“Joomla”的 id 字符串。
| 自 |
4.4.0 |
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除。使用 DI 容器中的邮件器服务并从那里创建邮件器。例如：Factory::getContainer()->get(MailerFactoryInterface::class)->createMailer(); |
参数
- id
stringMail 实例的 id 字符串 [可选]- 异常
bool是否应抛出异常的标志 [可选]
响应
Mail全局 Mail 对象
isHtml
将消息类型设置为 HTML
isHtml( ishtml = true) : \Joomla\CMS\Mail\Mail
isSendmail
使用 $Sendmail 发送消息。
isSendmail() :
这将覆盖父类以删除对可执行文件名包含“sendmail”一词的限制
| 自 |
1.7.0 |
|---|
响应
void
removeAttachment
取消设置由数组索引指定的附件文件。
removeAttachment( index) : \Joomla\CMS\Mail\Mail
Send
发送邮件
Send() :
sendMail
发送电子邮件的功能
sendMail( from, fromName, recipient, subject, body, mode = false, cc = null, bcc = null, attachment = null, replyTo = null, replyToName = null) :
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- 来自
string发件人电子邮件地址- fromName
string发件人姓名- 收件人
混合收件人电子邮件地址(es)- 主题
string电子邮件主题- 正文
string消息正文- 模式
boolfalse = 纯文本，true = HTML- cc
混合抄送电子邮件地址(es)- bcc
混合密件抄送电子邮件地址(es)- 附件
混合附件文件名(s)- replyTo
混合回复电子邮件地址(es)- replyToName
混合回复姓名(s)
响应
bool成功时为 True，禁用异常抛出时为 False。
setBody
设置电子邮件正文
setBody( content) : \Joomla\CMS\Mail\Mail
setSender
设置电子邮件发件人
setSender( from, name = '') : \Joomla\CMS\Mail\Mail|bool
| 自 |
1.7.0 |
|---|---|
| 抛出 |
|
参数
- 来自
混合发件人的电子邮件地址和姓名array([0] => 电子邮件地址，[1] => 姓名)或作为字符串- 姓名
混合字符串或字符串数组 [姓名(s)]
响应
Mail|bool成功时返回此对象以进行链式操作，或失败时返回布尔值 false。
setSubject
设置电子邮件主题
setSubject( subject) : \Joomla\CMS\Mail\Mail
useSendmail
使用 sendmail 发送电子邮件
useSendmail( sendmail = null) :
| 自 |
1.7.0 |
|---|
参数
- sendmail
stringsendmail 的路径 [可选]
响应
bool成功时为 True
useSmtp
使用 SMTP 发送电子邮件
useSmtp( auth = null, host = null, user = null, pass = null, secure = null, port = 25) :
| 自 |
1.7.0 |
|---|
参数
- 身份验证
stringSMTP 身份验证 [可选]- 主机
stringSMTP 主机 [可选]- 用户
stringSMTP 用户名 [可选]- 通过
stringSMTP 密码 [可选]- 安全
string使用安全方法- 端口
intSMTP 端口
响应
bool成功时为 True
属性
实例
Mail 实例容器。
字符集
消息的字符集。
| 自 |
1.7.0 |
|---|
类型(s)
string