Class: Net::SMTP

# File 'lib/net/smtp.rb', line 211

def SMTP.default_ssl_context(ssl_context_params = nil)
  context = OpenSSL::SSL::SSLContext.new
  context.set_params(ssl_context_params || {})
  context
end

# File 'lib/net/smtp.rb', line 208

alias default_ssl_port default_tls_port

# File 'lib/net/smtp.rb', line 198

def SMTP.default_submission_port
  587
end

# File 'lib/net/smtp.rb', line 203

def SMTP.default_tls_port
  465
end

# File 'lib/net/smtp.rb', line 517

def SMTP.start(address, port = nil, *args, helo: nil,
               user: nil, secret: nil, password: nil, authtype: nil,
               tls: false, starttls: :auto,
               tls_verify: true, tls_hostname: nil, ssl_context_params: nil,
               &block)
  raise ArgumentError, "wrong number of arguments (given #{args.size + 2}, expected 1..6)" if args.size > 4
  helo ||= args[0] || 'localhost'
  user ||= args[1]
  secret ||= password || args[2]
  authtype ||= args[3]
  new(address, port, tls: tls, starttls: starttls, tls_verify: tls_verify, tls_hostname: tls_hostname, ssl_context_params: ssl_context_params).start(helo: helo, user: user, secret: secret, authtype: authtype, &block)
end

# File 'lib/net/smtp.rb', line 299

attr_reader :capabilities

# File 'lib/net/smtp.rb', line 315

def capable_cram_md5_auth?
  auth_capable?('CRAM-MD5')
end

# File 'lib/net/smtp.rb', line 309

def capable_login_auth?
  auth_capable?('LOGIN')
end

# File 'lib/net/smtp.rb', line 303

def capable_plain_auth?
  auth_capable?('PLAIN')
end

# File 'lib/net/smtp.rb', line 288

def capable_starttls?
  capable?('STARTTLS')
end

# File 'lib/net/smtp.rb', line 441

def debug_output=(arg)
  @debug_output = arg
end

# File 'lib/net/smtp.rb', line 284

alias esmtp? esmtp

# File 'lib/net/smtp.rb', line 413

attr_accessor :open_timeout

# File 'lib/net/smtp.rb', line 408

attr_reader :port

# File 'lib/net/smtp.rb', line 418

attr_reader :read_timeout

# File 'lib/net/smtp.rb', line 422

def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
end

# File 'lib/net/smtp.rb', line 339

alias ssl? tls?

# File 'lib/net/smtp.rb', line 267

attr_accessor :ssl_context_params

# File 'lib/net/smtp.rb', line 531

def started?
  @started
end

# File 'lib/net/smtp.rb', line 365

def starttls?
  @starttls
end

# File 'lib/net/smtp.rb', line 370

def starttls_always?
  @starttls == :always
end

# File 'lib/net/smtp.rb', line 375

def starttls_auto?
  @starttls == :auto
end

# File 'lib/net/smtp.rb', line 335

def tls?
  @tls
end

# File 'lib/net/smtp.rb', line 264

attr_accessor :tls_hostname

# File 'lib/net/smtp.rb', line 261

attr_accessor :tls_verify

# File 'lib/net/smtp.rb', line 319

def auth_capable?(type)
  return nil unless @capabilities
  return false unless @capabilities['AUTH']
  @capabilities['AUTH'].include?(type)
end

# File 'lib/net/smtp.rb', line 849

def auth_method(type)
  "auth_#{type.to_s.downcase}".intern
end

# File 'lib/net/smtp.rb', line 834

def authenticate(user, secret, authtype = DEFAULT_AUTH_TYPE)
  check_auth_method authtype
  check_auth_args user, secret
  authenticator = Authenticator.auth_class(authtype).new(self)
  authenticator.auth(user, secret)
end

# File 'lib/net/smtp.rb', line 293

def capable?(key)
  return nil unless @capabilities
  @capabilities[key] ? true : false
end

# File 'lib/net/smtp.rb', line 328

def capable_auth_types
  return [] unless @capabilities
  return [] unless @capabilities['AUTH']
  @capabilities['AUTH']
end

# File 'lib/net/smtp.rb', line 853

def check_auth_args(user, secret, authtype = DEFAULT_AUTH_TYPE)
  unless user
    raise ArgumentError, 'SMTP-AUTH requested but missing user name'
  end
  unless secret
    raise ArgumentError, 'SMTP-AUTH requested but missing secret phrase'
  end
end

# File 'lib/net/smtp.rb', line 843

def check_auth_method(type)
  unless Authenticator.auth_class(type)
    raise ArgumentError, "wrong authentication type #{type}"
  end
end

# File 'lib/net/smtp.rb', line 1015

def check_continue(res)
  unless res.continue?
    raise SMTPUnknownError.new(res, message: "could not get 3xx (#{res.status}: #{res.string})")
  end
end

