Ruby Net::POP3 Functions
EditRocket provides the following information on Net::POP3 functions in the Ruby source code builder.
active?() - "Alias for #started?"
apop?() - Does this instance use APOP authentication?
APOP( isapop ) - "Returns the APOP class if isapop is true; otherwise, returns the POP class. For example:"
auth_only( address, port = nil, account = nil, password = nil, isapop = false ) - Opens a POP3 session, attempts authentication, and quits.
auth_only( address, port = nil, account = nil, password = nil, isapop = false ) - Opens a POP3 session, attempts authentication, and quits.
default_port() - The default port for POP3 connections, port 110
delete_all( address, port = nil, account = nil, password = nil, isapop = false, &block ) - Starts a POP3 session and deletes all messages on the server. If a block is given, each POPMail object is yielded to it before being deleted.
delete_all( address, port = nil, account = nil, password = nil, isapop = false, &block ) - Starts a POP3 session and deletes all messages on the server. If a block is given, each POPMail object is yielded to it before being deleted.
each( ) - "Alias for #each_mail"
each_mail( ) - "Yields each message to the passed-in block in turn. Equivalent to:"
finish() - Finishes a POP3 session and closes TCP connection.
foreach( address, port = nil, account = nil, password = nil, isapop = false ) - "Starts a POP3 session and iterates over each POPMail object, yielding it to the block. This method is equivalent to:"
inspect() - Provide human-readable stringification of class state.
mails() - Returns an array of Net::POPMail objects, representing all the messages on the server. This array is renewed when the session restarts; otherwise, it is fetched from the server the first time this method is called (directly or indirectly) and cached.
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.
new( addr, port = nil, isapop = false ) - Creates a new POP3 object.
read_timeout=( sec ) - Set the read timeout.
reset() - Resets the session. This clears all "deleted" marks from messages.
set_debug_output( arg ) - "WARNING: This method causes a serious security hole. Use this method only for debugging."
start( address, port = nil, account = nil, password = nil, isapop = false ) - Creates a new POP3 object and open the connection. Equivalent to
start( address, port = nil, account = nil, password = nil, isapop = false ) - Creates a new POP3 object and open the connection. Equivalent to
started?() - true if the POP3 session has started.
