deblan/clivern-imap
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Wiki Activity

Merge pull request #10 from Clivern/feature/ci

Browse source 
Feature/ci
This commit is contained in:
A. F 2019-02-25 19:38:19 +01:00 committed by GitHub
parent 5194042e15 2491a2130a
commit 59ff2547e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
53 changed files with 2054 additions and 680 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
phpunit.xml.dist Normal file
View file

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.5/phpunit.xsd"
backupGlobals="false"
colors="true"
bootstrap="vendor/autoload.php">
<php>
<ini name="error_reporting" value="-1" />
</php>
<testsuites>
<testsuite name="Project Test Suite">
<directory>tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory>./src/</directory>
</whitelist>
</filter>
</phpunit>

15
.editorconfig
View file

@ -1,15 +0,0 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false

6
.gitignore vendored
View file

@ -1,5 +1,5 @@
/vendor
.phpintel/
coverage.clover
build/
index.php
.env
.php_cs.cache
build

39
.php_cs.dist Normal file
View file

@ -0,0 +1,39 @@
<?php
$fileHeaderComment = <<<COMMENT
This file is part of the Imap PHP package.
(c) Clivern <hello@clivern.com>
COMMENT;
$finder = PhpCsFixer\Finder::create()
->in(__DIR__)
->exclude('var')
;
return PhpCsFixer\Config::create()
->setIndent(" ")
->setLineEnding("\n")
->setRiskyAllowed(true)
->setRules([
'@PSR2' => true,
'@Symfony' => true,
'@Symfony:risky' => true,
'array_syntax' => ['syntax' => 'short'],
'header_comment' => ['header' => $fileHeaderComment, 'separate' => 'both'],
'linebreak_after_opening_tag' => true,
'mb_str_functions' => true,
'no_php4_constructor' => true,
'no_unreachable_default_argument_value' => true,
'no_useless_else' => true,
'no_useless_return' => true,
'ordered_imports' => true,
'php_unit_strict' => true,
'phpdoc_order' => true,
'semicolon_after_instruction' => true,
'strict_comparison' => true,
'strict_param' => true,
'phpdoc_add_missing_param_annotation' => true,
'ordered_class_elements'=> true,
'phpdoc_types_order' => true,
'logical_operators' => true,
])
->setFinder($finder)
->setCacheFile(__DIR__.'/.php_cs.cache')
;

3
.travis.yml
View file

@ -1,5 +1,4 @@
language: php
dist: precise
php:
- 5.6
@ -16,4 +15,4 @@ before_script:
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
script:
- vendor/bin/phpunit --bootstrap vendor/autoload.php --coverage-text --coverage-clover=coverage.clover
- make ci

2
LICENSE
View file

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2017 A. F
Copyright (c) 2017 Cliven
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

57
Makefile Normal file
View file

@ -0,0 +1,57 @@
COMPOSER ?= composer
PHPUNIT_OPTS =
composer:
$(COMPOSER) install
fix:
./vendor/bin/php-cs-fixer fix
fix-diff:
./vendor/bin/php-cs-fixer fix --diff --dry-run -v
test: composer
vendor/bin/phpunit -c .
lint: lint-php phpcs php-cs lint-composer lint-eol
@echo All good.
lint-eol:
@echo "\n==> Validating unix style line endings of files:files"
@! grep -lIUr --color '^M' src/ composer.json composer.lock || ( echo '[ERROR] Above files have CRLF line endings' && exit 1 )
@echo All files have valid line endings
lint-composer:
@echo "\n==> Validating composer.json and composer.lock:"
$(COMPOSER) validate --strict
lint-php:
@echo "\n==> Validating all php files:"
@find src tests -type f -name \*.php | while read file; do php -l "$$file" || exit 1; done
phpcs:
vendor/bin/phpcs
php-cs:
vendor/bin/php-cs-fixer fix --diff --dry-run -v
coverage: composer
vendor/bin/phpunit -c .
ci: composer lint test
@echo "All quality checks passed"
.PHONY: test composer coverage phpcs php-cs lint lint-php ci

8
README.md
View file

