Explain expected format token in OAuth* methods

pear · Feb 5, 2024 · c341a06 · c341a06
2 parents ae5786b + 8816c26
commit c341a06
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/Sieve.php b/Sieve.php
@@ -934,7 +934,8 @@ function _authEXTERNAL($user, $pass, $euser)
      * Authenticates the user using the XOAUTH2 method.
      *
      * @param string $user  The userid to authenticate as.
-     * @param string $token The token to authenticate with.
+     * @param string $token The access token prefixed by it's type
+     *                      example: "Bearer $access_token".
      * @param string $euser The effective uid to authenticate as.
      *
      * @return void
@@ -954,7 +955,8 @@ function _authXOAUTH2($user, $token, $euser)
      * Authenticates the user using the OAUTHBEARER method.
      *
      * @param string $user  The userid to authenticate as.
-     * @param string $token The token to authenticate with.
+     * @param string $token The access token prefixed by it's type
+     *                      example: "Bearer $access_token".
      * @param string $euser The effective uid to authenticate as.
      *
      * @return void