dev/core#2264 - Remove never-used IMAP_XOAUTH2 option value before it gets more confusing

[demeritcowboy]

Overview

https://lab.civicrm.org/dev/core/-/issues/2264

Before we knew the full wackiness splendor of OAUTH2, there was an attempt to model it as its own protocol. This never worked so as the 5.23 release was going to press the as-yet-unreleased mail protocol option value was disabled, but left in the database.

Now that (inbound) OAUTH2 is working using a different mechanism, remove this option value before it starts causing confusion.

Before

Confusing.
Backwards compatibility code exists that is almost certainly not being used.

After

Better.
If it happens to be used somehow, there's a message upon upgrade asking person to report what they are doing.

Technical Details

OAUTH2

Comments

Also #18902 (comment)

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[seamuslee001]

@demeritcowboy won't this break the XOUATH2 integration? or am I confused by things here?

[demeritcowboy]

See it is confusing! No because IMAP_XOAUTH2 is never used. Whether to use oauth2 with imap comes from the settings stored in a different place, via $mailSettings['auth'] below.

I also tested this with the same setup I had used for testing oauth2 before. Still seems to work.

[seamuslee001]

This seems ok to me just noting that the oauth extension alters the mail settings here

civicrm-core/ext/oauth-client/CRM/OAuth/MailSetup.php

Line 165 in beaabeb

$mailSettings['auth'] = 'XOAuth2';

to ensure that the right connection type is used

[eileenmcnaughton]

@totten can you eyeball this one?

[mattwire]

@demeritcowboy Needs rebase

[totten]

This is a good idea. I did some r-run testing on the upgrader logic, and it worked well. I like how it uses an "OR" condition (i.e. warn if extant civicrm_mail_settings OR if the option-value is enabled).

Pushed up some tweaks to the message text.

Merge on pass.

[demeritcowboy]

Thanks!