Class: SMTP (Net)

Overview
Module Structure
Class Hierarchy
Constants
SMTP::Revision
SMTP::DEFAULT_AUTH_TYPE
SMTP::IMASK
SMTP::OMASK
SMTP::CRAM_BUFSIZE
Class Aliases
SMTP.default_ssl_port
Class Methods
SMTP.default_port
SMTP.default_submission_port
SMTP.default_tls_port
SMTP.default_ssl_context
SMTP.start (1/2) / 7
Instance Aliases
SMTP#esmtp
SMTP#ssl?
SMTP#enable_ssl
SMTP#disable_ssl
SMTP#set_debug_output
SMTP#send_mail
SMTP#sendmail
SMTP#ready
Instance Attributes
SMTP#address [R]
SMTP#port [R]
SMTP#open_timeout [RW]
SMTP#read_timeout [R]
Instance Methods
SMTP#initialize / 2
SMTP#inspect
SMTP#esmtp?
SMTP#esmtp= / 1
SMTP#capable_starttls?
SMTP#capable? / 1
SMTP#capable_plain_auth?
SMTP#capable_login_auth?
SMTP#capable_cram_md5_auth?
SMTP#auth_capable? / 1
SMTP#capable_auth_types
SMTP#tls?
SMTP#enable_tls / 1
SMTP#disable_tls
SMTP#starttls?
SMTP#starttls_always?
SMTP#starttls_auto?
SMTP#enable_starttls / 1
SMTP#enable_starttls_auto / 1
SMTP#disable_starttls
SMTP#read_timeout= / 1
SMTP#debug_output= / 1
SMTP#started?
SMTP#start (2/E) / 4
SMTP#finish
SMTP#do_start / 4
SMTP#tlsconnect / 1
SMTP#new_internet_message_io / 1
SMTP#do_helo / 1
SMTP#do_finish
SMTP#send_message / 3
SMTP#open_message_stream / 3
SMTP#authenticate / 3
SMTP#auth_plain / 2
SMTP#auth_login / 2
SMTP#auth_cram_md5 / 2
SMTP#check_auth_method / 1
SMTP#auth_method / 1
SMTP#check_auth_args / 2
SMTP#base64_encode / 1
SMTP#cram_md5_response / 2
SMTP#cram_secret / 2
SMTP#starttls
SMTP#helo / 1
SMTP#ehlo / 1
SMTP#mailfrom / 1
SMTP#rcptto_list / 1
SMTP#rcptto / 1
SMTP#data / 2
SMTP#quit
SMTP#getok / 1
SMTP#get_response / 1
SMTP#recv_response
SMTP#critical / 1
SMTP#check_response / 1
SMTP#check_continue / 1
SMTP#check_auth_response / 1
SMTP#check_auth_continue / 1
SMTP#logging / 1
is a submodule of
module: Net   
is modularized into
class: Response   
inherits from
  Object ( Builtin-Module )
