Class: POP3 (Net)
Prev Chapter 4.  User Defined Modules and Classes  Next

Class: POP3 (Net)

Overview
Module Structure
Class Hierarchy
Constants
POP3::Revision
Class Methods
POP3.default_port
POP3.default_pop3_port
POP3.default_pop3s_port
POP3.socket_type
POP3.APOP / 1
POP3.foreach / 6
POP3.delete_all (1/2) / 6
POP3.auth_only (1/2) / 5
POP3.enable_ssl (1/2) / 1
POP3.create_ssl_params / 2
POP3.disable_ssl (1/2)
POP3.ssl_params
POP3.use_ssl? (1/2)
POP3.verify
POP3.certs
POP3.start (1/2) / 6
Instance Aliases
POP3#active?
POP3#each
Instance Attributes
POP3#address [R]
POP3#open_timeout [RW]
POP3#read_timeout [R]
Instance Methods
POP3#auth_only (2/E) / 2
POP3#initialize / 3
POP3#apop?
POP3#use_ssl? (2/E)
POP3#enable_ssl (2/E) / 3
POP3#disable_ssl (2/E)
POP3#inspect
POP3#set_debug_output / 1
POP3#port
POP3#read_timeout= / 1
POP3#started?
POP3#start (2/E) / 2
POP3#do_start / 2
POP3#on_connect
POP3#finish
POP3#do_finish
POP3#command
POP3#n_mails
POP3#n_bytes
POP3#mails
POP3#each_mail / 1
POP3#delete_all (2/E)
POP3#reset
POP3#set_all_uids / 1
POP3#logging / 1
is a submodule of
module: Net   
inherits from
  Protocol ( Net )
is inherited by
  APOP ( Net )
has properties
constant: Revision   
class method: default_port   
class method: default_pop3_port   
class method: default_pop3s_port   
class method: socket_type   
class method: APOP / 1   
class method: foreach / 6   
class method: delete_all (1/2) / 6   
class method: auth_only (1/2) / 5   
method: auth_only (2/E) / 2   
class method: enable_ssl (1/2) / 1   
class method: create_ssl_params / 2   
class method: disable_ssl (1/2)   
class method: ssl_params   
class method: use_ssl? (1/2)   
class method: verify   
class method: certs   
class method: start (1/2) / 6   
method: initialize / 3   
method: apop?   
method: use_ssl? (2/E)   
method: enable_ssl (2/E) / 3   
method: disable_ssl (2/E)   
method: inspect   
method: set_debug_output / 1   
attribute: address [R]   
method: port   
attribute: open_timeout [RW]   
attribute: read_timeout [R]   
method: read_timeout= / 1   
method: started?   
alias: active? ⇐ started?   
method: start (2/E) / 2   
method: do_start / 2   
method: on_connect   
method: finish   
method: do_finish   
method: command   
method: n_mails   
method: n_bytes   
method: mails   
method: each_mail / 1   
alias: each ⇐ each_mail   
method: delete_all (2/E)   
method: reset   
method: set_all_uids / 1   
method: logging / 1   
is defined at
#197 in net/pop.rb  

Overview

Module Structure
Class Hierarchy

Module Structure

  module: <Toplevel Module>
  module: Net
  class: Protocol     
✗ class: POP3     
  class: APOP     

Class Hierarchy

  Object ( Builtin-Module )
  Protocol ( Net )
has properties
class method: protocol_param / 2   
✗ POP3 ( Net )
has properties
constant: Revision   
class method: default_port   
class method: default_pop3_port   
class method: default_pop3s_port   
class method: socket_type   
class method: APOP / 1   
class method: foreach / 6   
class method: delete_all (1/2) / 6   
class method: auth_only (1/2) / 5   
method: auth_only (2/E) / 2   
class method: enable_ssl (1/2) / 1   
class method: create_ssl_params / 2   
class method: disable_ssl (1/2)   
class method: ssl_params   
class method: use_ssl? (1/2)   
class method: verify   
class method: certs   
class method: start (1/2) / 6   
method: initialize / 3   
method: apop?   
method: use_ssl? (2/E)   
method: enable_ssl (2/E) / 3   
method: disable_ssl (2/E)   
method: inspect   
method: set_debug_output / 1   
attribute: address [R]   
method: port   
attribute: open_timeout [RW]   
attribute: read_timeout [R]   
method: read_timeout= / 1   
method: started?   
alias: active? ⇐ started?   
method: start (2/E) / 2   
method: do_start / 2   
method: on_connect   
method: finish   
method: do_finish   
method: command   
method: n_mails   
method: n_bytes   
method: mails   
method: each_mail / 1   
alias: each ⇐ each_mail   
method: delete_all (2/E)   
method: reset   
method: set_all_uids / 1   
method: logging / 1   
    APOP     

Constants

POP3::Revision

POP3::Revision

#199 in net/pop.rb

Revision = %q$Revision: 29903 $.split[1]   

Class Methods

POP3.default_port
POP3.default_pop3_port
POP3.default_pop3s_port
POP3.socket_type
POP3.APOP / 1
POP3.foreach / 6
POP3.delete_all (1/2) / 6
POP3.auth_only (1/2) / 5
POP3.enable_ssl (1/2) / 1
POP3.create_ssl_params / 2
POP3.disable_ssl (1/2)
POP3.ssl_params
POP3.use_ssl? (1/2)
POP3.verify
POP3.certs
POP3.start (1/2) / 6

