| Current File : //proc/thread-self/root/opt/alt/ruby18/share/ri/1.8/system/Net/IMAP/authenticate-i.yaml |
--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: "Sends an AUTHENTICATE command to authenticate the client. The <tt>auth_type</tt> parameter is a string that represents the authentication mechanism to be used. Currently Net::IMAP supports authentication mechanisms:"
- !ruby/struct:SM::Flow::VERB
body: " LOGIN:: login using cleartext user and password.\n CRAM-MD5:: login with cleartext user and encrypted password\n (see [RFC-2195] for a full description). This\n mechanism requires that the server have the user's\n password stored in clear-text password.\n"
- !ruby/struct:SM::Flow::P
body: "For both these mechanisms, there should be two <tt>args</tt>: username and (cleartext) password. A server may not support one or other of these mechanisms; check #capability() for a capability of the form "AUTH=LOGIN" or "AUTH=CRAM-MD5"."
- !ruby/struct:SM::Flow::P
body: "Authentication is done using the appropriate authenticator object: see @@authenticators for more information on plugging in your own authenticator."
- !ruby/struct:SM::Flow::P
body: "For example:"
- !ruby/struct:SM::Flow::VERB
body: " imap.authenticate('LOGIN', user, password)\n"
- !ruby/struct:SM::Flow::P
body: A Net::IMAP::NoResponseError is raised if authentication fails.
full_name: Net::IMAP#authenticate
is_singleton: false
name: authenticate
params: (auth_type, *args)
visibility: public