README

安装
简介
IMAP
POP3
SMTP
贡献

====

安装

composer install eden/mail

====

简介

Eden 提供了与邮件服务器交互的三种常用方式，包括 SMTP、IMAP 和 POP3。访问每个协议的方式如下所示 图 1。

图 1. 工厂

$imap = eden('mail')->imap(
	'imap.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	993, 
	true);

$pop3 = eden('mail')->pop3(
	'pop.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	995, 
	true);

$smtp = eden('mail')->smtp(
	'smtp.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	465, 
	true);

对于所有三种协议，都需要以下四个要求，且所有要求都取决于您特定的电子邮件服务提供商。在上述图中，我们使用 GMAIL 设置作为示例。最后一个参数是一个标志。如果您的电子邮件服务提供商需要 SSL，请将其设置为 true。

====

IMAP

Eden 的 IMAP 对象使用 fsocket() 而不是 PHP 内置的 IMAP 函数。我们选择使用 fsocket() 完全是因为性能原因。您会发现使用 Eden 设置 IMAP 更加容易。图 2 展示了如何设置 IMAP 对象。

图 2. 设置 IMAP 对象

$imap = eden('mail')->imap(
	'imap.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	993, 
	true);

非常简单，需要以下四个要求，且所有要求都取决于您特定的电子邮件服务提供商。在上述图中，我们使用 GMAIL 设置作为示例。最后一个参数是一个标志。如果您的电子邮件服务提供商需要 SSL，请将其设置为 true。

邮箱

接下来，我们想知道可以设置为活动的可用邮箱。要获取邮箱列表，请参照 图 3。

图 3. 邮箱列表

$mailboxes = $imap->getMailboxes();

执行上述命令将给出以下结果。

Array (
	[0] => Deleted Messages
	[1] => Drafts
	[2] => INBOX
	[3] => Junk E-mail
	[4] => Notes
	[5] => Sent Messages
	[6] => Trash
	[9] => [Gmail]/All Mail
	[10] => [Gmail]/Drafts
	[11] => [Gmail]/Important
	[12] => [Gmail]/Personal
	[13] => [Gmail]/Sent Mail
	[14] => [Gmail]/Spam
	[15] => [Gmail]/Starred
	[16] => [Gmail]/System
	[17] => [Gmail]/Trash
	[18] => [Gmail]/Unsorted
)

我们查看的每个邮件服务器都有一个 INBOX 文件夹。因此，当您不确定时，我们会说这应该是默认的活动邮箱。接下来，我们将 INBOX 设置为活动邮箱。图 4 展示了如何在一行中设置和检索活动邮箱。

图 4. 首先设置活动邮箱！

echo $imap->setMailboxes('INBOX')->getActiveInbox(); //--> INBOX

电子邮件

现在我们已经设置了活动邮箱，我们可以继续获取电子邮件列表。图 5 展示了如何进行操作。

图 5. 获取电子邮件列表

$emails = $imap->getEmails(0, 3); 
$count = $imap->getEmailTotal();

执行上述图示将给出类似以下的结果。

图 5a. 示例电子邮件结果

Array (
	[0] => Array
		(
			[id] => <50041ab1c9383_178f6b3294527919f@job01.tmail>
			[parent] => 
			[topic] => Trending Startups and Updates
			[mailbox] => INBOX
			[uid] => 22363
			[date] => 1342446257
			[subject] => Trending Startups and Updates
			[from] => Array( [name] => AngelList [email] => noreply@angel.co )
			[flags] => Array ( [0] => seen )
			[to] => Array ( [0] => Array( [email] => youremail@gmail.com ) )
			[cc] => Array()
			[bcc] => Array()
		)
	 
	...
)

如您所意识到的，电子邮件列表没有包含完整的正文和附件。标准的 IMAP 实践解释说，您不应该尝试获取详细列表，因为完整数据的体积可能需要很长时间。当用户具体要求查看正文时，才是检索完整细节的时候。图 6 展示了如何获取电子邮件的详细信息。

图 6. 获取完整的电子邮件详情

$email = $imap->getUniqueEmails(22363, true); 
echo $email['body']['text/html'];

在上图中，我们调用 getUniqueEmails()，第一个参数应该是 图 5a 中找到的唯一标识符（UID）。第二个参数是是否想要正文，通常留为 true。您可以使用以下方式通过 UIDs 使用逗号分隔来获取一组成员的电子邮件。

图 6a. 获取多个电子邮件详情

$emails = $imap->getUniqueEmails(array(22363, 22364), true);

在列表请求中包含正文和附件将绝对需要很长时间，并且不建议这样做。

搜索

搜索电子邮件遵循基本的 IMAP 搜索格式。一个搜索示例可以在 图 7 中找到。

图 7. 搜索

$emails = $imap->search(array('TO "youremail@gmail.com"'), 0, 3);

搜索仅限于活动邮箱中的电子邮件。这是 IMAP 标准。没有解决方案。

以下列出了搜索查询的组合

