123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::SASLAdapter

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, SASL::ClientAdapter, Forwardable
Instance Chain:
self, SASL::ProtocolAdapters::IMAP, SASL::ClientAdapter, SASL::ProtocolAdapters::Generic
Inherits: Net::IMAP::SASL::ClientAdapter
Defined in: lib/net/imap/sasl_adapter.rb

Overview

Experimental

Constant Summary

Class Method Summary

SASL::ClientAdapter - Inherited

.new

By default, this simply sets the #client and #command_proc attributes.

Instance Attribute Summary

SASL::ClientAdapter - Inherited

#client

The client that handles communication with the protocol server.
#command_proc

command_proc can used to avoid exposing private methods on #client.

Instance Method Summary

SASL::ProtocolAdapters::IMAP - Included

#service

SASL::ClientAdapter - Inherited

#authenticate

Attempt to authenticate #client to the server.
#response_errors

Returns an array of server responses errors raised by run_command.
#run_command

Calls command_proc with command_name (see SASL::ProtocolAdapters::Generic#command_name), mechanism, initial_response, and a continuations_handler block.

SASL::ProtocolAdapters::Generic - Included

#cancel_response

Returns the message used by the client to abort an authentication exchange.
#command_name

The name of the protocol command used to initiate a SASL authentication exchange.
#decode

Decodes a server challenge string.
#encode

Encodes a client response string.
#encode_ir

Encodes an initial response string.
#service

A service name from the GSSAPI/Kerberos/SASL Service Names registry.

Constructor Details

This class inherits a constructor from Net::IMAP::SASL::ClientAdapter

Instance Attribute Details

#sasl_ir_capable? ⇒ Boolean (readonly)

[ GitHub ] 

  


# File 'lib/net/imap/sasl_adapter.rb', line 14



def sasl_ir_capable?;         client.capable?("SASL-IR")      end


  







Instance Method Details



  

    #drop_connection  
  

  [ GitHub ]


  

  


# File 'lib/net/imap/sasl_adapter.rb', line 15



def drop_connection;          client.logout!                  end


  








  

    #drop_connection!  
  

  [ GitHub ]


  

  


# File 'lib/net/imap/sasl_adapter.rb', line 16



def drop_connection!;         client.disconnect               end


  








  

    #response_errors  
  

  [ GitHub ]


  

  


# File 'lib/net/imap/sasl_adapter.rb', line 13



def response_errors;          RESPONSE_ERRORS                 end