# File 'lib/net/smtp.rb', line 1009

def check_response(res)
  unless res.success?
    raise res.exception_class.new(res)
  end
end

# File 'lib/net/smtp.rb', line 999

def critical
  return Response.parse('200 dummy reply code') if @error_occurred
  begin
    return yield()
  rescue Exception
    @error_occurred = true
    raise
  end
end

# File 'lib/net/smtp.rb', line 933

def data(msgstr = nil, &block)   #:yield: stream
  if msgstr and block
    raise ArgumentError, "message and block are exclusive"
  end
  unless msgstr or block
    raise ArgumentError, "message or block is required"
  end
  res = critical {
    check_continue get_response('DATA')
    socket_sync_bak = @socket.io.sync
    begin
      @socket.io.sync = false
      if msgstr
        @socket.write_message msgstr
      else
        @socket.write_message_by_block(&block)
      end
    ensure
      @socket.io.flush
      @socket.io.sync = socket_sync_bak
    end
    recv_response()
  }
  check_response res
  res
end

# File 'lib/net/smtp.rb', line 360

alias disable_ssl disable_tls

# File 'lib/net/smtp.rb', line 399

def disable_starttls
  @starttls = false
  @ssl_context_starttls = nil
end

# File 'lib/net/smtp.rb', line 355

def disable_tls
  @tls = false
  @ssl_context_tls = nil
end

# File 'lib/net/smtp.rb', line 700

def do_finish
  quit if @socket and not @socket.closed? and not @error_occurred
ensure
  @started = false
  @error_occurred = false
  @socket.close if @socket
  @socket = nil
end

# File 'lib/net/smtp.rb', line 688

def do_helo(helo_domain)
  res = @esmtp ? ehlo(helo_domain) : helo(helo_domain)
  @capabilities = res.capabilities
rescue SMTPError
  if @esmtp
    @esmtp = false
    @error_occurred = false
    retry
  end
  raise
end

# File 'lib/net/smtp.rb', line 634

def do_start(helo_domain, user, secret, authtype)
  raise IOError, 'SMTP session already started' if @started
  if user or secret
    check_auth_method(authtype || DEFAULT_AUTH_TYPE)
    check_auth_args user, secret
  end
  s = Timeout.timeout(@open_timeout, Net::OpenTimeout) do
    tcp_socket(@address, @port)
  end
  logging "Connection opened: #{@address}:#{@port}"
  @socket = new_internet_message_io(tls? ? tlsconnect(s, @ssl_context_tls) : s)
  check_response critical { recv_response() }
  do_helo helo_domain
  if ! tls? and (starttls_always? or (capable_starttls? and starttls_auto?))
    unless capable_starttls?
      raise SMTPUnsupportedCommand, "STARTTLS is not supported on this server"
    end
    starttls
    @socket = new_internet_message_io(tlsconnect(s, @ssl_context_starttls))
    # helo response may be different after STARTTLS
    do_helo helo_domain
  end
  authenticate user, secret, (authtype || DEFAULT_AUTH_TYPE) if user
  @started = true
ensure
  unless @started
    # authentication failed, cancel connection.
    s.close if s
    @socket = nil
  end
end

# File 'lib/net/smtp.rb', line 882

def ehlo(domain)
  getok("EHLO #{domain}")
end

# File 'lib/net/smtp.rb', line 351

alias enable_ssl enable_tls

# File 'lib/net/smtp.rb', line 381

def enable_starttls(context = nil)
  raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
  raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @tls
  @starttls = :always
  @ssl_context_starttls = context
end

# File 'lib/net/smtp.rb', line 390

def enable_starttls_auto(context = nil)
  raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
  raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @tls
  @starttls = :auto
  @ssl_context_starttls = context
end

# File 'lib/net/smtp.rb', line 344

def enable_tls(context = nil)
  raise 'openssl library not installed' unless defined?(OpenSSL::VERSION)
  raise ArgumentError, "SMTPS and STARTTLS is exclusive" if @starttls == :always
  @tls = true
  @ssl_context_tls = context
end

# File 'lib/net/smtp.rb', line 281

attr_accessor :esmtp

# File 'lib/net/smtp.rb', line 623

def finish
  raise IOError, 'not yet started' unless started?
  do_finish
end

# File 'lib/net/smtp.rb', line 964

def get_response(reqline)
  validate_line reqline
  @socket.writeline reqline
  recv_response()
end

# File 'lib/net/smtp.rb', line 979

def getok(reqline)
  validate_line reqline
  res = critical {
    @socket.writeline reqline
    recv_response()
  }
  check_response res
  res
end

# File 'lib/net/smtp.rb', line 878

def helo(domain)
  getok("HELO #{domain}")
end

# File 'lib/net/smtp.rb', line 270

def inspect
  "#<#{self.class} #{@address}:#{@port} started=#{@started}>"
end

# File 'lib/net/smtp.rb', line 1100