has properties
constant: Revision   
class method: default_port   
class method: default_submission_port   
class method: default_tls_port   
class alias: default_ssl_port default_tls_port   
class method: default_ssl_context   
method: initialize / 2   
method: inspect   
method: esmtp?   
method: esmtp= / 1   
alias: esmtp esmtp?   
method: capable_starttls?   
method: capable? / 1   
method: capable_plain_auth?   
method: capable_login_auth?   
method: capable_cram_md5_auth?   
method: auth_capable? / 1   
method: capable_auth_types   
method: tls?   
alias: ssl? tls?   
method: enable_tls / 1   
alias: enable_ssl enable_tls   
method: disable_tls   
alias: disable_ssl disable_tls   
method: starttls?   
method: starttls_always?   
method: starttls_auto?   
method: enable_starttls / 1   
method: enable_starttls_auto / 1   
method: disable_starttls   
attribute: address [R]   
attribute: port [R]   
attribute: open_timeout [RW]   
attribute: read_timeout [R]   
method: read_timeout= / 1   
method: debug_output= / 1   
alias: set_debug_output debug_output   
class method: start (1/2) / 7   
method: started?   
method: start (2/E) / 4   
method: finish   
method: do_start / 4   
method: tlsconnect / 1   
method: new_internet_message_io / 1   
method: do_helo / 1   
method: do_finish   
method: send_message / 3   
alias: send_mail send_message   
alias: sendmail send_message   
method: open_message_stream / 3   
alias: ready open_message_stream   
constant: DEFAULT_AUTH_TYPE   
method: authenticate / 3   
method: auth_plain / 2   
method: auth_login / 2   
method: auth_cram_md5 / 2   
method: check_auth_method / 1   
method: auth_method / 1   
method: check_auth_args / 2   
method: base64_encode / 1   
constant: IMASK   
constant: OMASK   
method: cram_md5_response / 2   
constant: CRAM_BUFSIZE   
method: cram_secret / 2   
method: starttls   
method: helo / 1   
method: ehlo / 1   
method: mailfrom / 1   
method: rcptto_list / 1   
method: rcptto / 1   
method: data / 2   
method: quit   
method: getok / 1   
method: get_response / 1   
method: recv_response   
method: critical / 1   
method: check_response / 1   
method: check_continue / 1   
method: check_auth_response / 1   
method: check_auth_continue / 1   
method: logging / 1   
is defined at
#173 in net/smtp.rb  

Overview

Module Structure

  module: <Toplevel Module>
  module: <Built-in Module>
  module: Net
✗ class: SMTP
class: Response     

Class Hierarchy

Object ( Builtin-Module )
SMTP ( Net )
has properties
constant: Revision   
class method: default_port   
class method: default_submission_port   
class method: default_tls_port   
class alias: default_ssl_port default_tls_port   
class method: default_ssl_context   
method: initialize / 2   
method: inspect   
method: esmtp?   
method: esmtp= / 1   
alias: esmtp esmtp?   
method: capable_starttls?   
method: capable? / 1   
method: capable_plain_auth?   
method: capable_login_auth?   
method: capable_cram_md5_auth?   
method: auth_capable? / 1   
method: capable_auth_types   
method: tls?   
alias: ssl? tls?   
method: enable_tls / 1   
alias: enable_ssl enable_tls   
method: disable_tls   
alias: disable_ssl disable_tls   
method: starttls?   
method: starttls_always?   
method: starttls_auto?   
method: enable_starttls / 1   
method: enable_starttls_auto / 1   
method: disable_starttls   
attribute: address [R]   
attribute: port [R]   
attribute: open_timeout [RW]   
attribute: read_timeout [R]   
method: read_timeout= / 1   
method: debug_output= / 1   
alias: set_debug_output debug_output   
class method: start (1/2) / 7   
method: started?   
method: start (2/E) / 4   
method: finish   
method: do_start / 4   
method: tlsconnect / 1   
method: new_internet_message_io / 1   
method: do_helo / 1   
method: do_finish   
method: send_message / 3   
alias: send_mail send_message   
alias: sendmail send_message   
method: open_message_stream / 3   
alias: ready open_message_stream   
constant: DEFAULT_AUTH_TYPE   
method: authenticate / 3   
method: auth_plain / 2   
method: auth_login / 2   
method: auth_cram_md5 / 2   
method: check_auth_method / 1   
method: auth_method / 1   
method: check_auth_args / 2   
method: base64_encode / 1   
constant: IMASK   
constant: OMASK   
method: cram_md5_response / 2   
constant: CRAM_BUFSIZE   
method: cram_secret / 2   
method: starttls   
method: helo / 1   
method: ehlo / 1   
method: mailfrom / 1   
method: rcptto_list / 1   
method: rcptto / 1   
method: data / 2   
method: quit   
method: getok / 1   
method: get_response / 1   
method: recv_response   
method: critical / 1   
method: check_response / 1   
method: check_continue / 1   
method: check_auth_response / 1   
method: check_auth_continue / 1   
method: logging / 1   
Response ( Net::SMTP )