POP3.default_port

#205 in net/pop.rb

default_port

POP3.default_pop3_port

#210 in net/pop.rb

default_pop3_port

POP3.default_pop3s_port

#215 in net/pop.rb

default_pop3s_port

POP3.socket_type

#219 in net/pop.rb

socket_type

POP3.APOP / 1

#238 in net/pop.rb

APOP ( isapop )

POP3.foreach / 6

#262 in net/pop.rb

foreach ( address ,
  port = nil ,
  account = nil ,
  password = nil ,
  isapop = false ,
  &block )

POP3.delete_all (1/2) / 6

#283 in net/pop.rb

delete_all ( address ,
  port = nil ,
  account = nil ,
  password = nil ,
  isapop = false ,
  &block )

POP3.auth_only (1/2) / 5

#305 in net/pop.rb

auth_only ( address ,
  port = nil ,
  account = nil ,
  password = nil ,
  isapop = false )

POP3.enable_ssl (1/2) / 1

#332 in net/pop.rb

enable_ssl ( *args )

POP3.create_ssl_params / 2

#336 in net/pop.rb

create_ssl_params ( verify_or_params = {} ,
  certs = nil )

POP3.disable_ssl (1/2)

#354 in net/pop.rb

disable_ssl

POP3.ssl_params

#358 in net/pop.rb

ssl_params

POP3.use_ssl? (1/2)

#362 in net/pop.rb

use_ssl?

POP3.verify

#366 in net/pop.rb

verify

POP3.certs

#370 in net/pop.rb

certs

POP3.start (1/2) / 6

#394 in net/pop.rb

start ( address ,
  port = nil ,
  account = nil ,
  password = nil ,
  isapop = false ,
  &block )

Instance Aliases

POP3#active?
POP3#each

POP3#active?

#510 in net/pop.rb

active? ⇐ started?   

POP3#each

#648 in net/pop.rb

each ⇐ each_mail   

Instance Attributes

POP3#address [R]
POP3#open_timeout [RW]
POP3#read_timeout [R]

POP3#address [R]

#482 in net/pop.rb

POP3#open_timeout [RW]

#492 in net/pop.rb

POP3#read_timeout [R]

#497 in net/pop.rb

Instance Methods

POP3#auth_only (2/E) / 2
POP3#initialize / 3
POP3#apop?
POP3#use_ssl? (2/E)
POP3#enable_ssl (2/E) / 3
POP3#disable_ssl (2/E)
POP3#inspect
POP3#set_debug_output / 1
POP3#port
POP3#read_timeout= / 1
POP3#started?
POP3#start (2/E) / 2
POP3#do_start / 2
POP3#on_connect
POP3#finish
POP3#do_finish
POP3#command
POP3#n_mails
POP3#n_bytes
POP3#mails
POP3#each_mail / 1
POP3#delete_all (2/E)
POP3#reset
POP3#set_all_uids / 1
POP3#logging / 1

POP3#auth_only (2/E) / 2

#314 in net/pop.rb

auth_only ( account ,
  password )

POP3#initialize / 3

#410 in net/pop.rb

initialize ( addr ,
  port = nil ,
  isapop = false )

POP3#apop?

#429 in net/pop.rb

apop?

POP3#use_ssl? (2/E)

#434 in net/pop.rb

use_ssl?

POP3#enable_ssl (2/E) / 3

#445 in net/pop.rb

enable_ssl ( verify_or_params = {} ,
  certs = nil ,
  port = nil )

POP3#disable_ssl (2/E)

#455 in net/pop.rb

disable_ssl

POP3#inspect

#460 in net/pop.rb

inspect

POP3#set_debug_output / 1

#477 in net/pop.rb

set_debug_output ( arg )

POP3#port

#485 in net/pop.rb

port

POP3#read_timeout= / 1

#500 in net/pop.rb

read_timeout= ( sec )

POP3#started?

#506 in net/pop.rb

started?

POP3#start (2/E) / 2

#518 in net/pop.rb

start ( account ,
  password )

POP3#do_start / 2

#533 in net/pop.rb

do_start ( account ,
  password )

POP3#on_connect

#568 in net/pop.rb

on_connect

POP3#finish

#573 in net/pop.rb

finish

POP3#do_finish

#578 in net/pop.rb

do_finish

POP3#command

#591 in net/pop.rb

command

POP3#n_mails

#603 in net/pop.rb

n_mails

POP3#n_bytes

#610 in net/pop.rb

n_bytes

POP3#mails

#622 in net/pop.rb

mails

POP3#each_mail / 1

#644 in net/pop.rb

each_mail ( &block )

POP3#delete_all (2/E)

#666 in net/pop.rb

delete_all

POP3#reset

#676 in net/pop.rb

reset

POP3#set_all_uids / 1

#685 in net/pop.rb

set_all_uids ( called from POPMail#uidl )

POP3#logging / 1

#690 in net/pop.rb

logging ( msg )

Prev Up Next
Class: POPBadResponse (Net)  Home  Class: APOP (Net)