@ -2,7 +2,7 @@ Imap
====
:mailbox_with_mail: Access Mailbox Using PHP IMAP.
*Current Version: 1.0.4*
*Current Version: 1.0.5*
[![Build Status](https://travis-ci.org/Clivern/Imap.svg?branch=master)](https://travis-ci.org/Clivern/Imap)
@ -265,6 +265,12 @@ Misc
Changelog
---------
Version 1.0.5:
```
Enhance code style.
Automate code fixes and linting.
```
Version 1.0.4:
```
Fix for plain text messages.

7
composer.json
View file

@ -4,7 +4,6 @@
"description": "Access Mailbox Using PHP IMAP",
"keywords": ["clivern", "imap"],
"license": "MIT",
"type": "project",
"homepage": "https://github.com/clivern/imap",
"authors": [
{
@ -17,7 +16,9 @@
"php": ">=5.6.4"
},
"require-dev": {
"phpunit/phpunit": "~5.7"
"phpunit/phpunit": "~5.7",
"friendsofphp/php-cs-fixer": "^2.14",
"squizlabs/php_codesniffer": "^3.4"
},
"autoload": {
"psr-4": {
@ -32,4 +33,4 @@
"scripts": {
"test": "phpunit"
}
}
}

1405
composer.lock generated
View file

File diff suppressed because it is too large Load diff

7
phpcs.xml Normal file
View file

@ -0,0 +1,7 @@
<?xml version="1.0"?>
<ruleset name="MessageBirdCodingStandard">
<description>Imap coding standard.</description>
<file>src</file>
<file>tests</file>
<rule ref="PSR2" />
</ruleset>

114
src/Core/Connection.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core;
use Clivern\Imap\Core\Exception\AuthenticationFailedException;
/**
* Connection Class
*
* @package Clivern\Imap\Core
* Connection Class.
*/
class Connection
{
/**
* @var string
*/
protected $server;
/**
* @var integer
* @var int
*/
protected $port;
@ -61,7 +60,7 @@ class Connection
protected $timeout;
/**
* Class Constructor
* Class Constructor.
*
* @param string $server
* @param string $port
@ -69,9 +68,8 @@ class Connection
* @param string $password
* @param string $flag
* @param string $folder
* @return void
*/
public function __construct($server, $port, $email, $password, $flag = "/ssl", $folder = "INBOX")
public function __construct($server, $port, $email, $password, $flag = '/ssl', $folder = 'INBOX')
{
$this->server = $server;
$this->port = $port;
@ -82,55 +80,59 @@ class Connection
}
/**
* Connect to IMAP Email
* Connect to IMAP Email.
*
* @throws AuthenticationFailedException
*
* @return Connection
* @throws AuthenticationFailedException
*/
public function connect()
{
try {
$this->stream = imap_open("{" . $this->server . ":" . $this->port . $this->flag . "}" . $this->folder, $this->email, $this->password);
$this->stream = imap_open(
'{'.$this->server.':'.$this->port.$this->flag.'}'.$this->folder,
$this->email,
$this->password
);
} catch (\Exception $e) {
throw new AuthenticationFailedException("Error! Connecting to Imap Email.");
throw new AuthenticationFailedException('Error! Connecting to Imap Email.');
}
return $this;
}
public function reconnect($folder = "INBOX")
public function reconnect($folder = 'INBOX')
{
try {
imap_reopen($this->stream, "{" . $this->server . ":" . $this->port . $this->flag . "}" . $folder);
imap_reopen($this->stream, '{'.$this->server.':'.$this->port.$this->flag.'}'.$folder);
} catch (\Exception $e) {
throw new AuthenticationFailedException("Error! Connecting to Imap Email.");
throw new AuthenticationFailedException('Error! Connecting to Imap Email.');
}
}
public function survive($folder = "INBOX")
public function survive($folder = 'INBOX')
{
if( !$this->ping() || ($this->folder != $folder) ) {
if (!$this->ping() || ($this->folder !== $folder)) {
$this->reconnect($folder);
}
}
/**
* Set Timeout
* Set Timeout.
*
* @param string $timeout_type it may be IMAP_OPENTIMEOUT, IMAP_READTIMEOUT, IMAP_WRITETIMEOUT, or IMAP_CLOSETIMEOUT
* @param integer $timeout time in seconds or -1
* @return void
* @param int $timeout time in seconds or -1
*/
public function setTimeout($timeout_type, $timeout)
{
$this->timeout_type = $timeout_type;
$this->timeout = $timeout;
return (boolean) imap_timeout($timeout_type, $timeout);
return (bool) imap_timeout($timeout_type, $timeout);
}
/**
* Get Stream
* Get Stream.
*
* @return mixed
*/
@ -140,7 +142,7 @@ class Connection
}
/**
* Get Server
* Get Server.
*
* @return string
*/
@ -150,19 +152,20 @@ class Connection
}
/**
* Check Connection
* Check Connection.
*
* @return boolean
* @return bool
*/
public function checkConnection()
{
return (!is_null($this->stream) && imap_ping($this->stream));
return null !== $this->stream && imap_ping($this->stream);
}
/**
* Get Quota
* Get Quota.
*
* @param string $folder
*
* @param string $folder
* @return array
*/
public function getQuota($folder = 'INBOX')
@ -171,20 +174,21 @@ class Connection
return [
'usage' => (isset($data['usage'])) ? $data['usage'] : false,
'limit' => (isset($data['limit'])) ? $data['limit'] : false
'limit' => (isset($data['limit'])) ? $data['limit'] : false,
];
}
/**
* Get Status
* Get Status.
*
* @param string $folder
* @param string $flag
*
* @param string $folder
* @param string $flag
* @return array
*/
public function getStatus($folder = 'INBOX', $flag = SA_ALL)
{
$data = imap_status($this->stream, "{" . $this->server . "}" . $folder, $flag);
$data = imap_status($this->stream, '{'.$this->server.'}'.$folder, $flag);
return [
'flags' => (isset($data->flags)) ? $data->flags : false,
@ -192,12 +196,12 @@ class Connection
'recent' => (isset($data->recent)) ? $data->recent : false,
'unseen' => (isset($data->unseen)) ? $data->unseen : false,
'uidnext' => (isset($data->uidnext)) ? $data->uidnext : false,
'uidvalidity' => (isset($data->uidvalidity)) ? $data->uidvalidity : false
'uidvalidity' => (isset($data->uidvalidity)) ? $data->uidvalidity : false,
];
}
/**
* Check MailBox Data
* Check MailBox Data.
*
* @return array
*/
@ -210,22 +214,22 @@ class Connection
'driver' => (isset($data->Driver)) ? $data->Driver : false,
'mailbox' => (isset($data->Mailbox)) ? $data->Mailbox : false,
'nmsgs' => (isset($data->Nmsgs)) ? $data->Nmsgs : false,
'recent' => (isset($data->Recent)) ? $data->Recent : false
'recent' => (isset($data->Recent)) ? $data->Recent : false,
];
}
/**
* Ping Connection
* Ping Connection.
*
* @return boolean
* @return bool
*/
public function ping()
{
return (boolean) imap_ping($this->stream);
return (bool) imap_ping($this->stream);
}
/**
* Get Errors
* Get Errors.
*
* @return array
*/
@ -233,11 +237,11 @@ class Connection
{
$errors = imap_errors();
return (is_array($errors)) ? $errors : [];
return (\is_array($errors)) ? $errors : [];
}
/**
* Get Alerts
* Get Alerts.
*
* @return array
*/
@ -245,11 +249,11 @@ class Connection
{
$alerts = imap_alerts();
return (is_array($alerts)) ? $alerts : [];
return (\is_array($alerts)) ? $alerts : [];
}
/**
* Get Last Error
* Get Last Error.
*
* @return string
*/
@ -261,22 +265,24 @@ class Connection
}
/**
* Disconnect
* Disconnect.
*
* @param integer $flag
* @return boolean
* @param int $flag
*
* @return bool
*/
public function disconnect($flag = \CL_EXPUNGE)
{
if( !is_null($this->stream) && imap_ping($this->stream) ){
if( imap_close($this->stream, $flag) ){
if (null !== $this->stream && imap_ping($this->stream)) {
if (imap_close($this->stream, $flag)) {
$this->stream = null;
return true;
}else{
return false;
}
return false;
}
return false;
}
}
}

17
src/Core/Exception/AuthenticationFailedException.php
View file

@ -1,25 +1,24 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Exception;
/**
* Connection Error Class
*
* @package Clivern\Imap\Core\Exception
* Connection Error Class.
*/
class AuthenticationFailedException extends \Exception
{
/**
* Class Constructor
* Class Constructor.
*
* @param string $error
*/
public function __construct($error = null)
{
parent::__construct(sprintf("Authentication failed with error: %s", $error));
parent::__construct(sprintf('Authentication failed with error: %s', $error));
}
}
}

17
src/Core/Exception/FolderNotExistException.php
View file

@ -1,25 +1,24 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Exception;
/**
* Folder Not Exist Error Class
*
* @package Clivern\Imap\Core\Exception
* Folder Not Exist Error Class.
*/
class FolderNotExistException extends \Exception
{
/**
* Class Constructor
* Class Constructor.
*
* @param string $folder
*/
public function __construct($folder = null)
{
parent::__construct(sprintf("Mailbox folder not exist: %s", $folder));
parent::__construct(sprintf('Mailbox folder not exist: %s', $folder));
}
}
}

17
src/Core/Exception/MessageDeleteException.php
View file

@ -1,25 +1,24 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Exception;
/**
* Connection Error Class
*
* @package Clivern\Imap\Core\Exception
* Connection Error Class.
*/
class MessageDeleteException extends \Exception
{
/**
* Class Constructor
* Class Constructor.
*
* @param integer $message_number
* @param int $message_number
*/
public function __construct($message_number)
{
parent::__construct(sprintf('Message %s cannot be deleted', $message_number));
}
}
}

17
src/Core/Exception/MessageDoesNotExistException.php
View file

@ -1,26 +1,25 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Exception;
/**
* Connection Error Class
*
* @package Clivern\Imap\Core\Exception
* Connection Error Class.
*/
class MessageDoesNotExistException extends \Exception
{
/**
* Class Constructor
* Class Constructor.
*
* @param integer $number
* @param int $number
* @param string $error
*/
public function __construct($number, $error)
{
parent::__construct(sprintf('Message %s does not exist: %s', $number, $error));
}
}
}

17
src/Core/Exception/MessageMoveException.php
View file

@ -1,26 +1,25 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Exception;
/**
* Connection Error Class
*
* @package Clivern\Imap\Core\Exception
* Connection Error Class.
*/
class MessageMoveException extends \Exception
{
/**
* Class Constructor
* Class Constructor.
*
* @param integer $message_number
* @param int $message_number
* @param string $mailbox
*/
public function __construct($message_number, $mailbox)
{
parent::__construct(sprintf('Message %s cannot be moved to %s', $message_number, $mailbox));
}
}
}

65
src/Core/Message.php
View file

@ -1,20 +1,19 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core;
use Clivern\Imap\Core\Connection;
use Clivern\Imap\Core\Message\Header;
use Clivern\Imap\Core\Message\Action;
use Clivern\Imap\Core\Message\Attachment;
use Clivern\Imap\Core\Message\Body;
use Clivern\Imap\Core\Message\Header;
/**
* Message Class
*
* @package Clivern\Imap\Core
* Message Class.
*/
class Message
{
@ -44,17 +43,17 @@ class Message
protected $body;
/**
* @var integer
* @var int
*/
protected $uid;
/**
* @var integer
* @var int
*/
protected $msg_number;
/**
* Message Constructor
* Message Constructor.
*
* @param Connection $connection
*/
@ -67,9 +66,11 @@ class Message
}
/**
* Set Message Number
* Set Message Number.
*
* @param int $id
* @param mixed $msg_number
*
* @param integer $id
* @return Message
*/
public function setMsgNo($msg_number)
@ -80,9 +81,9 @@ class Message
}
/**
* Get Message Number
* Get Message Number.
*
* @return integer
* @return int
*/
public function getMsgNo()
{
@ -90,9 +91,10 @@ class Message
}
/**
* Set UID
* Set UID.
*
* @param int $uid
*
* @param integer $uid
* @return Message
*/
public function setUid($uid)
@ -103,9 +105,9 @@ class Message
}
/**
* Get UID
* Get UID.
*
* @return integer
* @return int
*/
public function getUid()
{
@ -113,17 +115,17 @@ class Message
}
/**
* Config Message Number & UID
* Config Message Number & UID.
*
* @return Message
*/
public function config()
{
if( !$this->msg_number && $this->uid ){
if (!$this->msg_number && $this->uid) {
$this->msg_number = imap_msgno($this->connection->getStream(), $this->uid);
}
if( !$this->uid && $this->msg_number ){
if (!$this->uid && $this->msg_number) {
$this->uid = imap_uid($this->connection->getStream(), $this->msg_number);
}
@ -131,7 +133,7 @@ class Message
}
/**
* Get Message Header Object
* Get Message Header Object.
*
* @return Header
*/
@ -141,7 +143,7 @@ class Message
}
/**
* Get Message Action Object
* Get Message Action Object.
*
* @return Action
*/
@ -151,7 +153,7 @@ class Message
}
/**
* Get Message Body Object
* Get Message Body Object.
*
* @return Body
*/
@ -161,13 +163,13 @@ class Message
}
/**
* Get Message Attachments
* Get Message Attachments.
*
* @return array
*/
public function attachments()
{
if( !is_null($this->attachments) ){
if (null !== $this->attachments) {
return $this->attachments;
}
@ -180,21 +182,22 @@ class Message
$i = 0;
foreach ($structure->parts as $index => $part) {
if (!$part->ifdisposition){
if (!$part->ifdisposition) {
continue;
}
$this->attachments[$i] = new Attachment($this->connection);
$this->attachments[$i]->config($this->getMsgNo(), $this->getUid(), $index + 1, $part);
$i += 1;
++$i;
}
return $this->attachments;
}
/**
* Get Body
* Get Body.
*
* @param int $options
*
* @param integer $options
* @return string
*/
public function getBody($options = 0)
@ -203,4 +206,4 @@ class Message
return $body;
}
}
}

39
src/Core/Message/Action.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Message;
@ -8,31 +10,27 @@ namespace Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Connection;
/**
* Action Class
*
* @package Clivern\Imap\Core\Message
* Action Class.
*/
class Action
{
/**
* @var Connection
*/
protected $connection;
/**
* @var integer
* @var int
*/
protected $message_number;
/**
* @var integer
* @var int
*/
protected $message_uid;
/**
* Class Constructor
* Class Constructor.
*
* @param Connection $connection
*/
@ -42,10 +40,11 @@ class Action
}
/**
* Config Message
* Config Message.
*
* @param int $message_number
* @param int $message_uid
*
* @param integer $message_number
* @param integer $message_uid
* @return Action
*/
public function config($message_number, $message_uid)
@ -57,22 +56,22 @@ class Action
}
/**
* Delete Message
* Delete Message.
*
* @return boolean
* @return bool
*/
public function delete()
{
return (boolean) imap_delete($this->connection->getStream(), $this->message_uid, \FT_UID);
return (bool) imap_delete($this->connection->getStream(), $this->message_uid, \FT_UID);
}
/**
* Undelete Message
* Undelete Message.
*
* @return boolean
* @return bool
*/
public function undelete()
{
return (boolean) imap_undelete($this->connection->getStream(), $this->message_uid, \FT_UID);
return (bool) imap_undelete($this->connection->getStream(), $this->message_uid, \FT_UID);
}
}
}

109
src/Core/Message/Attachment.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Message;
@ -8,25 +10,22 @@ namespace Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Connection;
/**
* Attachment Class
*
* @package Clivern\Imap\Core\Message
* Attachment Class.
*/
class Attachment
{
/**
* @var Connection
*/
protected $connection;
/**
* @var integer
* @var int
*/
protected $message_number;
/**
* @var integer
* @var int
*/
protected $message_uid;
@ -36,13 +35,12 @@ class Attachment
protected $attachment;
/**
* @var Object
* @var object
*/
protected $part;
/**
* Class Constructor
* Class Constructor.
*
* @param Connection $connection
*/
@ -52,12 +50,13 @@ class Attachment
}
/**
* Config Attachment
* Config Attachment.
*
* @param integer $message_number
* @param integer $message_uid
* @param integer $attachment_id
* @param int $message_number
* @param int $message_uid
* @param int $attachment_id
* @param object $part
*
* @return Attachment
*/
public function config($message_number, $message_uid, $attachment_id, $part)
@ -73,10 +72,11 @@ class Attachment
}
/**
* Get Attachment Property
* Get Attachment Property.
*
* @param string $key
* @param bool $default
*
* @param string $key
* @param boolean $default
* @return mixed
*/
public function get($key, $default = false)
@ -85,7 +85,7 @@ class Attachment
}
/**
* Get Filename
* Get Filename.
*
* @return mixed
*/
@ -95,7 +95,7 @@ class Attachment
}
/**
* Get Extension
* Get Extension.
*
* @return mixed
*/
@ -105,7 +105,7 @@ class Attachment
}
/**
* Get Size
* Get Size.
*
* @return mixed
*/
@ -115,7 +115,7 @@ class Attachment
}
/**
* Get Encoding
* Get Encoding.
*
* @return mixed
*/
@ -125,7 +125,7 @@ class Attachment
}
/**
* Get Bytes
* Get Bytes.
*
* @return mixed
*/
@ -135,49 +135,52 @@ class Attachment
}
/**
* Get Plain Body
* Get Plain Body.
*
* @return mixed
*/
public function getPlainBody()
{
if( $this->get('plain_body') ){
if ($this->get('plain_body')) {
return $this->get('plain_body');
}
$this->attachment['plain_body'] = imap_fetchbody($this->connection->getStream(), $this->message_number, $this->attachment['index']);
$this->attachment['plain_body'] = imap_fetchbody(
$this->connection->getStream(),
$this->message_number,
$this->attachment['index']
);
return $this->get('plain_body');
return $this->get('plain_body');
}
/**
* Get Body
* Get Body.
*
* @throws Exception
*
* @return mixed
* @throws Exception
*/
public function getBody()
{
if( $this->get('body') ){
if ($this->get('body')) {
return $this->get('body');
}
switch ($this->getEncoding()) {
case 0: // 7BIT
case 1: // 8BIT
case 2: // BINARY
$this->attachment['body'] = $this->getPlainBody();
return $this->get('body');
case 3: // BASE-64
$this->attachment['body'] = base64_decode($this->getPlainBody());
$this->attachment['body'] = base64_decode($this->getPlainBody(), true);
return $this->get('body');
case 4: // QUOTED-PRINTABLE
$this->attachment['body'] = imap_qprint($this->getPlainBody());
return $this->get('body');
}
@ -185,27 +188,29 @@ class Attachment
}
/**
* Store File
* Store File.
*
* @param string $path
* @param boolean $file_name
* @return boolean
* @param string $path
* @param bool $file_name
*
* @return bool
*/
public function store($path, $file_name = false)
{
$file_name = ($file_name) ? $file_name : "{$this->getFilename()}.{$this->getExtension()}";
$path = rtrim($path, '/') . "/";
return (boolean) file_put_contents($path . $file_name, $this->getBody());
$path = rtrim($path, '/').'/';
return (bool) file_put_contents($path.$file_name, $this->getBody());
}
/**
* Parse Parts
* Parse Parts.
*
* @return boolean
* @return bool
*/
protected function parseParts()
{
if( (count($this->attachment) > 2) ){
if ((\count($this->attachment) > 2)) {
return true;
}
@ -223,19 +228,19 @@ class Attachment
$this->attachment['ifdparameters'] = (isset($this->part->ifdparameters)) ? $this->part->ifdparameters : false;
$this->attachment['ifparameters'] = (isset($this->part->ifparameters)) ? $this->part->ifparameters : false;
if( is_array($this->part->dparameters) ){
if (\is_array($this->part->dparameters)) {
foreach ($this->part->dparameters as $obj) {
if( in_array(strtolower($obj->attribute), ['filename', 'name']) ){
$this->attachment[strtolower($obj->attribute)] = pathinfo($obj->value, PATHINFO_FILENAME);
if (\in_array(mb_strtolower($obj->attribute), ['filename', 'name'], true)) {
$this->attachment[mb_strtolower($obj->attribute)] = pathinfo($obj->value, PATHINFO_FILENAME);
$this->attachment['extension'] = pathinfo($obj->value, PATHINFO_EXTENSION);
}
}
}
if( is_array($this->part->parameters) ){
if (\is_array($this->part->parameters)) {
foreach ($this->part->parameters as $obj) {
if( in_array(strtolower($obj->attribute), ['filename', 'name']) ){
$this->attachment[strtolower($obj->attribute)] = pathinfo($obj->value, PATHINFO_FILENAME);
if (\in_array(mb_strtolower($obj->attribute), ['filename', 'name'], true)) {
$this->attachment[mb_strtolower($obj->attribute)] = pathinfo($obj->value, PATHINFO_FILENAME);
$this->attachment['extension'] = pathinfo($obj->value, PATHINFO_EXTENSION);
}
}
@ -243,4 +248,4 @@ class Attachment
return true;
}
}
}

47
src/Core/Message/Body.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Message;
@ -8,30 +10,27 @@ namespace Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Connection;
/**
* Body Class
*
* @package Clivern\Imap\Core\Message
* Body Class.
*/
class Body
{
/**
* @var Connection
*/
protected $connection;
/**
* @var integer
* @var int
*/
protected $message_number;
/**
* @var integer
* @var int
*/
protected $message_uid;
/**
* @var integer
* @var int
*/
protected $encoding;
@ -40,9 +39,8 @@ class Body
*/
protected $message = '';
/**
* Class Constructor
* Class Constructor.
*
* @param Connection $connection
*/
@ -52,10 +50,11 @@ class Body
}
/**
* Config Body
* Config Body.
*
* @param int $message_number
* @param int $message_uid
*
* @param integer $message_number
* @param integer $message_uid
* @return Body
*/
public function config($message_number, $message_uid)
@ -67,29 +66,29 @@ class Body
}
/**
* Get Message
* Get Message.
*
* @param int $option
*
* @param integer $option
* @return string
*/
public function getMessage($option = 2)
{
if( !empty($this->message) ){
if (!empty($this->message)) {
return $this->message;
}
$structure = imap_fetchstructure($this->connection->getStream(), $this->message_number);
if (isset($structure->parts) && is_array($structure->parts) && isset($structure->parts[1])) {
if (isset($structure->parts) && \is_array($structure->parts) && isset($structure->parts[1])) {
$part = $structure->parts[1];
$this->message = imap_fetchbody($this->connection->getStream(),$this->message_number , $option);
$this->message = imap_fetchbody($this->connection->getStream(), $this->message_number, $option);
$this->encoding = $part->encoding;
if($part->encoding == 3) {
if (3 === $part->encoding) {
$this->message = imap_base64($this->message);
} elseif($part->encoding == 1) {
} elseif (1 === $part->encoding) {
$this->message = imap_8bit($this->message);
} else {
$this->message = imap_qprint($this->message);
@ -102,9 +101,9 @@ class Body
}
/**
* Get Encoding
* Get Encoding.
*
* @return integer
* @return int
*/
public function getEncoding()
{

64
src/Core/Message/Header.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Message;
@ -8,25 +10,22 @@ namespace Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Connection;
/**
* Header Class
*
* @package Clivern\Imap\Core\Message
* Header Class.
*/
class Header
{
/**
* @var Connection
*/
protected $connection;
/**
* @var integer
* @var int
*/
protected $message_number;
/**
* @var integer
* @var int
*/
protected $message_uid;
@ -35,9 +34,8 @@ class Header
*/
protected $header = [];
/**
* Class Constructor
* Class Constructor.
*
* @param Connection $connection
*/
@ -47,15 +45,17 @@ class Header
}
/**
* Config Message
* Config Message.
*
* @param int $message_number
* @param int $message_uid
* @param mixed $options
*
* @param integer $message_number
* @param integer $message_uid
* @return Header
*/
public function config($message_number, $message_uid, $options = 0)
{
if( !empty($this->header) ){
if (!empty($this->header)) {
return $this;
}
@ -67,37 +67,41 @@ class Header
}
/**
* Get From Header
* Get From Header.
*
* @param string $key
* @param bool $default
*
* @param string $key
* @param boolean $default
* @return mixed
*/
public function get($key, $default = false)
{
return (isset($this->header[strtolower($key)])) ? $this->header[strtolower($key)] : $default;
return (isset($this->header[mb_strtolower($key)])) ? $this->header[mb_strtolower($key)] : $default;
}
/**
* Check if header has key
* Check if header has key.
*
* @param string $key
* @return boolean
* @param string $key
*
* @return bool
*/
public function has($key)
{
return (isset($this->header[strtolower($key)]));
return isset($this->header[mb_strtolower($key)]);
}
/**
* Parse Address List
* Parse Address List.
*
* @param string $address_string
* @param mixed $default_host
*
* @return array
*/
public function parseAddressList($address_string, $default_host = "example.com")
public function parseAddressList($address_string, $default_host = 'example.com')
{
$address_array = imap_rfc822_parse_adrlist($address_string, $default_host);
$address_array = imap_rfc822_parse_adrlist($address_string, $default_host);
$address_list = [];
foreach ($address_array as $id => $val) {
@ -105,7 +109,7 @@ class Header
'mailbox' => $val->mailbox,
'host' => $val->host,
'personal' => $val->personal,
'adl' => $val->adl
'adl' => $val->adl,
];
}
@ -113,9 +117,10 @@ class Header
}
/**
* Load Header Data
* Load Header Data.
*
* @param mixed $options
*
* @return Header
*/
protected function load($options = 0)
@ -129,7 +134,8 @@ class Header
$this->header['date'] = (isset($item_overview->date)) ? $item_overview->date : false;
$this->header['message_id'] = (isset($item_overview->message_id)) ? $item_overview->message_id : false;
$this->header['in_reply_to'] = (isset($item_overview->in_reply_to)) ? $item_overview->in_reply_to : false;
$this->header['references'] = (isset($item_overview->references)) ? explode(" ", $item_overview->references) : false;
$this->header['references'] = (isset($item_overview->references)) ?
explode(' ', $item_overview->references) : false;
$this->header['size'] = (isset($item_overview->size)) ? $item_overview->size : false;
$this->header['uid'] = (isset($item_overview->uid)) ? $item_overview->uid : false;
$this->header['msgno'] = (isset($item_overview->msgno)) ? $item_overview->msgno : false;
@ -144,4 +150,4 @@ class Header
return $this;
}
}
}

31
src/Core/MessageIterator.php
View file

@ -1,34 +1,31 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core;
use Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Connection;
use Clivern\Imap\Core\Message\Header;
use Clivern\Imap\Core\Message\Action;
use Clivern\Imap\Core\Message\Body;
use Clivern\Imap\Core\Message\Header;
/**
* Message Iterator Class
*
* @package Clivern\Imap\Core
* Message Iterator Class.
*/
class MessageIterator extends \ArrayIterator
{
/**
* @var Connection
*/
protected $connection;
/**
* Constructor
* Constructor.
*
* @param Connection $connection
* @param array $message_numbers
* @param array $message_numbers
*/
public function __construct(Connection $connection, array $message_numbers)
{
@ -37,13 +34,19 @@ class MessageIterator extends \ArrayIterator
}
/**
* Get current message
* Get current message.
*
* @return Message
*/
public function current()
{
$message = new Message($this->connection, new Header($this->connection), new Action($this->connection), new Body($this->connection));
$message = new Message(
$this->connection,
new Header($this->connection),
new Action($this->connection),
new Body($this->connection)
);
return $message->setUid(parent::current())->config();
}
}
}

38
src/Core/Search.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core;
@ -8,22 +10,30 @@ namespace Clivern\Imap\Core;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Search Class
*
* @package Clivern\Imap\Core
* Search Class.
*/
class Search
{
/**
* @var array
*/
protected $conditions = [];
/**
* Add Condition
* Get Conditions Query.
*
* @return string
*/
public function __toString()
{
return (!empty($this->conditions)) ? implode(' ', $this->conditions) : '';
}
/**
* Add Condition.
*
* @param Condition $condition
*
* @return Search
*/
public function addCondition(Condition $condition)
@ -34,7 +44,7 @@ class Search
}
/**
* Get Conditions
* Get Conditions.
*
* @return array
*/
@ -42,14 +52,4 @@ class Search
{
return $this->conditions;
}
/**
* Get Conditions Query
*
* @return string
*/
public function __toString()
{
return (!empty($this->conditions)) ? implode(" ", $this->conditions) : "";
}
}
}

17
src/Core/Search/Condition/All.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* All Class
*
* @package Clivern\Imap\Core\Search\Condition
* All Class.
*/
class All implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "ALL";
return 'ALL';
}
}
}

17
src/Core/Search/Condition/Answered.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Answered Class
*
* @package Clivern\Imap\Core\Search\Condition
* Answered Class.
*/
class Answered implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "ANSWERED";
return 'ANSWERED';
}
}
}

17
src/Core/Search/Condition/BCC.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* BCC Class
*
* @package Clivern\Imap\Core\Search\Condition
* BCC Class.
*/
class BCC implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class BCC implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class BCC implements Condition
{
return "BCC \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Before.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Before Class
*
* @package Clivern\Imap\Core\Search\Condition
* Before Class.
*/
class Before implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Before implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Before implements Condition
{
return "BEFORE \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Body.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Body Class
*
* @package Clivern\Imap\Core\Search\Condition
* Body Class.
*/
class Body implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Body implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Body implements Condition
{
return "BODY \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/CC.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* CC Class
*
* @package Clivern\Imap\Core\Search\Condition
* CC Class.
*/
class CC implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class CC implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class CC implements Condition
{
return "CC \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Deleted.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Deleted Class
*
* @package Clivern\Imap\Core\Search\Condition
* Deleted Class.
*/
class Deleted implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "DELETED";
return 'DELETED';
}
}
}

17
src/Core/Search/Condition/Flagged.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Flagged Class
*
* @package Clivern\Imap\Core\Search\Condition
* Flagged Class.
*/
class Flagged implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "FLAGGED";
return 'FLAGGED';
}
}
}

17
src/Core/Search/Condition/From.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* From Class
*
* @package Clivern\Imap\Core\Search\Condition
* From Class.
*/
class From implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class From implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class From implements Condition
{
return "FROM \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Keyword.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Keyword Class
*
* @package Clivern\Imap\Core\Search\Condition
* Keyword Class.
*/
class Keyword implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Keyword implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Keyword implements Condition
{
return "KEYWORD \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/NewFlag.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* New Flag Class
*
* @package Clivern\Imap\Core\Search\Condition
* New Flag Class.
*/
class NewFlag implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "NEW";
return 'NEW';
}
}
}

17
src/Core/Search/Condition/Old.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Old Class
*
* @package Clivern\Imap\Core\Search\Condition
* Old Class.
*/
class Old implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "OLD";
return 'OLD';
}
}
}

17
src/Core/Search/Condition/On.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* On Class
*
* @package Clivern\Imap\Core\Search\Condition
* On Class.
*/
class On implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class On implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class On implements Condition
{
return "ON \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Recent.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* All Class
*
* @package Clivern\Imap\Core\Search\Condition
* All Class.
*/
class Recent implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "RECENT";
return 'RECENT';
}
}
}

17
src/Core/Search/Condition/Seen.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Seen Class
*
* @package Clivern\Imap\Core\Search\Condition
* Seen Class.
*/
class Seen implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "SEEN";
return 'SEEN';
}
}
}

17
src/Core/Search/Condition/Since.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Since Class
*
* @package Clivern\Imap\Core\Search\Condition
* Since Class.
*/
class Since implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Since implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Since implements Condition
{
return "SINCE \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Subject.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Subject Class
*
* @package Clivern\Imap\Core\Search\Condition
* Subject Class.
*/
class Subject implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Subject implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Subject implements Condition
{
return "SUBJECT \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/Text.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* Text Class
*
* @package Clivern\Imap\Core\Search\Condition
* Text Class.
*/
class Text implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class Text implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class Text implements Condition
{
return "TEXT \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/To.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* To Class
*
* @package Clivern\Imap\Core\Search\Condition
* To Class.
*/
class To implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class To implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class To implements Condition
{
return "TO \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/UnAnswered.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* UnAnswered Class
*
* @package Clivern\Imap\Core\Search\Condition
* UnAnswered Class.
*/
class UnAnswered implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "UNANSWERED";
return 'UNANSWERED';
}
}
}

17
src/Core/Search/Condition/UnDeleted.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* UnDeleted Class
*
* @package Clivern\Imap\Core\Search\Condition
* UnDeleted Class.
*/
class UnDeleted implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "UNDELETED";
return 'UNDELETED';
}
}
}

17
src/Core/Search/Condition/UnFlagged.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* UnFlagged Class
*
* @package Clivern\Imap\Core\Search\Condition
* UnFlagged Class.
*/
class UnFlagged implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "UNFLAGGED";
return 'UNFLAGGED';
}
}
}

17
src/Core/Search/Condition/UnKeyword.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* UnKeyword Class
*
* @package Clivern\Imap\Core\Search\Condition
* UnKeyword Class.
*/
class UnKeyword implements Condition
{
/**
* @var string
*/
protected $data;
/**
* Class Constructor
* Class Constructor.
*
* @param string $data
*/
@ -31,7 +30,7 @@ class UnKeyword implements Condition
}
/**
* Query String
* Query String.
*
* @return string
*/
@ -39,4 +38,4 @@ class UnKeyword implements Condition
{
return "UNKEYWORD \"{$this->data}\"";
}
}
}

17
src/Core/Search/Condition/UnSeen.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Condition;
@ -8,20 +10,17 @@ namespace Clivern\Imap\Core\Search\Condition;
use Clivern\Imap\Core\Search\Contract\Condition;
/**
* UnSeen Class
*
* @package Clivern\Imap\Core\Search\Condition
* UnSeen Class.
*/
class UnSeen implements Condition
{
/**
* Query String
* Query String.
*
* @return string
*/
public function __toString()
{
return "UNSEEN";
return 'UNSEEN';
}
}
}

12
src/Core/Search/Contract/Condition.php
View file

@ -1,16 +1,16 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap\Core\Search\Contract;
/**
* Condition Interface
*
* @package Clivern\Imap\Core\Search\Contract
* Condition Interface.
*/
interface Condition
{
public function __toString();
}
}

75
src/MailBox.php
View file

@ -1,28 +1,27 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Clivern\Imap;
use Clivern\Imap\Core\Connection;
use Clivern\Imap\Core\MessageIterator;
use Clivern\Imap\Core\Exception\FolderNotExistException;
use Clivern\Imap\Core\Message;
use Clivern\Imap\Core\Search;
use Clivern\Imap\Core\Message\Header;
use Clivern\Imap\Core\Message\Action;
use Clivern\Imap\Core\Message\Attachments;
use Clivern\Imap\Core\Message\Body;
use Clivern\Imap\Core\Exception\FolderNotExistException;
use Clivern\Imap\Core\Message\Header;
use Clivern\Imap\Core\MessageIterator;
use Clivern\Imap\Core\Search;
/**
* MailBox Class
*
* @package Clivern\Imap
* MailBox Class.
*/
class MailBox
{
/**
* @var string
*/
@ -38,9 +37,8 @@ class MailBox
*/
protected $folders = [];
/**
* Constructor
* Constructor.
*
* @param Connection $connection IMAP connection
*/
@ -50,14 +48,15 @@ class MailBox
}
/**
* Set Folder Name
* Set Folder Name.
*
* @param string $folder
*
* @return MailBox
*/
public function setFolder($folder)
{
if( !in_array($folder, $this->getFolders()) ){
if (!\in_array($folder, $this->getFolders(), true)) {
throw new FolderNotExistException($folder);
}
@ -67,7 +66,7 @@ class MailBox
}
/**
* Get Folder name
* Get Folder name.
*
* @return string
*/
@ -77,20 +76,22 @@ class MailBox
}
/**
* Get number of messages in this mailbox
* Get number of messages in this mailbox.
*
* @return int
*/
public function count()
{
$this->connection->survive($this->folder);
return imap_num_msg($this->connection->getStream());
}
/**
* Get message ids
* Get message ids.
*
* @param Search $search
*
* @return MessageIterator
*/
public function getMessages(Search $search = null)
@ -99,7 +100,7 @@ class MailBox
$query = ($search) ? (string) $search : 'ALL';
$message_numbers = imap_search($this->connection->getStream(), $query, \SE_UID);
if (false == $message_numbers) {
if (false === $message_numbers) {
// imap_search can also return false
$message_numbers = [];
}
@ -108,53 +109,61 @@ class MailBox
}
/**
* Get a message by message number or uid
* Get a message by message number or uid.
*
* @param bool|int $message_number
* @param bool|int $message_uid
*
* @param int|boolean $message_number
* @param int|boolean $message_uid
* @return Message
*/
public function getMessage($message_number = false, $message_uid = false)
{
$this->connection->survive($this->folder);
$message = new Message($this->connection, new Header($this->connection), new Action($this->connection), new Attachments($this->connection), new Body($this->connection));
$message = new Message(
$this->connection,
new Header($this->connection),
new Action($this->connection),
new Attachments($this->connection),
new Body($this->connection)
);
if( $message_number == false ){
if (false === $message_number) {
return $message->setUid($message_uid)->config();
}else{
return $message->setMsgNo($message_number)->config();
}
return $message->setMsgNo($message_number)->config();
}
/**
* Delete all messages marked for deletion
* Delete all messages marked for deletion.
*
* @return boolean
* @return bool
*/
public function expunge()
{
$this->connection->survive($this->folder);
return (boolean) imap_expunge($this->connection->getStream());
return (bool) imap_expunge($this->connection->getStream());
}
/**
* Get Folders List
* Get Folders List.
*
* @return array
*/
public function getFolders()
{
if( !empty($this->folders) ){
if (!empty($this->folders)) {
return $this->folders;
}
$this->folders = imap_getmailboxes($this->connection->getStream(), "{" . $this->connection->getServer() . "}", "*");
$this->folders = imap_getmailboxes($this->connection->getStream(), '{'.$this->connection->getServer().'}', '*');
foreach ($this->folders as $key => $folder) {
$this->folders[$key] = str_replace("{" . $this->connection->getServer() . "}", "", $folder->name);
$this->folders[$key] = str_replace('{'.$this->connection->getServer().'}', '', $folder->name);
}
return $this->folders;
}
}
}

18
tests/Core/ConnectionTest.php
View file

@ -1,4 +1,10 @@
<?php
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Tests\Core;
use PHPUnit\Framework\TestCase;
@ -7,10 +13,10 @@ class ConnectionTest extends TestCase
{
public function testConnect()
{
#$email = getenv("TEST_EMAIL");
#$password = getenv("TEST_EMAIL_PASS");
#$connection = new \Clivern\Imap\Core\Connection("imap.gmail.com", "993", $email, $password, "/ssl", "INBOX");
#$this->assertTrue($connection->connect()->checkConnection());
#$this->assertTrue($connection->connect()->disconnect());
//$email = getenv("TEST_EMAIL");
//$password = getenv("TEST_EMAIL_PASS");
//$connection = new \Clivern\Imap\Core\Connection("imap.gmail.com", "993", $email, $password, "/ssl", "INBOX");
//$this->assertTrue($connection->connect()->checkConnection());
//$this->assertTrue($connection->connect()->disconnect());
}
}
}

45
tests/Core/SearchTest.php
View file

@ -1,4 +1,10 @@
<?php
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Tests\Core;
use PHPUnit\Framework\TestCase;
@ -8,8 +14,32 @@ class SearchTest extends TestCase
public function testConditionBuilder()
{
$search = new \Clivern\Imap\Core\Search();
$search->addCondition(new \Clivern\Imap\Core\Search\Condition\All())->addCondition(new \Clivern\Imap\Core\Search\Condition\Answered())->addCondition(new \Clivern\Imap\Core\Search\Condition\BCC("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Before("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Body("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\CC("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Deleted())->addCondition(new \Clivern\Imap\Core\Search\Condition\Flagged())->addCondition(new \Clivern\Imap\Core\Search\Condition\From("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Keyword("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\NewFlag())->addCondition(new \Clivern\Imap\Core\Search\Condition\Old())->addCondition(new \Clivern\Imap\Core\Search\Condition\On("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Recent())->addCondition(new \Clivern\Imap\Core\Search\Condition\Seen())->addCondition(new \Clivern\Imap\Core\Search\Condition\Since("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Subject("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\Text("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\To("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\UnAnswered())->addCondition(new \Clivern\Imap\Core\Search\Condition\UnDeleted())->addCondition(new \Clivern\Imap\Core\Search\Condition\UnFlagged())->addCondition(new \Clivern\Imap\Core\Search\Condition\UnKeyword("val"))->addCondition(new \Clivern\Imap\Core\Search\Condition\UnSeen());
$this->assertEquals($search->getConditions(), [
$search->addCondition(new \Clivern\Imap\Core\Search\Condition\All())
->addCondition(new \Clivern\Imap\Core\Search\Condition\Answered())
->addCondition(new \Clivern\Imap\Core\Search\Condition\BCC('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Before('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Body('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\CC('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Deleted())
->addCondition(new \Clivern\Imap\Core\Search\Condition\Flagged())
->addCondition(new \Clivern\Imap\Core\Search\Condition\From('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Keyword('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\NewFlag())
->addCondition(new \Clivern\Imap\Core\Search\Condition\Old())
->addCondition(new \Clivern\Imap\Core\Search\Condition\On('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Recent())
->addCondition(new \Clivern\Imap\Core\Search\Condition\Seen())
->addCondition(new \Clivern\Imap\Core\Search\Condition\Since('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Subject('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\Text('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\To('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\UnAnswered())
->addCondition(new \Clivern\Imap\Core\Search\Condition\UnDeleted())
->addCondition(new \Clivern\Imap\Core\Search\Condition\UnFlagged())
->addCondition(new \Clivern\Imap\Core\Search\Condition\UnKeyword('val'))
->addCondition(new \Clivern\Imap\Core\Search\Condition\UnSeen());
$this->assertSame($search->getConditions(), [
'ALL',
'ANSWERED',
'BCC "val"',
@ -33,8 +63,13 @@ class SearchTest extends TestCase
'UNDELETED',
'UNFLAGGED',
'UNKEYWORD "val"',
'UNSEEN'
'UNSEEN',
]);
$this->assertEquals((string) $search, 'ALL ANSWERED BCC "val" BEFORE "val" BODY "val" CC "val" DELETED FLAGGED FROM "val" KEYWORD "val" NEW OLD ON "val" RECENT SEEN SINCE "val" SUBJECT "val" TEXT "val" TO "val" UNANSWERED UNDELETED UNFLAGGED UNKEYWORD "val" UNSEEN');
$this->assertSame(
(string) $search,
'ALL ANSWERED BCC "val" BEFORE "val" BODY "val" CC "val" DELETED FLAGGED FROM "val" KEYWORD "val" '.
'NEW OLD ON "val" RECENT SEEN SINCE "val" SUBJECT "val" TEXT "val" TO "val" UNANSWERED UNDELETED '.
'UNFLAGGED UNKEYWORD "val" UNSEEN'
);
}
}
}

12
tests/MailBoxTest.php
View file

@ -1,6 +1,8 @@
<?php
/**
* @author clivern <hello@clivern.com>
/*
* This file is part of the Imap PHP package.
* (c) Clivern <hello@clivern.com>
*/
namespace Tests;
@ -8,9 +10,7 @@ namespace Tests;
use PHPUnit\Framework\TestCase;
/**
* MailBox Class Test
*
* @package Tests
* MailBox Class Test.
*/
class MailBoxTest extends TestCase
{
@ -18,4 +18,4 @@ class MailBoxTest extends TestCase
{
$this->assertTrue(true);
}
}
}