README

安装
介绍
IMAP
POP3
SMTP
贡献

安装

composer install eden/mail

为了使用

启用Eden

以下文档使用eden()作为示例参考。启用此功能需要额外步骤，如本节所述，如果使用以下方式访问此包则不需要。

Eden\Core\Control::i();

当使用composer时，没有简单的方法可以直接访问包中的函数。作为替代方案，在您的代码中添加此常量将允许eden()在之后可用。

Eden::DECORATOR;

例如

Eden::DECORATOR;

eden()->inspect('Hello World');

介绍

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。您可以通过以下方式用逗号分隔UID以获取多个电子邮件的详细信息。

图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效果更好，因为发送的电子邮件是通过您的实际电子邮件服务器而不是您的网站主机发送的。图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开发者将审查您的代码，并在它被分类为合适时合并。

eden / mail

维护者

详细信息