[Feature Request] Google OAuth Support

[freescout-helpdesk]

Is Google OAuth authentication supported in this library? google/gmail-oauth2-tools#18

[Sebbo94BY]

Very good point! Right now, it's not supported yet, unfortunately.

I've added a few functions in order to support OAuth, but I couldn't test it yet. It should later work like this:

// Create PhpImap\Mailbox instance for all further actions
$mailbox = new PhpImap\Mailbox(
	'{imap.gmail.com:993/imap/ssl}INBOX', // IMAP server and mailbox folder
	'some@gmail.com', // Username for the before configured mailbox
	'*********', // Password for the before configured username
	__DIR__, // Directory, where attachments will be saved (optional)
	'UTF-8' // Server encoding (optional)
);

try {
    $mailbox->setOAuthToken('TheOAuthAccessToken');
} catch (Exception $ex) {
    die('Authentication using OAuth failed! Error: '.$ex->getMessage());
}

try {
	$mailsIds = $mailbox->searchMailbox('ALL');
} catch(PhpImap\Exceptions\ConnectionException $ex) {
	die('IMAP connection failed: '.$ex);
}

if(!$mailsIds) {
	die('Mailbox is empty');
}

$mail = $mailbox->getMail($mailsIds[0]);

You can give it a try by using the develop branch: git checkout develop

I'll try to implement a working and tested solution, but this will earliest happen next year due to the current holidays. Any help would be appreciated.

---

Useful references:

• https://developers.google.com/gmail/imap/xoauth2-protocol
• https://github.com/google/gmail-oauth2-tools/blob/master/php/oauth2.php
• https://stackoverflow.com/questions/2455151/sending-imap-commands-using-php
• https://github.com/vmuthal/VivOAuthIMAP/blob/master/src/VivOAuthIMAP.php

[bapcltd-marv]

running automated testing for this would require changes mentioned in #432 (comment), or finding an IMAP-enabled mail provider that supports automated account creation w/ oauth imap so the account can be created & deleted on each travis build.

[hrst]

Please forgive me asking, but are there any updates on this? It would be so helpful to have OAuth support for e.g. GMail/Google Workspace, and Microsoft Office 365 mail accounts.

I'm willing to help / do the implementation, what is the current status?

[Sebbo94BY]

There are no updates yet.

I've tried to work and implement it some time ago, so the current progress is available in the respective branch: 411-OAuth-Support

Feel free to submit your own pull request or add commits to the existing one.

[francescobianco]

Hi! @freescout-helpdesk @Sebi94nbg @hrst @bapcltd-marv @rmontagud

The strategy to overcome the problem is replacing all the imap_* functions with the equivalent imap2_*

• imap_open(...) become imap2_open(...)
• imap_getmailboxes(...) become imap2_getmailboxes(...)

etc...

The idea behind the imap2 library is to replace the core php imap extension with a new one written in PHP.
Why? We have problem with the UW-IMAP https://github.com/uw-imap/imap it seem outdate from 2019. There are many security concerns about it

I'm waiting from your feedback! I hope that imap2 is a good replacement for imap

cc @millnet-maho

[hrst]

Just a heads-up to everyone: Microsoft will disable Basic Auth on Oct 1st, 2022. In contrast to Google, "App Passwords" will not be possible/allowed, only OAuth2.

Status for PHP imap_* extension (page not updated since 2020 as of writing this): https://wiki.php.net/todo/ext/imap/xoauth2

[bhanu2217]

When we plan to add support for oAuth to this package?