Revision control
Copy as Markdown
Other Tools
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#include "nsISupports.idl"
interface nsIMsgIncomingServer;
interface nsIMsgOutgoingServer;
/**
* A listener callback for OAuth2 SASL authentication. This would be represented
* as a promise, but this needs to be consumed by C++ code.
*/
[scriptable, uuid(9a088b49-bc13-4f99-9478-053a6a43e370)]
interface msgIOAuth2ModuleListener : nsISupports {
/**
* Called on successful OAuth2 authentication.
*/
void onSuccess(in ACString aBearerToken);
/// Called on failed OAuth2 authentication.
void onFailure(in nsresult aError);
};
/**
* An interface for managing the responsibilities of using OAuth2 to produce a
* bearer token, for use in SASL steps.
*/
[scriptable, uuid(68c275f8-cfa7-4622-b279-af290616cae6)]
interface msgIOAuth2Module : nsISupports {
/**
* Initialize the OAuth2 parameters from an outgoing server, and return
* whether or not we can authenticate with OAuth2.
*
* If the prefs for the server don't include an OAuth2 config, but one could
* be found among the known OAuth2 providers using the server's hostname,
* this config is used instead and stored in the server's prefs.
*/
boolean initFromOutgoing(in nsIMsgOutgoingServer aServer);
/**
* Initialize the OAuth2 parameters from an incoming server, and return
* whether or not we can authenticate with OAuth2.
*
* If the prefs for the server don't include an OAuth2 config, but one could
* be found among the known OAuth2 providers using the server's hostname,
* this config is used instead and stored in the server's prefs.
*/
boolean initFromMail(in nsIMsgIncomingServer aServer);
/**
* Initialize the OAuth2 parameters using the provided hostname and username,
* and return whether or not we can authenticate with OAuth2.
*/
boolean initFromHostname(in AUTF8String aHostname, in AUTF8String aUsername);
/**
* Connect to the OAuth2 server to get an access token encoded for use with
* SASL XOAUTH2.
*
* @param aWithUI If false, do not allow a dialog to be popped up to
* guide the user through the provider's login process.
* @param aCallback Listener that handles the async response.
*/
void connect(in boolean aWithUI, in msgIOAuth2ModuleListener aCallback);
/**
* Fetches a current OAuth2 access token, refreshing the session with the
* provider if needed.
*
* Note that unlike `connect()`, this method calls the listener with the raw
* token (for use in e.g. an HTTP request), without any additional formatting
* or encoding.
*
* @param listener - A listener for receiving the retrieved access token.
*/
void getAccessToken(in msgIOAuth2ModuleListener listener);
};
%{C++
#define MSGIOAUTH2MODULE_CONTRACTID "@mozilla.org/mail/oauth2-module;1"
%}