Imap client timeout can be modified and read #186

Author: Webklex

src/IMAP/Client.php

@@ -14,6 +14,7 @@
 
 use Webklex\IMAP\Exceptions\ConnectionFailedException;
 use Webklex\IMAP\Exceptions\GetMessagesFailedException;
+use Webklex\IMAP\Exceptions\InvalidImapTimeoutTypeException;
 use Webklex\IMAP\Exceptions\MessageSearchValidationException;
 use Webklex\IMAP\Support\FolderCollection;
 use Webklex\IMAP\Support\MessageCollection;
@@ -115,6 +116,18 @@ class Client {
      */
     protected $validConfigKeys = ['host', 'port', 'encryption', 'validate_cert', 'username', 'password','protocol'];
 
+    /**
+     * All available timeout types
+     *
+     * @var array $timeout_type
+     */
+    protected $timeout_type = [
+        'IMAP_OPENTIMEOUT' => 1,
+        'IMAP_READTIMEOUT' => 2,
+        'IMAP_WRITETIMEOUT' => 3,
+        'IMAP_CLOSETIMEOUT' => 4
+    ];
+
     /**
      * Client constructor.
      *
@@ -569,4 +582,43 @@ public function checkCurrentMailbox() {
         $this->checkConnection();
         return imap_check($this->connection);
     }
+
+    /**
+     * Set the imap timeout for a given operation type
+     * @param $type
+     * @param $timeout
+     *
+     * @return mixed
+     * @throws InvalidImapTimeoutTypeException
+     */
+    public function setTimeout($type, $timeout) {
+        if(is_numeric($type)) {
+            $type = (int) $type;
+        }elseif (isset($this->timeout_type[$type])){
+            $type = $this->timeout_type[$type];
+        }else{
+            throw new InvalidImapTimeoutTypeException("Invalid imap timeout type provided.");
+        }
+
+        return imap_timeout($type, $timeout);
+    }
+
+    /**
+     * Get the timeout for a certain operation
+     * @param $type
+     *
+     * @return mixed
+     * @throws InvalidImapTimeoutTypeException
+     */
+    public function getTimeout($type){
+        if(is_numeric($type)) {
+            $type = (int) $type;
+        }elseif (isset($this->timeout_type[$type])){
+            $type = $this->timeout_type[$type];
+        }else{
+            throw new InvalidImapTimeoutTypeException("Invalid imap timeout type provided.");
+        }
+
+        return imap_timeout($type);
+    }
 }

src/IMAP/Exceptions/InvalidImapTimeoutTypeException.php

@@ -0,0 +1,24 @@
+<?php
+/*
+* File:     InvalidImapTimeoutTypeException.php
+* Category: Exception
+* Author:   M. Goldenbaum
+* Created:  12.03.19 18:41
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\IMAP\Exceptions;
+
+use \Exception;
+
+/**
+ * Class InvalidImapTimeoutTypeException
+ *
+ * @package Webklex\IMAP\Exceptions
+ */
+class InvalidImapTimeoutTypeException extends Exception {
+
+}