MailerInterface

提供一个发送电子邮件的通用接口。

自版本

4.4.0

Joomla CMS

方法

addAttachment

将文件附件添加到电子邮件中。

addAttachment( data,  name = '',  encoding = 'base64',  type = 'application/octet-stream') : 
自版本

4.4.0

参数

数据

string附件数据

名称

string附件名称

编码

string附件编码

类型

string附件的 MIME 类型

返回值

void

addBcc

向电子邮件添加密件抄送收件人。

addBcc( bccEmail,  name = '') : 
自版本

4.4.0

抛出

UnexpectedValueException如果 BCC 不是有效的地址

参数

bccEmail

stringBCC 收件人的电子邮件

名称

stringBCC 收件人的姓名

返回值

void

addCc

向电子邮件添加抄送收件人。

addCc( ccEmail,  name = '') : 
自版本

4.4.0

抛出

UnexpectedValueException如果 CC 不是有效的地址

参数

ccEmail

stringCC 收件人的电子邮件

名称

stringCC 收件人的姓名

返回值

void

addRecipient

向电子邮件添加收件人。

addRecipient( recipientEmail,  name = '') : 
自版本

4.4.0

抛出

UnexpectedValueException如果收件人不是有效的地址

参数

recipientEmail

string收件人的电子邮件

名称

string收件人的姓名

返回值

void

addReplyTo

向电子邮件添加回复邮件地址

addReplyTo( replyToEmail,  name = '') : 
自版本

4.4.0

抛出

UnexpectedValueException如果回复地址无效

参数

replyToEmail

string回复地址的电子邮件

名称

string回复地址的名称

返回值

void

send

发送邮件。如果出现错误,则抛出异常。

send() : 
自版本

4.4.0

抛出

RuntimeException

返回值

void

setBody

设置电子邮件正文。

setBody( content) : 
自版本

4.4.0

参数

内容

string电子邮件正文

返回值

void

setSender

设置电子邮件发件人。

setSender( fromEmail,  name = '') : 
自版本

4.4.0

抛出

UnexpectedValueException如果发件人不是有效的地址

参数

fromEmail

string发件人的电子邮件地址

名称

string发件人的姓名

返回值

void

setSubject

设置电子邮件主题。

setSubject( subject) : 
自版本

4.4.0

参数

主题

string电子邮件主题

返回值

void