def logging(msg)
  @debug_output << msg + "\n" if @debug_output
end

# File 'lib/net/smtp.rb', line 887

def mailfrom(from_addr)
  addr = if requires_smtputf8(from_addr) && capable?("SMTPUTF8")
           Address.new(from_addr, "SMTPUTF8")
         else
           Address.new(from_addr)
         end
  getok((["MAIL FROM:<#{addr.address}>"] + addr.parameters).join(' '))
end

# File 'lib/net/smtp.rb', line 683

def new_internet_message_io(s)
  InternetMessageIO.new(s, read_timeout: @read_timeout,
                        debug_output: @debug_output)
end

# File 'lib/net/smtp.rb', line 818

def open_message_stream(from_addr, *to_addrs, &block)   # :yield: stream
  to_addrs.flatten!
  raise IOError, 'closed session' unless @socket
  from_addr = Address.new(from_addr, 'SMTPUTF8') if any_require_smtputf8(to_addrs) && capable?('SMTPUTF8')
  mailfrom from_addr
  rcptto_list(to_addrs) {data(&block)}
end

# File 'lib/net/smtp.rb', line 960

def quit
  getok('QUIT')
end

# File 'lib/net/smtp.rb', line 905

def rcptto(to_addr)
  addr = Address.new(to_addr)
  getok((["RCPT TO:<#{addr.address}>"] + addr.parameters).join(' '))
end

# File 'lib/net/smtp.rb', line 896

def rcptto_list(to_addrs)
  raise ArgumentError, 'mail destination not given' if to_addrs.empty?
  to_addrs.flatten.each do |addr|
    rcptto addr
  end
  yield
end

# File 'lib/net/smtp.rb', line 826

alias ready open_message_stream   # obsolete

# File 'lib/net/smtp.rb', line 989

def recv_response
  buf = ''.dup
  while true
    line = @socket.readline
    buf << line << "\n"
    break unless line[3,1] == '-'   # "210-PIPELINING"
  end
  Response.parse(buf)
end

# File 'lib/net/smtp.rb', line 709

def requires_smtputf8(address)
  if address.kind_of? Address
    !address.address.ascii_only?
  else
    !address.ascii_only?
  end
end

# File 'lib/net/smtp.rb', line 870

def rset
  getok('RSET')
end

# File 'lib/net/smtp.rb', line 771

alias send_mail send_message

# File 'lib/net/smtp.rb', line 763

def send_message(msgstr, from_addr, *to_addrs)
  to_addrs.flatten!
  raise IOError, 'closed session' unless @socket
  from_addr = Address.new(from_addr, 'SMTPUTF8') if any_require_smtputf8(to_addrs) && capable?('SMTPUTF8')
  mailfrom from_addr
  rcptto_list(to_addrs) {data msgstr}
end

# File 'lib/net/smtp.rb', line 772

alias sendmail send_message   # obsolete

# File 'lib/net/smtp.rb', line 666

def ssl_socket(socket, context)
  OpenSSL::SSL::SSLSocket.new socket, context
end

# File 'lib/net/smtp.rb', line 590

def start(*args, helo: nil, user: nil, secret: nil, password: nil, authtype: nil)
  raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..4)" if args.size > 4
  helo ||= args[0] || 'localhost'
  user ||= args[1]
  secret ||= password || args[2]
  authtype ||= args[3]
  if defined?(OpenSSL::VERSION)
    ssl_context_params = @ssl_context_params || {}
    unless ssl_context_params.has_key?(:verify_mode)
      ssl_context_params[:verify_mode] = @tls_verify ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
    end
    if @tls && @ssl_context_tls.nil?
      @ssl_context_tls = SMTP.default_ssl_context(ssl_context_params)
    end
    if @starttls && @ssl_context_starttls.nil?
      @ssl_context_starttls = SMTP.default_ssl_context(ssl_context_params)
    end
  end
  if block_given?
    begin
      do_start helo, user, secret, authtype
      return yield(self)
    ensure
      do_finish
    end
  else
    do_start helo, user, secret, authtype
    return self
  end
end

# File 'lib/net/smtp.rb', line 874

def starttls
  getok('STARTTLS')
end

# File 'lib/net/smtp.rb', line 630

def tcp_socket(address, port)
  TCPSocket.open address, port
end

# File 'lib/net/smtp.rb', line 670

def tlsconnect(s, context)
  verified = false
  s = ssl_socket(s, context)
  logging "TLS connection started"
  s.sync_close = true
  s.hostname = @tls_hostname || @address
  ssl_socket_connect(s, @open_timeout)
  verified = true
  s
ensure
  s.close unless verified
end

# File 'lib/net/smtp.rb', line 972

def validate_line(line)
  # A bare CR or LF is not allowed in RFC5321.
  if /[\r\n]/ =~ line
    raise ArgumentError, "A line must not contain CR or LF"
  end
end