PHP-imap replacement (#198)

Author: tchapi

.env

@@ -48,9 +48,10 @@ AUTH_REALM=SabreDAV
 # "Basic", "IMAP", or "LDAP"
 AUTH_METHOD=Basic
 
-# In case of IMAP Auth, you must specify the url of the mailbox in the following format {host[:port][/flag1/flag2...]}.
-# See https://www.php.net/manual/en/function.imap-open.php for more details
+# In case of IMAP Auth, you must specify the url of the mailbox in the following format host[:port].
 IMAP_AUTH_URL=null
+IMAP_ENCRYPTION_METHOD=ssl
+IMAP_CERTIFICATE_VALIDATION=true
 IMAP_AUTH_USER_AUTOCREATE=false
 
 # In case of LDAP Auth, you must specify the url of the LDAP server

.github/workflows/ci.yml

@@ -27,11 +27,12 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Install GD PHP extension
+            - name: Install GD / ZIP PHP extension
               run: |
-                apk add $PHPIZE_DEPS libpng-dev
+                apk add $PHPIZE_DEPS libpng-dev libzip-dev
                 docker-php-ext-configure gd
-                docker-php-ext-install gd
+                docker-php-ext-configure zip
+                docker-php-ext-install gd zip
             - name: Install Composer
               run: wget -qO - https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer --quiet
             - name: Validate Composer
@@ -70,16 +71,18 @@ jobs:
                 php:
                     - '8.2'
                     - '8.3'
+                    - '8.4'
             fail-fast: false
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Install MySQL / GD PHP extensions
+            - name: Install MySQL / GD / ZIP PHP extensions
               run: |
-                apk add $PHPIZE_DEPS icu-libs icu-dev libpng-dev
+                apk add $PHPIZE_DEPS icu-libs icu-dev libpng-dev libzip-dev
                 docker-php-ext-configure intl
                 docker-php-ext-configure gd
-                docker-php-ext-install pdo pdo_mysql intl gd
+                docker-php-ext-configure zip
+                docker-php-ext-install pdo pdo_mysql intl gd zip
             - name: Install Composer
               run: wget -qO - https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer --quiet
             - name: Install dependencies with Composer

README.md

@@ -248,16 +248,18 @@ Or use it directly in the Apache configuration
 
 ### Specific environment variables for IMAP and LDAP authentication methods
 
-In case you use the `IMAP` auth type, you must specify the auth url (_the "mailbox" url_) in `IMAP_AUTH_URL`. See https://www.php.net/manual/en/function.imap-open.php for more details.
+In case you use the `IMAP` auth type, you must specify the auth url (_the "mailbox" url_) in `IMAP_AUTH_URL` as `host:port`, the encryption method (SSL, TLS or None) and whether the certificate should be validated.
 
-You should also explicitely define whether you want new authenticated to be created upon login:
+You should also explicitely define whether you want new authenticated users to be created upon login:
 
 ```shell
-IMAP_AUTH_URL={imap.gmail.com:993/imap/ssl/novalidate-cert}
+IMAP_AUTH_URL=imap.mydomain.com:993
+IMAP_ENCRYPTION_METHOD=ssl # ssl, tls or false
+IMAP_CERTIFICATE_VALIDATION=true
 IMAP_AUTH_USER_AUTOCREATE=true # false by default
 ```
 
-Same goes for LDAP, where you must specify the LDAP server url, the DN pattern, the Mail attribute, as well as whether you want new authenticated to be created upon login (_like for IMAP_):
+Same goes for LDAP, where you must specify the LDAP server url, the DN pattern, the Mail attribute, as well as whether you want new authenticated users to be created upon login (_like for IMAP_):
 
 ```shell
 LDAP_AUTH_URL=ldap://127.0.0.1:3890 # default LDAP port

composer.json

@@ -8,6 +8,7 @@
         "ext-ctype": "*",
         "ext-gd": "*",
         "ext-iconv": "*",
+        "ext-zip": "*",
         "composer-runtime-api": "^2",
         "dantsu/php-osm-static-api": "^0.6.4",
         "doctrine/doctrine-bundle": "^2.15.1",
@@ -37,7 +38,8 @@
         "symfony/twig-bundle": "^7.3",
         "symfony/validator": "^7.3",
         "symfony/web-link": "^7.3",
-        "symfony/yaml": "^7.3"
+        "symfony/yaml": "^7.3",
+        "webklex/php-imap": "^6.2"
     },
     "require-dev": {
         "doctrine/doctrine-fixtures-bundle": "^3.5",