3xw/cakephp-mailparser

CakePHP 邮件解析器

安装: 37

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 3

分支: 0

公开问题: 0

类型:cakephp 插件

3.4.0.3 2017-07-25 07:49 UTC

This package is auto-updated.

Last update: 2024-09-10 17:33:16 UTC


README

Software License

使用此插件连接邮件账户,检索邮件(及相关附件)。提供了一个基类解析器,用于解析 csv/xls 文件,并通过您的模型将数据存储到您的数据库中。

此插件附带非常有用的库

"dereuromark/cakephp-queue": "^3.4",
"php-imap/php-imap": "~2.0",
"league/csv": "^8.2",
"phpoffice/phpexcel": "^1.8"

安装

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。

安装 composer 包的推荐方法是

composer require 3xw/cakephp-mailparser

将其加载到您的 config/boostrap.php 中

not needed

工作者

SaveMailAttachments 队列任务

基于 dereuromark/cakephp-queue,您可以直接使用 SaveMailAttachments 任务。您可以将任务添加到工作者列表中

$this->QueuedJobs->createJob('SaveMailAttachments', [
	'name' => 'Save mail attachments',
	'data' => [
		'username' => 'username',
		'password' => 'password',
		'mailbox' => '{imap.example.org:993/imap/ssl}INBOX',
		'mailObjectNeedles' => ['test','exemple'], 	// mail objects array to look for
		'fileNeedles' => ['.*\.xlsx'], 				// file serach strings array based on cakephp's Folder::find() fct
		'folder' => TMP.'MailAttachments/' 			// folder to copy files in. ( be sure folder exists if php is not allowed to create the very folder )
	]
]);

扩展 SaveMailAttachments 队列任务

在这里找到一个扩展 SaveMailAttachments 任务的示例

<?
namespace App\Shell\Task;

use App\Parser\CsvToModelParser; // a custom parser that extends Trois\MailParser\Parser\Parser
use Trois\MailParser\Shell\Task\QueueSaveMailAttachmentsTask;

class QueueGetLastCsvTask extends QueueSaveMailAttachmentsTask
{
  public $defaults = [
	'username' => 'xxx',
	'password' => 'xx',
	'mailbox' => '{mail.xxx.com:993/imap/ssl}INBOX',
	'mailObjectNeedles' => ['Object 1','Object 2'],
	'fileNeedles' => ['.*\.csv'],
	'folder' => TMP.'foo/' // needed even if not used...
	];

  public $parser = null;

  public function run(array $data, $id)
  {
    $this->_connect();
    $this->parser = new CsvToModelParser();
    $count = 0;
    $rows = 0;
    $success = 0;
    foreach($this->defaults['mailObjectNeedles'] as $needle)
    {
      $files = $this->_getMailAttachments($needle);
      foreach($files as $key => $file)
      {
        $count++;
        $this->out('proccessing file: '.$key.' -> '.$file->name);
        $results = $this->parser->save($file);
        if(empty($results))
        {
          $this->err('Error parsing file -> No record saved');
        }else{
          $rows += count($results);
          $this->info(count($results).' positions were successfully stored!');
          $success++;
        }
      }
      $this->_clean();
    }

    // inform
    $status = $success.' files were successfully parsed on '.$count.', '.$rows.' positions were stored in db';
    return $this->_finish($status, $id);
  }
}

现在您可以直接添加此任务

bin/cake Queue add GetLastCsv

并运行工作者

bin/cake Queue runworker

解析器

类 Trois\MailParser\Parser\Parser 将帮助您解析文件。它实现了 Trois\MailParser\Parser\iParser 接口,如下所示

<?
namespace Trois\MailParser\Parser;

use Cake\Filesystem\File;

interface iParser
{
  public function fileToEntities(File $file);

  public function save(File $file);
}

解析器类

此类将为您初始化模型,并使用主模型保存解析的实体。其概念是:文件对模型

<?
namespace Trois\MailParser\Parser;

use Cake\ORM\TableRegistry;
use Cake\Filesystem\File;
use Cake\Core\InstanceConfigTrait;

class Parser implements iParser
{
  use InstanceConfigTrait;

  public $reader = null;

  protected $_defaultConfig = [
    'model' => 'ExempleModelTable',
    'extraModels' => []
  ];

  public function __construct(array $config = [])
  {
    $this->setConfig($config);
    $this->initialize($config);
  }

  public function initialize(array $config)
  {
    $model = $this->config('model');
    $models = $this->config('extraModels');
    if($models && is_array($models))
    {
      $models[] = $model;
    }else
    {
      $models = [$model];
    }
    foreach($models as $model)
    {
      $this->{$model} = TableRegistry::get($model);
    }
  }

  public function fileToEntities(File $file)
  {
    return [];
  }

  public function save(File $file)
  {
    $entities = $this->fileToEntities($file);
    if($entities){
      return $this->{$this->config('model')}->saveMany($entities);
    }
    return [];
  }
}

扩展解析器类

以下是一个使用 league/csv 解析 csv 文件的示例

<?
namespace App\Parser;

use League\Csv\Reader;
use Cake\Filesystem\File;
use Trois\MailParser\Parser\Parser;

class CsvToModelParser extends Parser
{
  protected $_defaultConfig = [
    'model' => 'ModelOne',
    'extraModels' => []
  ];

  public function fileToEntities(File $file)
  {
    $reader = Reader::createFromPath($file->path)->setDelimiter(';');
    $headers = $reader->fetchOne();
    $entities = [];
    foreach($reader->setOffset(1)->fetchAssoc($headers) as $row)
    {
    	$entities[] = $row;
    }
    return $this->ModelOne->newEntities($entities); // ModelOne was created for you using $_defaultConfig
  }
}

如“扩展 SaveMailAttachments 队列任务”中所示,继承的方法

$this->/*parser->*/save($file);

将返回以下结果

$YourModel->saveMany($entities);