123456789_123456789_123456789_123456789_123456789_

Class: Net::IMAP::SASLAdapter

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, SASL::ClientAdapter
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

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

Instance Attribute Summary

SASL::ClientAdapter - Inherited

#client, #command_proc,
#sasl_ir_capable?

Do the protocol and server both support an initial response?

Instance Method Summary

SASL::ProtocolAdapters::IMAP - Included

#service

SASL::ClientAdapter - Inherited

#auth_capable?

Does the server advertise support for the mechanism?
#authenticate

Delegates to AuthenticationExchange.authenticate.
#drop_connection

Drop the connection gracefully.
#drop_connection!

Drop the connection abruptly.
#response_errors

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

Runs the authenticate command with mechanism and initial_response.

SASL::ProtocolAdapters::Generic - Included

#cancel_response, #command_name, #decode, #encode, #encode_ir, #host, #port, #service

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



  

    #auth_capable?(mechanism)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



def auth_capable?(mechanism); client.auth_capable?(mechanism) end


  








  

    #drop_connection  
  

  [ GitHub ]


  

  


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



def drop_connection;          client.logout!                  end


  








  

    #drop_connection!  
  

  [ GitHub ]


  

  


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



def drop_connection!;         client.disconnect               end


  








  

    #response_errors  
  

  [ GitHub ]


  

  


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



def response_errors;          RESPONSE_ERRORS                 end