ALL - return all messages matching the rest of the criteria
ANSWERED - match messages with the \\ANSWERED flag set
BCC "string" - match messages with "string" in the Bcc: field
BEFORE "date" - match messages with Date: before "date"
BODY "string" - match messages with "string" in the body of the message
CC "string" - match messages with "string" in the Cc: field
DELETED - match deleted messages
FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set
FROM "string" - match messages with "string" in the From: field
KEYWORD "string" - match messages with "string" as a keyword
NEW - match new messages
OLD - match old messages
ON "date" - match messages with Date: matching "date"
RECENT - match messages with the \\RECENT flag set
SEEN - match messages that have been read (the \\SEEN flag is set)
SINCE "date" - match messages with Date: after "date"
SUBJECT "string" - match messages with "string" in the Subject:
TEXT "string" - match messages with text "string"
TO "string" - match messages with "string" in the To:
UNANSWERED - match messages that have not been answered
UNDELETED - match messages that are not deleted
UNFLAGGED - match messages that are not flagged
UNKEYWORD "string" - match messages that do not have the keyword "string"
UNSEEN - match messages which have not been read yet

操作

你可能想要执行的其他操作包括移动邮件和删除邮件。以下图示展示了使用Eden可以执行的其他基本操作。

图8. 将邮件移动到另一个文件夹

$imap->move(22363, 'Notes');

图9. 删除邮件

$imap->remove(22363, true);

图10. 不要忘记断开连接！

$imap->disconnect();

====

POP3

Eden的POP3对象使用的是fsocket()而不是PHP内置的IMAP函数。我们选择使用fsocket()纯粹是因为性能原因。你会发现使用Eden设置POP3总体上更容易。图11展示了如何设置POP3对象。

图11. 设置POP3对象

$pop3 = eden('mail')->pop3(
	'pop.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	995, 
	true);

非常简单，需要满足四个要求，所有这些要求都取决于你的具体邮件提供商。在上述图示中，我们使用GMAIL设置作为示例。最后一个参数是一个标志。如果你的邮件提供商需要SSL，则将其设置为true。现在我们已经设置了连接信息，我们可以继续获取邮件列表。图12展示了如何进行。

图12. 获取邮件

$emails = $pop3->getEmails(0, 10); 
$count = $pop3->getEmailTotal();

执行上述操作将返回邮件列表以及总数。你可能还想执行的其他操作是删除邮件。以下图示展示了使用Eden可以执行的其他基本操作。

图13. 删除邮件

$pop3->remove(100);

图14. 不要忘记断开连接！

$pop3->disconnect();

====

SMTP

Eden中的SMTP相对简单。我们使用fsocket()而不是PHP内置的SMTP函数。我们选择使用fsocket()是因为PHP的mail()函数可能会将你的邮件放入垃圾邮件文件夹。SMTP效果更好，因为发送的邮件是由你的实际邮件服务器而不是你的Web主机发送的。图15展示了如何设置SMTP对象。

图15. 设置SMTP对象

$smtp = eden('mail')->smtp(
	'smtp.gmail.com', 
	'your_email@gmail.com', 
	'[YOUR PASSWORD]', 
	465, 
	true);

非常简单，需要满足四个要求，所有这些要求都取决于你的具体邮件提供商。在上述图示中，我们使用GMAIL设置作为示例。最后一个参数是一个标志。如果你的邮件提供商需要SSL，则将其设置为true。下一步是简单地发送你的邮件。

图16. 简单发送

$smtp->setSubject('Welcome!')
	->setBody('<p>Hello you!</p>', true)
	->setBody('Hello you!')
	->addTo('email1@gmail.com')
	->addTo('email2@gmail.com')
	->addCC('email3@gmail.com')
	->addCC('email4@gmail.com')
	->addBCC('email5@gmail.com')
	->addBCC('email6@gmail.com')
	->addAttachment('file.jpg', '/path/to/file.jpg', 'mime-type')
	->send();

在图16中，我们基本上列出了你可以使用的所有可能的方法组合来发送邮件。至少设置一次addTo()方法很重要。

图17. 不要忘记断开连接！

$smtp->disconnect();

====

#为Eden做出贡献

对Eden的贡献遵循GitHub工作流程。请在贡献之前阅读。

##使用Eden存储库和你的分支设置你的机器

分支存储库
启动你的本地终端，从你的分支的v4分支创建一个新的分支，分支名称描述你的更改。可能的分支名称类型
- bugfix
- feature
- improvement
进行你的更改。始终确保在所有提交上签名（git commit -s -m "提交信息"）

##创建拉取请求

在创建拉取请求之前，请确保运行phpunit。
将你的代码推送到你的远程分支副本。
回到GitHub上的你的分支副本，提交一个拉取请求。
Eden开发者将审查你的代码，并在它被归类为合适时合并。

versatecnologia / eden-mail

维护者

详细信息

README

安装

简介

IMAP

邮箱

电子邮件

搜索

操作

POP3

SMTP