class Net::IMAP::SASL::OAuthBearerAuthenticator

# File lib/net/imap/sasl/oauthbearer_authenticator.rb, line 177
def initialize(arg1 = nil, arg2 = nil,
               oauth2_token: nil, secret: nil,
               **args, &blk)
  username, oauth2_token_arg = arg2.nil? ? [nil, arg1] : [arg1, arg2]
  super(username: username, **args, &blk)
  @oauth2_token = oauth2_token || secret || oauth2_token_arg or
    raise ArgumentError, "missing oauth2_token"
end

Creates an Authenticator for the “OAUTHBEARER” SASL mechanism.

Called by Net::IMAP#authenticate and similar methods on other clients.

Parameters¶ ↑

• oauth2_token — An OAuth2 bearer token

All other keyword parameters are passed to super (see OAuthAuthenticator). The most common ones are:

• optional authzid ― Authorization identity to act as or on behalf of.

  optional username — An alias for authzid.

  Note that, unlike some other authenticators, username sets the authorization identity and not the authentication identity. The authentication identity is established for the client by oauth2_token.

• optional host — Hostname to which the client connected.

• optional port — Service port to which the client connected.

Although only oauth2_token is required by this mechanism, it is worth noting that application protocols are allowed to require authzid (or other parameters, such as host or port) as are specific server implementations.

# File lib/net/imap/sasl/oauthbearer_authenticator.rb, line 193
def authorization; "Bearer #{oauth2_token}" end

Value of the HTTP Authorization header

# File lib/net/imap/sasl/oauthbearer_authenticator.rb, line 190
def initial_response?; true end

OAUTHBEARER sends an initial client response.