README

###飞行鱼邮件发送器库

###这不是用于任何用途的。它只是在这里用于Composer测试，以及开发目的。我仍在大力开发这个库 - 实际上是我之前已经构建的一个库的移植。

####介绍飞行鱼邮件发送器库是FlyingPiranhas wireframe的一部分。它帮助我快速安全地开发网站，所以我决定与世界分享它。有关更多信息及其作者，请访问主页并阅读。

####邮件发送器这是邮件发送器库，意味着它专注于高级邮件发送功能。

####使用在发送之前，您必须在邮件发送器的当前实例上调用Mailer::setDeveloperRecipient()。这是一个安全措施 - 它启用发送。如果您传入一个电子邮件作为参数，该电子邮件将覆盖所有收件人并接收而不是原本打算接收的电子邮件。这对于测试批量邮件功能而不向用户发送垃圾邮件非常有用。要禁用此措施，只需不带参数调用该方法即可。

邮件发送器通过方法expressMail支持“快速邮件”功能。此方法需要一个包含“收件人”和“正文”的数组，可选的“主题”和“发件人”。如果省略“发件人”，则应通过静态方法Mailer::setDefaultSender()提供。expressMail方法默认不需要Repo，只要您将第二个参数保持为false。一旦第二个参数为true，它将尝试归档发送的电子邮件，除非您为其提供Repo类，否则它将失败。需要注意的是，电子邮件仍然会被发送，只是归档失败时抛出异常。

常规邮件发送通过Mailer::prepareEmail()进行，但需要Repo。只需传递所需的参数，然后调用sendPreparedEmails或queuePreparedEmails。发送将立即发送电子邮件并将其归档为已发送。队列将将其放入Repo队列，稍后检索和发送。一旦发送了队列中的电子邮件，它就会被标记为已发送。有关更多信息及示例，请参阅主页和深入文档（即将推出）。

####模板和示例除了主站外，/fp子文件夹中还有一个默认的MySQL/MariaDB Repo。那里还有一个SQL脚本文件（以及一个工作台模型），您可以使用它来构建MySQL/MariaDB Repo。将Repo注入到邮件发送器类中，您就可以在项目中使用MySQL邮件发送器实现。或者，使用Repo类构建自己的，然后注入它。只要它实现了MailRepository接口，就可以。不久还将有一个PostreSQL示例Repo在同一文件夹中，可供生产使用。请注意，当前的示例Repo扩展了fp/common中的适配器。

建议您为电子邮件数据库保留一个单独的模式，这样将使备份和恢复变得简单得多。

####要求

• Php 5.4+
• Swift Mailer（将"swiftmailer/swiftmailer":"v4.3.0"（或更高版本）添加到您的composer.json文件的要求块中）
• IMAP扩展，用于检查您上次向特定人员发送电子邮件的时间
• flyingpiranhas/common

####安装您可以使用composer安装fpmailer库。只需在packagist.org上搜索flyingpiranhas/mailer，并将其添加到您的composer.json文件中即可轻松安装。您也可以从github下载zip文件，然后将常规PSR自动加载器指向文件夹，但composer是首选方法，因为它允许我们轻松更新库并修复我们发现的问题和漏洞。

####许可证请参阅LICENSE.md

####贡献代码中有许多@todos，您可以随时查看并提交一个pull request如果您修复了任何内容。另外，我们急需编写测试。只有一个规则：尽可能遵循PSR-2。使用其他类作为示例，并保持编码风格一致。

####联系我们在Twitter上，我在Google plus或我的网站上。