Class: Net::APOP

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `POP3`, Protocol
Instance Chain: self, `POP3`, Protocol
Inherits:	Net::POP3 Object Protocol Net::POP3 Net::APOP
Defined in:	lib/net/pop.rb

Overview

This class is equivalent to POP3, except that it uses APOP authentication.

returns true if POP3.ssl_params is set.

.APOP	Returns the `APOP` class if `isapop` is true; otherwise, returns the POP class.
.auth_only	Opens a `POP3` session, attempts authentication, and quits.
.certs	returns the `:ca_file` or `:ca_path` from POP3.ssl_params
.create_ssl_params	Constructs proper parameters from arguments.
.default_pop3_port	The default port for `POP3` connections, port 110.
.default_pop3s_port	The default port for POP3S connections, port 995.
.default_port	returns the port for `POP3`.
.delete_all	Starts a `POP3` session and deletes all messages on the server.
.disable_ssl	Disable SSL for all new instances.
.enable_ssl	Enable SSL for all new instances.
.foreach	Starts a `POP3` session and iterates over each `POPMail` object, yielding it to the `block`.
.new	Creates a new `POP3` object.
.ssl_params	returns the SSL Parameters.
.start	Creates a new `POP3` object and open the connection.
.verify	returns whether verify_mode is enable from POP3.ssl_params
.socket_type	obsolete.

#address	The address to connect to.
#apop?	Does this instance use `APOP` authentication?
#open_timeout	Seconds to wait until a connection is opened.
#read_timeout	Seconds to wait until reading one block (by one read(1) call).
#read_timeout=	Set the read timeout.
#started?	`true` if the `POP3` session has started.
#use_ssl?	does this instance use SSL?
#active?	Alias for POP3#started?.

#auth_only	Starts a pop3 session, attempts authentication, and quits.
#delete_all	Deletes all messages on the server.
#disable_ssl	Disable SSL for all new instances.
#each	Alias for POP3#each_mail.
#each_mail	Yields each message to the passed-in block in turn.
#enable_ssl	Enables SSL for this instance.
#finish	Finishes a `POP3` session and closes TCP connection.
#inspect	Provide human-readable stringification of class state.
#logging	debugging output for `msg`
#mails	Returns an array of `POPMail` objects, representing all the messages on the server.
#n_bytes	Returns the total size in bytes of all the messages on the POP server.
#n_mails	Returns the number of messages on the POP server.
#port	The port number to connect to.
#reset	Resets the session.
#set_debug_output	WARNING: This method causes a serious security hole.
#start	Starts a `POP3` session.
#set_all_uids	internal use only (called from POPMail#uidl).
#command	Returns the current command.
#do_finish	nil’s out the: - mails - number counter for mails - number counter for bytes - quits the current command, if any.
#do_start	internal method for POP3.start
#on_connect	Does nothing.

This class inherits a constructor from Net::POP3

Always returns true.

[ GitHub ]

# File 'lib/net/pop.rb', line 731


def apop?
  true
end