MailTemplate
邮件模板类
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
邮件模板类的构造函数
__construct( templateId, language, \Joomla\CMS\Mail\Mail mailer = null) :
addAttachment
向邮件添加附件
addAttachment( name, file) :
| 自 |
4.0.0 |
|---|
参数
- name
string附件的文件名- file
string文件路径或文件内容
响应
void
addRecipient
添加此邮件的收件人
addRecipient( mail, name = null, type = 'to') :
| 自 |
4.0.0 |
|---|
参数
string收件人的邮件地址- name
string收件人的姓名- type
string收件人应如何接收邮件？('to', 'cc', 'bcc')
响应
void
addTemplateData
添加要替换到模板中的数据
addTemplateData(mixed||string|int data, plain = false) :
| 自 |
4.0.0 |
|---|
参数
- data
array<string|int, mixed>要替换的字符串的关联数组- plain
bool仅将数据用于纯文本电子邮件。
响应
void
addUnsafeTags
将标签标记为不安全，以确保在 HTML 邮件中进行转义
addUnsafeTags(mixed||string|int tags) :
| 自 |
5.1.3 |
|---|
参数
- tags
array<string|int, mixed>标签名称
响应
void
createTemplate
将新的邮件模板插入系统
createTemplate( key, subject, body, mixed||string|int tags, htmlbody = '') :
| 自 |
4.0.0 |
|---|
参数
- key
string邮件模板的键- subject
string默认主题（通常是可翻译的字符串）- body
string默认正文（通常是可翻译的字符串）- tags
array<string|int, mixed>要替换的标签的关联数组- htmlbody
string默认 htmlbody（通常是可翻译的字符串）
响应
bool成功时为 True，失败时为 False
deleteTemplate
删除邮件模板的方法
deleteTemplate( key) :
| 自 |
4.0.0 |
|---|
参数
- key
string邮件模板的键
响应
bool成功时为 True，失败时为 False
getAttachmentName
检查并修复附件的文件名（如果需要），以使附加的文件与源文件具有相同的扩展名，而不是不同的文件扩展名
getAttachmentName( file, name) :
| 自 |
4.0.0 |
|---|
参数
- file
string要附加的文件的路径- name
string要用于附件的文件名
响应
string附件的修正文件名
getTemplate
获取特定邮件模板
getTemplate( key, language) : object|null
| 自 |
4.0.0 |
|---|
参数
- key
string模板标识符- language
string模板的语言代码
响应
object|null包含邮件数据的对象，如果数据库中未找到模板，则为 null。
replaceTags
递归地用其值替换标签
replaceTags( text, mixed||string|int tags, isHtml = false) :
| 自 |
4.0.0 |
|---|
参数
- text
string要处理的模板- tags
array<string|int, mixed>要替换到模板中的关联数组- isHtml
bool文本是否为 HTML 文本，是否需要转义
响应
string渲染后的邮件模板
setReplyTo
设置此邮件的回复地址
setReplyTo( mail, name = '') :
| 自 |
4.0.0 |
|---|
参数
string回复地址的邮件地址- name
string姓名
响应
void
updateTemplate
更新现有的邮件模板
updateTemplate( key, subject, body, mixed||string|int tags, htmlbody = '') :
| 自 |
4.0.0 |
|---|
参数
- key
string邮件模板的键- subject
string默认主题（通常是可翻译的字符串）- body
string默认正文（通常是可翻译的字符串）- tags
array<string|int, mixed>要替换的标签的关联数组- htmlbody
string默认 htmlbody（通常是可翻译的字符串）
响应
bool成功时为 True，失败时为 False
属性
template_id
邮件模板的标识符。
| 自 |
4.0.0 |
|---|
类型
string
language
邮件模板的语言。
类型
string
data
| 自 |
4.0.0 |
|---|
类型
array<string|int, string>
plain_data
| 自 |
5.1.0 |
|---|
类型
array<string|int, string>
unsafe_tags
| 自 |
5.1.3 |
|---|
类型
array<string|int, string>
attachments
| 自 |
4.0.0 |
|---|
类型
array<string|int, string>
recipients
电子邮件的收件人列表
| 自 |
4.0.0 |
|---|
类型
array<string|int, stdClass>
replyto
电子邮件的回复地址
| 自 |
4.0.0 |
|---|
类型
stdClass