forge($setup = null, array $config = array())
forge 回传一个新的 Email_Driver 实例基于配置或它接收到的输入。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 一个新的 Email_Driver 实例 | ||||||||||||
範例 |
|
forge 回传一个新的 Email_Driver 实例基于配置或它接收到的输入。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 一个新的 Email_Driver 实例 | ||||||||||||
範例 |
|
扩充 Email_Driver 的每个驱动程序都有这些方法。 你所需要的就是唤醒与执行它们。
body 转换输入为字串,并设定讯息主体。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
alt_body 转换输入为字串,并设定讯息的替代主体。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
priority 方法设定邮件的优先权。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
html_body 方法设置邮件主体并且选择性地从其产生替代的主体。如果指定内嵌的图片将自动被附加。
请注意: 预设情况下自动附加是开启的(透过配置)。要关闭这个功能,提供 false 或者更改配置设定。
静态 | 否 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||||||
回传 | $this | ||||||||||||||||
範例 |
|
from 方法设定来源地址与名称。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
subject 方法设定主题。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
to 方法增加单一或阵列的地址至 to 接收者阵列。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
cc 方法添加单一或阵列的地址到 cc 接收者阵列。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
bcc 方法添加单一或阵列的地址到 bcc 接收者阵列。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
reply_to 方法添加单一或阵列的地址到 reply to 接收者阵列。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
header 方法添加一个自订的标题到你的邮件表头。
静态 | 否 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | $this | ||||||||||||
範例 |
|
clear_recipients 方法清空 to、cc 与 bcc 列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
clear_addresses 方法清空 to、cc、bcc 与 reply to 列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
clear_to 方法清空 to 接收者列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
clear_cc 方法清空 cc 接收者列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
clear_bcc 方法清空 bcc 接收者列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
clear_reply_to 方法清空 reply to 列表。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
attach 方法附加一个档案。
此方法将会在 attach_paths 阵列里设定(config/email.php)的附件路径中搜寻档案。
静态 | 否 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||||||||||||||
回传 | $this | ||||||||||||||||||||||||
範例 |
|
string_attach 方法以字串输入附加一个档案。
静态 | 否 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||||||||||||||
回传 | $this | ||||||||||||||||||||||||
範例 |
|
clear_attachments 方法清除附件阵列。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
send 方法发送信件。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | 布林 | ||||||||
範例 |
|
get_invalid_addresses 方法回传未通过验证的email地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | $this |
範例 |
|
return_path 方法设定回传路径地址。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
pipelining 方法可使用流水线(一次发送多个讯息)。 对于不支援的驱动,这个方法是一个空操作(NOOP)。流水线预设是停用的。
静态 | 否 | ||||||||
---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||
回传 | $this | ||||||||
範例 |
|
get_from 方法回传配置的 "from" 地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 字串 |
範例 |
|
get_to 方法回传配置的 "to" 地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 阵列 |
範例 |
|
get_cc 方法回传配置的 "cc" 地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 阵列 |
範例 |
|
get_bcc 方法回传配置的 "bcc" 地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 阵列 |
範例 |
|
get_reply_to 方法回传配置的 "reply_to" 地址。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 字串 |
範例 |
|
get_body 方法回传设定的 Email 主体。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 字串 |
範例 |
|
get_subject 方法回传配置的 Email "subject"。
静态 | 否 |
---|---|
参数 | 无 |
回传 | 字串 |
範例 |
|