Constants

SMTP::Revision

#175 in net/smtp.rb

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

SMTP::DEFAULT_AUTH_TYPE

#718 in net/smtp.rb

DEFAULT_AUTH_TYPE = :plain   

SMTP::IMASK

#784 in net/smtp.rb

IMASK = 0x36   

SMTP::OMASK

#785 in net/smtp.rb

OMASK = 0x5c   

SMTP::CRAM_BUFSIZE

#793 in net/smtp.rb

CRAM_BUFSIZE = 64   

Class Aliases

SMTP.default_ssl_port

#193 in net/smtp.rb

default_ssl_port default_tls_port   

Class Methods

SMTP.default_port

#178 in net/smtp.rb

default_port

SMTP.default_submission_port

#183 in net/smtp.rb

default_submission_port

SMTP.default_tls_port

#188 in net/smtp.rb

default_tls_port

SMTP.default_ssl_context

#196 in net/smtp.rb

default_ssl_context

SMTP.start (1/2) / 7

#460 in net/smtp.rb

start ( address ,
  port = nil ,
  helo = 'localhost.localdomain' ,
  user = nil ,
  secret = nil ,
  authtype = nil ,
  &block )

Instance Aliases

SMTP#esmtp

#248 in net/smtp.rb

esmtp esmtp?   

SMTP#ssl?

#300 in net/smtp.rb

ssl? tls?   

SMTP#enable_ssl

#312 in net/smtp.rb

enable_ssl enable_tls   

SMTP#disable_ssl

#321 in net/smtp.rb

disable_ssl disable_tls   

SMTP#set_debug_output

#406 in net/smtp.rb

set_debug_output debug_output   

SMTP#send_mail

#657 in net/smtp.rb

send_mail send_message   

SMTP#sendmail

#658 in net/smtp.rb

sendmail send_message   

SMTP#ready

#710 in net/smtp.rb

ready open_message_stream   

Instance Attributes

SMTP#address [R]

#366 in net/smtp.rb

SMTP#port [R]

#369 in net/smtp.rb

SMTP#open_timeout [RW]

#374 in net/smtp.rb

SMTP#read_timeout [R]

#379 in net/smtp.rb

Instance Methods

SMTP#initialize / 2

#211 in net/smtp.rb

initialize ( address ,
  port = nil )

SMTP#inspect

#228 in net/smtp.rb

inspect

SMTP#esmtp?

#233 in net/smtp.rb

esmtp?

SMTP#esmtp= / 1

#244 in net/smtp.rb

esmtp= ( bool )

SMTP#capable_starttls?

#252 in net/smtp.rb

capable_starttls?

SMTP#capable? / 1

#256 in net/smtp.rb

capable? ( key )

SMTP#capable_plain_auth?

#264 in net/smtp.rb

capable_plain_auth?

SMTP#capable_login_auth?

#270 in net/smtp.rb

capable_login_auth?

SMTP#capable_cram_md5_auth?

#276 in net/smtp.rb

capable_cram_md5_auth?

SMTP#auth_capable? / 1

#280 in net/smtp.rb

auth_capable? ( type )

SMTP#capable_auth_types

#289 in net/smtp.rb

capable_auth_types

SMTP#tls?

#296 in net/smtp.rb

tls?

SMTP#enable_tls / 1

#305 in net/smtp.rb

enable_tls ( context = SMTP.default_ssl_context )

SMTP#disable_tls

#316 in net/smtp.rb

disable_tls

SMTP#starttls?

#326 in net/smtp.rb

starttls?

SMTP#starttls_always?

#331 in net/smtp.rb

starttls_always?

SMTP#starttls_auto?

#336 in net/smtp.rb

starttls_auto?

SMTP#enable_starttls / 1

#342 in net/smtp.rb

enable_starttls ( context = SMTP.default_ssl_context )

SMTP#enable_starttls_auto / 1

#351 in net/smtp.rb

enable_starttls_auto ( context = SMTP.default_ssl_context )

