Fix hook name clash: new smtp_auth hook added recently (a few months ago) has been...

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@14141 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/class/deliver/Deliver_SMTP.class.php b/class/deliver/Deliver_SMTP.class.php
index ac3db6a7b687acde28f5c5795a0670f19a199f74..b37781cff39fc5ae9efd00e4594c6551c792637b 100644 (file)
--- a/class/deliver/Deliver_SMTP.class.php
+++ b/class/deliver/Deliver_SMTP.class.php
@@ -212,6 +212,12 @@ class Deliver_SMTP extends Deliver {
         // FIXME: check ehlo response before using authentication
 
         // Try authentication by a plugin
+        //
+        // NOTE: there is another hook in functions/auth.php called "smtp_auth" 
+        // that allows a plugin to specify a different set of login credentials 
+        // (so is slightly mis-named, but is too old to change), so be careful 
+        // that you do not confuse your hook names.
+        //
         $smtp_auth_args = array(
             'auth_mech' => $smtp_auth_mech,
             'user' => $user,
@@ -220,7 +226,7 @@ class Deliver_SMTP extends Deliver {
             'port' => $port,
             'stream' => $stream,
         );
-        if (boolean_hook_function('smtp_auth', $smtp_auth_args, 1)) {
+        if (boolean_hook_function('smtp_authenticate', $smtp_auth_args, 1)) {
             // authentication succeeded
         } else if (( $smtp_auth_mech == 'cram-md5') or ( $smtp_auth_mech == 'digest-md5' )) {
             // Doing some form of non-plain auth

diff --git a/doc/ChangeLog b/doc/ChangeLog
index e6c1113180751f7dba3153c406f9974088b77b3d..d1c84d6c51f38e855d2c63e460452ad27586552a 100644 (file)
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -356,7 +356,7 @@ Version 1.5.2 - SVN
   - Forced addition of a file suffix to attachments that lack a filename
     (helps forwarded messages avoid spam filters) (Thanks to Petr
     Kletecka) (#3139004).
-  - Added smtp_auth hook (Thanks to Emmanuel Dreyfus).
+  - Added smtp_authenticate hook (Thanks to Emmanuel Dreyfus).
   - Allow administrators to configure subfolders of user INBOXes to be
     treated as special folders by adding $subfolders_of_inbox_are_special
     to config_local.php.

diff --git a/functions/auth.php b/functions/auth.php
index 732dbeb7c4256cab7f124bd1c157cb3af0a039f9..befbf03f06b978b8d6671c8b44028d96cef0db32 100644 (file)
--- a/functions/auth.php
+++ b/functions/auth.php
@@ -363,6 +363,12 @@ function get_smtp_user(&$user, &$pass) {
     // directly changing the arguments array contents 
     // in your plugin e.g., $args[0] = 'new_username';
     //
+    // NOTE: there is another hook in class/deliver/Deliver_SMTP.class.php
+    // called "smtp_authenticate" that allows a plugin to run its own
+    // custom authentication routine - this hook here is thus slightly
+    // mis-named but is too old to change.  Be careful that you do not
+    // confuse your hook names.
+    //
     $temp = array(&$user, &$pass);
     do_hook('smtp_auth', $temp);
 }