简介 - Email 套件

优质

小牛编辑

128浏览

2023-12-01

Email 套件提供了一个介面使用 PHP 的 mail 函式、sendmail 或 SMTP来发送邮件。套件支援：

纯文本邮件
HTML 邮件，和选择性的替代主体
附件
内嵌附件

安装

Email 套件已成为官方下载的一部分（自 1.1 版起）。你将必须在应用程序配置或动态引入以启用套件。

'always_load' => array(
	'packages' => array(
		'email',
	),
),

// 或在控制器中：

\Package::load('email');

配置

建立（或从套件複製）一个在 app/config/email.php 的配置档。并更改所需的配置。

请注意：Email 套件为你载入 email 配置，所以不需要自动载入它。

一般配置

参数	类型	预设	描述
defaults	阵列	`array( /* default 配置阵列 */ )`	每个设定组使用的预设设定。在你的设置组覆写这些值。
default_setup	字串	`'default'`	如果没有提供，使用的预设设定。
setups	阵列	`array( 'default' => array(), )`	带有一个预设设定的设定阵列。添加你自己的或修改预设设定组。

群组配置

参数	类型	预设	描述
useragent	字串	`'FuelPHP, PHP 5.3 Framework'`	使用者代理。
driver	字串	`'mail'`	使用的驱动程序。可以是 mail、smtp、sendmail、mailgun、mandrill 或 noop（只写 log 记录），必须为小写。
is_html	布林	`false`	做为 HTML 电子邮件或普通邮件发送。
encode_headers	布林	`true`	是否对主题及接收者名称进行编码。需要 mbstring 扩充。
charset	字串	`'utf-8'`	电子邮件讯息的字符集。
encoding	字串	`'8bit'`	电子邮件讯息编码。可以是 7bit、8bit、quoted-printable 和 base64。
priority	字串	`\Email::P_NORMAL`	电子邮件的优先权。可以是： \Email::P_LOWEST \Email::P_LOW \Email::P_NORMAL \Email::P_HIGH \Email::P_HIGHEST
from.email	字串｜false	`false`	使用它设定预设的 from 电子邮件地址。
from.name	字串｜false	`false`	使用它设定预设的 from 名称。
validate	布林	`true`	设定为false，如果你不想验证地址。在发送时可能导致失败。
auto_attach	布林	`true`	是否从一个 HTML 主体自动附加（背景）图片。
generate_alt	布林	`true`	是否自动从 HTML 主体产生一个替代的主体。
wordwrap	整数｜false	`76`	文字换行的大小。如果低于任何大于 0 的大小将换行。当使用 base64 或 quoted-printable 时，此设定将被忽略。
sendmail_path	字串	`'/usr/sbin/sendmail'`	sendmail 路径。
smtp.host	字串	`''`	SMTP 主机。
smtp.port	整数	`25`	SMTP 埠。
smtp.username	字串	`''`	SMTP 帐号。
smtp.password	字串	`''`	SMTP 密码。
smtp.timeout	整数	`5`	SMTP 逾时。当 SMTP 伺服器在发送程序期间逾时时增加它。
smtp.starttls	bool	`false`	SMTP 伺服器是否需要 STARTTLS 命令。
newline	字串	`"\n"`	换行。
attach_paths	阵列	`array('');`	附件路径阵列。添加附件时，驱动程序会在这些路径寻找，并附加第一个发现的。留下空 ('') 以允许绝对路径。
return_path	字串｜false	`false`	使用它设定预设的回传路径邮件地址。
remove_html_comments	布林	`true`	When true, all comments inside the HTML body will be stripped.
relative_protocol_replacement	字串｜false	`false`	When set to a string, all relative protocol URI's (those starting with // instead of http://) will be replaced by the value you specify here. This allows you to convert them to http:// or https://, since some Email clients (Outlook!) do not support relative protocol URI's.
mandrill.key	字串	`'api_key'`	你的 Mandrill API 钥匙。
mandrill.message_options	阵列	`array()`	Check Mandrill docs. (Look for message struct)
mandrill.send_options.async	布林	`false`	Enable a background sending mode
mandrill.send_options.ip_pool	字串	`null`	The name of the dedicated ip pool that should be used to send the message
mandrill.send_options.send_at	字串	`null`	When this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format.

Make sure to install mandrill/mandrill composer package if you want to use the mandrill driver.

Mailgun 配置

参数	类型	预设	描述
key	字串	`'YOUR KEY'`	你的 mailgun 的 key。
domain	字串	`'YOUR DOMAIN'`	你网站的网域