SMTP#disable_starttls

#360 in net/smtp.rb

disable_starttls

SMTP#read_timeout= / 1

#383 in net/smtp.rb

read_timeout= ( sec )

SMTP#debug_output= / 1

#402 in net/smtp.rb

debug_output= ( arg )

SMTP#started?

#467 in net/smtp.rb

started?

SMTP#start (2/E) / 4

#521 in net/smtp.rb

start ( helo = 'localhost.localdomain' ,
  user = nil ,
  secret = nil ,
  authtype = nil )

SMTP#finish

#538 in net/smtp.rb

finish

SMTP#do_start / 4

#545 in net/smtp.rb

do_start ( helo_domain ,
  user ,
  secret ,
  authtype )

SMTP#tlsconnect / 1

#576 in net/smtp.rb

tlsconnect ( s )

SMTP#new_internet_message_io / 1

#587 in net/smtp.rb

new_internet_message_io ( s )

SMTP#do_helo / 1

#594 in net/smtp.rb

do_helo ( helo_domain )

SMTP#do_finish

#606 in net/smtp.rb

do_finish

SMTP#send_message / 3

#651 in net/smtp.rb

send_message ( msgstr ,
  from_addr ,
  *to_addrs )

SMTP#open_message_stream / 3

#704 in net/smtp.rb

open_message_stream ( from_addr ,
  *to_addrs ,
  &block )

SMTP#authenticate / 3

#720 in net/smtp.rb

authenticate ( user ,
  secret ,
  authtype = DEFAULT_AUTH_TYPE )

SMTP#auth_plain / 2

#726 in net/smtp.rb

auth_plain ( user ,
  secret )

SMTP#auth_login / 2

#735 in net/smtp.rb

auth_login ( user ,
  secret )

SMTP#auth_cram_md5 / 2

#746 in net/smtp.rb

auth_cram_md5 ( user ,
  secret )

SMTP#check_auth_method / 1

#760 in net/smtp.rb

check_auth_method ( type )

SMTP#auth_method / 1

#766 in net/smtp.rb

auth_method ( type )

SMTP#check_auth_args / 2

#770 in net/smtp.rb

check_auth_args ( user ,
  secret )

SMTP#base64_encode / 1

#779 in net/smtp.rb

base64_encode ( str )

SMTP#cram_md5_response / 2

#788 in net/smtp.rb

cram_md5_response ( secret ,
  challenge )

SMTP#cram_secret / 2

#795 in net/smtp.rb

cram_secret ( secret ,
  mask )

SMTP#starttls

#810 in net/smtp.rb

starttls

SMTP#helo / 1

#814 in net/smtp.rb

helo ( domain )

SMTP#ehlo / 1

#818 in net/smtp.rb

ehlo ( domain )

SMTP#mailfrom / 1

#822 in net/smtp.rb

mailfrom ( from_addr )

SMTP#rcptto_list / 1

#829 in net/smtp.rb

rcptto_list ( to_addrs )

SMTP#rcptto / 1

#850 in net/smtp.rb

rcptto ( to_addr )

SMTP#data / 2

#880 in net/smtp.rb

data ( msgstr = nil ,
  &block )

SMTP#quit

#900 in net/smtp.rb

quit

SMTP#getok / 1

#906 in net/smtp.rb

getok ( reqline )

SMTP#get_response / 1

#915 in net/smtp.rb

get_response ( reqline )

SMTP#recv_response

#920 in net/smtp.rb

recv_response

SMTP#critical / 1

#930 in net/smtp.rb

critical ( &block )

SMTP#check_response / 1

#940 in net/smtp.rb

check_response ( res )

SMTP#check_continue / 1

#946 in net/smtp.rb

check_continue ( res )

SMTP#check_auth_response / 1

#952 in net/smtp.rb

check_auth_response ( res )

SMTP#check_auth_continue / 1

#958 in net/smtp.rb

check_auth_continue ( res )

SMTP#logging / 1

#1018 in net/smtp.rb

logging ( msg )