forked from Wavyzz/dolibarr
375 lines
10 KiB
PHP
375 lines
10 KiB
PHP
<?php
|
|
/*
|
|
* File: ImapProtocol.php
|
|
* Category: Protocol
|
|
* Author: M.Goldenbaum
|
|
* Created: 16.09.20 18:27
|
|
* Updated: -
|
|
*
|
|
* Description:
|
|
* -
|
|
*/
|
|
|
|
namespace Webklex\PHPIMAP\Connection\Protocols;
|
|
|
|
use ErrorException;
|
|
use Webklex\PHPIMAP\Exceptions\AuthFailedException;
|
|
use Webklex\PHPIMAP\Exceptions\ConnectionFailedException;
|
|
use Webklex\PHPIMAP\Exceptions\InvalidMessageDateException;
|
|
use Webklex\PHPIMAP\Exceptions\MessageNotFoundException;
|
|
use Webklex\PHPIMAP\Exceptions\RuntimeException;
|
|
|
|
/**
|
|
* Interface ProtocolInterface
|
|
*
|
|
* @package Webklex\PHPIMAP\Connection\Protocols
|
|
*/
|
|
interface ProtocolInterface {
|
|
|
|
/**
|
|
* Protocol constructor.
|
|
* @param bool $cert_validation set to false to skip SSL certificate validation
|
|
*/
|
|
public function __construct($cert_validation = true);
|
|
|
|
/**
|
|
* Public destructor
|
|
*/
|
|
public function __destruct();
|
|
|
|
/**
|
|
* Open a new connection / session
|
|
* @param string $host hostname or IP address of IMAP server
|
|
* @param int|null $port of service server
|
|
*
|
|
* @throws ErrorException
|
|
* @throws ConnectionFailedException
|
|
* @throws RuntimeException
|
|
*/
|
|
public function connect($host, $port = null);
|
|
|
|
/**
|
|
* Login to a new session.
|
|
*
|
|
* @param string $user username
|
|
* @param string $password password
|
|
* @return bool success
|
|
* @throws AuthFailedException
|
|
*/
|
|
public function login($user, $password);
|
|
|
|
/**
|
|
* Authenticate your current session.
|
|
* @param string $user username
|
|
* @param string $token access token
|
|
*
|
|
* @return bool|mixed
|
|
* @throws AuthFailedException
|
|
*/
|
|
public function authenticate($user, $token);
|
|
|
|
/**
|
|
* Logout of the current server session
|
|
*
|
|
* @return bool success
|
|
*/
|
|
public function logout();
|
|
|
|
/**
|
|
* Check if the current session is connected
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function connected();
|
|
|
|
/**
|
|
* Get an array of available capabilities
|
|
*
|
|
* @return array list of capabilities
|
|
* @throws RuntimeException
|
|
*/
|
|
public function getCapabilities();
|
|
|
|
/**
|
|
* Change the current folder
|
|
*
|
|
* @param string $folder change to this folder
|
|
* @return bool|array see examineOrselect()
|
|
* @throws RuntimeException
|
|
*/
|
|
public function selectFolder($folder = 'INBOX');
|
|
|
|
/**
|
|
* Examine a given folder
|
|
*
|
|
* @param string $folder
|
|
* @return bool|array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function examineFolder($folder = 'INBOX');
|
|
|
|
/**
|
|
* Fetch message headers
|
|
* @param array|int $uids
|
|
* @param string $rfc
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function content($uids, $rfc = "RFC822", $uid = false);
|
|
|
|
/**
|
|
* Fetch message headers
|
|
* @param array|int $uids
|
|
* @param string $rfc
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function headers($uids, $rfc = "RFC822", $uid = false);
|
|
|
|
/**
|
|
* Fetch message flags
|
|
* @param array|int $uids
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function flags($uids, $uid = false);
|
|
|
|
/**
|
|
* Get uid for a given id
|
|
* @param int|null $id message number
|
|
*
|
|
* @return array|string message number for given message or all messages as array
|
|
* @throws MessageNotFoundException
|
|
*/
|
|
public function getUid($id = null);
|
|
|
|
/**
|
|
* Get a message number for a uid
|
|
* @param string $id uid
|
|
*
|
|
* @return int message number
|
|
* @throws MessageNotFoundException
|
|
*/
|
|
public function getMessageNumber($id);
|
|
|
|
/**
|
|
* Get a list of available folders
|
|
*
|
|
* @param string $reference mailbox reference for list
|
|
* @param string $folder mailbox / folder name match with wildcards
|
|
* @return array mailboxes that matched $folder as array(globalName => array('delim' => .., 'flags' => ..))
|
|
* @throws RuntimeException
|
|
*/
|
|
public function folders($reference = '', $folder = '*');
|
|
|
|
/**
|
|
* Set message flags
|
|
*
|
|
* @param array $flags flags to set, add or remove
|
|
* @param int $from message for items or start message if $to !== null
|
|
* @param int|null $to if null only one message ($from) is fetched, else it's the
|
|
* last message, INF means last message available
|
|
* @param string|null $mode '+' to add flags, '-' to remove flags, everything else sets the flags as given
|
|
* @param bool $silent if false the return values are the new flags for the wanted messages
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return bool|array new flags if $silent is false, else true or false depending on success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function store(array $flags, $from, $to = null, $mode = null, $silent = true, $uid = false);
|
|
|
|
/**
|
|
* Append a new message to given folder
|
|
*
|
|
* @param string $folder name of target folder
|
|
* @param string $message full message content
|
|
* @param array $flags flags for new message
|
|
* @param string $date date for new message
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function appendMessage($folder, $message, $flags = null, $date = null);
|
|
|
|
/**
|
|
* Copy message set from current folder to other folder
|
|
*
|
|
* @param string $folder destination folder
|
|
* @param $from
|
|
* @param int|null $to if null only one message ($from) is fetched, else it's the
|
|
* last message, INF means last message available
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function copyMessage($folder, $from, $to = null, $uid = false);
|
|
|
|
/**
|
|
* Copy multiple messages to the target folder
|
|
*
|
|
* @param array<string> $messages List of message identifiers
|
|
* @param string $folder Destination folder
|
|
* @param bool $uid Set to true if you pass message unique identifiers instead of numbers
|
|
* @return array|bool Tokens if operation successful, false if an error occurred
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
public function copyManyMessages($messages, $folder, $uid = false);
|
|
|
|
/**
|
|
* Move a message set from current folder to an other folder
|
|
* @param string $folder destination folder
|
|
* @param $from
|
|
* @param int|null $to if null only one message ($from) is fetched, else it's the
|
|
* last message, INF means last message available
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return bool success
|
|
*/
|
|
public function moveMessage($folder, $from, $to = null, $uid = false);
|
|
|
|
/**
|
|
* Move multiple messages to the target folder
|
|
*
|
|
* @param array<string> $messages List of message identifiers
|
|
* @param string $folder Destination folder
|
|
* @param bool $uid Set to true if you pass message unique identifiers instead of numbers
|
|
* @return array|bool Tokens if operation successful, false if an error occurred
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
public function moveManyMessages($messages, $folder, $uid = false);
|
|
|
|
/**
|
|
* Create a new folder
|
|
*
|
|
* @param string $folder folder name
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function createFolder($folder);
|
|
|
|
/**
|
|
* Rename an existing folder
|
|
*
|
|
* @param string $old old name
|
|
* @param string $new new name
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function renameFolder($old, $new);
|
|
|
|
/**
|
|
* Delete a folder
|
|
*
|
|
* @param string $folder folder name
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function deleteFolder($folder);
|
|
|
|
/**
|
|
* Subscribe to a folder
|
|
*
|
|
* @param string $folder folder name
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function subscribeFolder($folder);
|
|
|
|
/**
|
|
* Unsubscribe from a folder
|
|
* @param string $folder folder name
|
|
*
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function unsubscribeFolder($folder);
|
|
|
|
/**
|
|
* Send idle command
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
public function idle();
|
|
|
|
/**
|
|
* Send done command
|
|
* @throws RuntimeException
|
|
*/
|
|
public function done();
|
|
|
|
/**
|
|
* Apply session saved changes to the server
|
|
*
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function expunge();
|
|
|
|
/**
|
|
* Retrieve the quota level settings, and usage statics per mailbox
|
|
* @param $username
|
|
*
|
|
* @return array
|
|
* @throws RuntimeException
|
|
*/
|
|
public function getQuota($username);
|
|
|
|
/**
|
|
* Retrieve the quota settings per user
|
|
*
|
|
* @param string $quota_root
|
|
*
|
|
* @return array
|
|
* @throws ConnectionFailedException
|
|
*/
|
|
public function getQuotaRoot($quota_root = 'INBOX');
|
|
|
|
/**
|
|
* Send noop command
|
|
*
|
|
* @return bool success
|
|
* @throws RuntimeException
|
|
*/
|
|
public function noop();
|
|
|
|
/**
|
|
* Do a search request
|
|
*
|
|
* @param array $params
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return array message ids
|
|
* @throws RuntimeException
|
|
*/
|
|
public function search(array $params, $uid = false);
|
|
|
|
/**
|
|
* Get a message overview
|
|
* @param string $sequence uid sequence
|
|
* @param bool $uid set to true if passing a unique id
|
|
*
|
|
* @return array
|
|
* @throws RuntimeException
|
|
* @throws MessageNotFoundException
|
|
* @throws InvalidMessageDateException
|
|
*/
|
|
public function overview($sequence, $uid = false);
|
|
|
|
/**
|
|
* Enable the debug mode
|
|
*/
|
|
public function enableDebug();
|
|
|
|
/**
|
|
* Disable the debug mode
|
|
*/
|
|
public function disableDebug();
|
|
} |