In Files
- net-imap-0.2.2/lib/net/imap/authenticators.rb
Methods
Class/Module Index
![[+]](../../images/find.png "show/hide quicksearch")
- Net
- Net::IMAP
- Net::IMAP::Address
- Net::IMAP::Authenticators
- Net::IMAP::BadResponseError
- Net::IMAP::BodyTypeAttachment
- Net::IMAP::BodyTypeBasic
- Net::IMAP::BodyTypeExtension
- Net::IMAP::BodyTypeMessage
- Net::IMAP::BodyTypeMultipart
- Net::IMAP::BodyTypeText
- Net::IMAP::ByeResponseError
- Net::IMAP::ContentDisposition
- Net::IMAP::ContinuationRequest
- Net::IMAP::CramMD5Authenticator
- Net::IMAP::DataFormatError
- Net::IMAP::DigestMD5Authenticator
- Net::IMAP::Envelope
- Net::IMAP::Error
- Net::IMAP::FetchData
- Net::IMAP::FlagCountError
- Net::IMAP::IgnoredResponse
- Net::IMAP::LoginAuthenticator
- Net::IMAP::MailboxACLItem
- Net::IMAP::MailboxList
- Net::IMAP::MailboxQuota
- Net::IMAP::MailboxQuotaRoot
- Net::IMAP::Namespace
- Net::IMAP::Namespaces
- Net::IMAP::NoResponseError
- Net::IMAP::NumValidator
- Net::IMAP::PlainAuthenticator
- Net::IMAP::ResponseCode
- Net::IMAP::ResponseError
- Net::IMAP::ResponseParseError
- Net::IMAP::ResponseText
- Net::IMAP::StatusData
- Net::IMAP::StringFormatter
- Net::IMAP::TaggedResponse
- Net::IMAP::ThreadMember
- Net::IMAP::UnknownResponseError
- Net::IMAP::UntaggedResponse
Net::IMAP::Authenticators
Registry for SASL authenticators used by Net::IMAP.
Public Instance Methods
add_authenticator(auth_type, authenticator)
click to toggle source
Adds an authenticator for use with Net::IMAP#authenticate. auth_type is the SASL mechanism supported by authenticator (for instance, “PLAIN”). The authenticator is an object which defines a #process method to handle authentication with the server. See Net::IMAP::PlainAuthenticator, Net::IMAP::LoginAuthenticator, Net::IMAP::CramMD5Authenticator, and Net::IMAP::DigestMD5Authenticator for examples.
If auth_type refers to an existing authenticator, it will be replaced by the new one.
# File net-imap-0.2.2/lib/net/imap/authenticators.rb, line 16
def add_authenticator(auth_type, authenticator)
authenticators[auth_type] = authenticator
end
authenticator(auth_type, *args)
click to toggle source
Builds an authenticator for Net::IMAP#authenticate. args will be passed directly to the chosen authenticator's #initialize.
# File net-imap-0.2.2/lib/net/imap/authenticators.rb, line 22
def authenticator(auth_type, *args)
auth_type = auth_type.upcase
unless authenticators.has_key?(auth_type)
raise ArgumentError,
format('unknown auth type - "%s"', auth_type)
end
authenticators[auth_type].new(*args)
end