Module: Net::IMAP::SASL::ProtocolAdapters

Relationships & Source Files
Namespace Children
Modules: `Generic`, `IMAP`, `POP`, `SMTP`
Defined in:	lib/net/imap/sasl/protocol_adapters.rb

Overview

ProtocolAdapters modules are meant to be used as mixins for ClientAdapter and its subclasses. Where the client adapter must be customized for each client library, the protocol adapter mixin handles SASL requirements that are part of the protocol specification, but not specific to any particular client library. In particular, see RFC4422 §4

Interface

NOTE: This API is experimental, and may change.

#command_name – The name of the command used to to initiate an authentication exchange.
#service – The GSSAPI service name.
#encode_ir–Encodes an initial response.
#decode – Decodes a server challenge.
#encode – Encodes a client response.
#cancel_response – The encoded client response used to cancel an authentication exchange.

Other protocol requirements of the SASL authentication exchange are handled by ClientAdapter.

Included protocol adapters

Generic – a basic implementation of all of the methods listed above.
IMAP – An adapter for the IMAP4 protocol.
SMTP – An adapter for the SMTP protocol with the AUTH capability.
POP – An adapter for the POP3 protocol with the ::Net::IMAP::SASL capability.