Class: Net::SMTP

Inherits:
Protocol
  • Object
show all
Defined in:
lib/net/smtp.rb

Overview

What is This Library?

This library provides functionality to send internet mail via SMTP, the Simple Mail Transfer Protocol. For details of SMTP itself, see [RFC2821] (www.ietf.org/rfc/rfc2821.txt).

What is This Library NOT?

This library does NOT provide functions to compose internet mails. You must create them by yourself. If you want better mail support, try RubyMail or TMail or search for alternatives in RubyGems.org or The Ruby Toolbox.

FYI: the official documentation on internet mail is: [RFC2822] (www.ietf.org/rfc/rfc2822.txt).

Examples

Sending Messages

You must open a connection to an SMTP server before sending messages. The first argument is the address of your SMTP server, and the second argument is the port number. Using SMTP.start with a block is the simplest way to do this. This way, the SMTP connection is closed automatically after the block is executed.

require 'net/smtp'
Net::SMTP.start('your.smtp.server', 25) do |smtp|
  # Use the SMTP object smtp only in this block.
end

Replace 'your.smtp.server' with your SMTP server. Normally your system manager or internet provider supplies a server for you.

Then you can send messages.

msgstr = <<END_OF_MESSAGE
From: Your Name <[email protected]>
To: Destination Address <[email protected]>
Subject: test message
Date: Sat, 23 Jun 2001 16:26:43 +0900
Message-Id: <[email protected]>

This is a test message.
END_OF_MESSAGE

require 'net/smtp'
Net::SMTP.start('your.smtp.server', 25) do |smtp|
  smtp.send_message msgstr,
                    '[email protected]',
                    '[email protected]'
end

Closing the Session

You MUST close the SMTP session after sending messages, by calling the #finish method:

# using SMTP#finish
smtp = Net::SMTP.start('your.smtp.server', 25)
smtp.send_message msgstr, '[email protected]', '[email protected]'
smtp.finish

You can also use the block form of SMTP.start/SMTP#start. This closes the SMTP session automatically:

# using block form of SMTP.start
Net::SMTP.start('your.smtp.server', 25) do |smtp|
  smtp.send_message msgstr, '[email protected]', '[email protected]'
end

I strongly recommend this scheme. This form is simpler and more robust.

HELO domain

In almost all situations, you must provide a third argument to SMTP.start/SMTP#start. This is the domain name which you are on (the host to send mail from). It is called the “HELO domain”. The SMTP server will judge whether it should send or reject the SMTP session by inspecting the HELO domain.

Net::SMTP.start('your.smtp.server', 25
                helo: 'mail.from.domain') { |smtp| ... }

SMTP Authentication

The Net::SMTP class supports three authentication schemes; PLAIN, LOGIN and CRAM MD5. (SMTP Authentication: [RFC2554]) To use SMTP authentication, pass extra arguments to SMTP.start/SMTP#start.

# PLAIN
Net::SMTP.start('your.smtp.server', 25
                user: 'Your Account', secret: 'Your Password', authtype: :plain)
# LOGIN
Net::SMTP.start('your.smtp.server', 25
                user: 'Your Account', secret: 'Your Password', authtype: :login)

# CRAM MD5
Net::SMTP.start('your.smtp.server', 25
                user: 'Your Account', secret: 'Your Password', authtype: :cram_md5)

Defined Under Namespace

Classes: Address, Response

Constant Summary collapse

VERSION =
"0.3.3"
Revision =
%q$Revision$.split[1]
DEFAULT_AUTH_TYPE =
:plain

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, port = nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil) ⇒ SMTP

Creates a new Net::SMTP object.

address is the hostname or ip address of your SMTP server. port is the port to connect to; it defaults to port 25.

If tls is true, enable TLS. The default is false. If starttls is :always, enable STARTTLS, if :auto, use STARTTLS when the server supports it, if false, disable STARTTLS.

If tls_verify is true, verify the server's certificate. The default is true. If the hostname in the server certificate is different from address, it can be specified with tls_hostname.

Additional SSLContext params can be added to ssl_context_params hash argument and are passed to OpenSSL::SSL::SSLContext#set_params

tls_verify: true is equivalent to ssl_context_params: { verify_mode: OpenSSL::SSL::VERIFY_PEER }. This method does not open the TCP connection. You can use SMTP.start instead of SMTP.new if you want to do everything at once. Otherwise, follow SMTP.new with SMTP#start.


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/net/smtp.rb', line 241

def initialize(address, port = nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil)
  @address = address
  @port = (port || SMTP.default_port)
  @esmtp = true
  @capabilities = nil
  @socket = nil
  @started = false
  @open_timeout = 30
  @read_timeout = 60
  @error_occurred = false
  @debug_output = nil
  @tls = tls
  @starttls = starttls
  @ssl_context_tls = nil
  @ssl_context_starttls = nil
  @tls_verify = tls_verify
  @tls_hostname = tls_hostname
  @ssl_context_params = ssl_context_params
end

Instance Attribute Details

#addressObject (readonly)

The address of the SMTP server to connect to.


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

def address
  @address
end

#capabilitiesObject (readonly)

The server capabilities by EHLO response


300
301
302
# File 'lib/net/smtp.rb', line 300

def capabilities
  @capabilities
end

#esmtpObject Also known as: esmtp?

Set whether to use ESMTP or not. This should be done before calling #start. Note that if #start is called in ESMTP mode, and the connection fails due to a ProtocolError, the SMTP object will automatically switch to plain SMTP mode and retry (but not vice versa).


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

def esmtp
  @esmtp
end

#open_timeoutObject

Seconds to wait while attempting to open a connection. If the connection cannot be opened within this time, a Net::OpenTimeout is raised. The default value is 30 seconds.


414
415
416
# File 'lib/net/smtp.rb', line 414

def open_timeout
  @open_timeout
end

#portObject (readonly)

The port number of the SMTP server to connect to.


409
410
411
# File 'lib/net/smtp.rb', line 409

def port
  @port
end

#read_timeoutObject

Seconds to wait while reading one block (by one read(2) call). If the read(2) call does not complete within this time, a Net::ReadTimeout is raised. The default value is 60 seconds.


419
420
421
# File 'lib/net/smtp.rb', line 419

def read_timeout
  @read_timeout
end

#ssl_context_paramsObject

Hash for additional SSLContext parameters.


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

def ssl_context_params
  @ssl_context_params
end

#tls_hostnameObject

The hostname for verifying hostname in the server certificatate.


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

def tls_hostname
  @tls_hostname
end

#tls_verifyObject

If true, verify th server's certificate.


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

def tls_verify
  @tls_verify
end

Class Method Details

.default_portObject

The default SMTP port number, 25.


194
195
196
# File 'lib/net/smtp.rb', line 194

def SMTP.default_port
  25
end

.default_ssl_context(ssl_context_params = nil) ⇒ Object


212
213
214
215
216
# File 'lib/net/smtp.rb', line 212

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

.default_submission_portObject

The default mail submission port number, 587.


199
200
201
# File 'lib/net/smtp.rb', line 199

def SMTP.default_submission_port
  587
end

.default_tls_portObject Also known as: default_ssl_port

The default SMTPS port number, 465.


204
205
206
# File 'lib/net/smtp.rb', line 204

def SMTP.default_tls_port
  465
end

.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) ⇒ Object

:call-seq:

start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil, tls: false, starttls: :auto, tls_verify: true, tls_hostname: nil, ssl_context_params: nil) { |smtp| ... }
start(address, port = nil, helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }

Creates a new Net::SMTP object and connects to the server.

This method is equivalent to:

Net::SMTP.new(address, port).start(helo: helo_domain, user: , secret: password, authtype: authtype, tls_verify: flag, tls_hostname: hostname, ssl_context_params: nil)

Example

Net::SMTP.start('your.smtp.server') do |smtp|
  smtp.send_message msgstr, '[email protected]', ['[email protected]']
end

Block Usage

If called with a block, the newly-opened Net::SMTP object is yielded to the block, and automatically closed when the block finishes. If called without a block, the newly-opened Net::SMTP object is returned to the caller, and it is the caller's responsibility to close it when finished.

Parameters

address is the hostname or ip address of your smtp server.

port is the port to connect to; it defaults to port 25.

helo is the HELO domain provided by the client to the server (see overview comments); it defaults to 'localhost'.

The remaining arguments are used for SMTP authentication, if required or desired. user is the account name; secret is your password or other authentication token; and authtype is the authentication type, one of :plain, :login, or :cram_md5. See the discussion of SMTP Authentication in the overview notes.

If tls is true, enable TLS. The default is false. If starttls is :always, enable STARTTLS, if :auto, use STARTTLS when the server supports it, if false, disable STARTTLS.

If tls_verify is true, verify the server's certificate. The default is true. If the hostname in the server certificate is different from address, it can be specified with tls_hostname.

Additional SSLContext params can be added to ssl_context_params hash argument and are passed to OpenSSL::SSL::SSLContext#set_params

tls_verify: true is equivalent to ssl_context_params: { verify_mode: OpenSSL::SSL::VERIFY_PEER }.

Errors

This method may raise:

  • Net::SMTPAuthenticationError

  • Net::SMTPServerBusy

  • Net::SMTPSyntaxError

  • Net::SMTPFatalError

  • Net::SMTPUnknownError

  • Net::OpenTimeout

  • Net::ReadTimeout

  • IOError

Raises:

  • (ArgumentError)

518
519
520
521
522
523
524
525
526
527
528
529
# File 'lib/net/smtp.rb', line 518

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

Instance Method Details

#auth_cram_md5(user, secret) ⇒ Object


860
861
862
863
864
865
866
867
868
869
870
# File 'lib/net/smtp.rb', line 860

def auth_cram_md5(user, secret)
  check_auth_args user, secret
  res = critical {
    res0 = get_response('AUTH CRAM-MD5')
    check_auth_continue res0
    crammed = cram_md5_response(secret, res0.cram_md5_challenge)
    get_response(base64_encode("#{user} #{crammed}"))
  }
  check_auth_response res
  res
end

#auth_login(user, secret) ⇒ Object


849
850
851
852
853
854
855
856
857
858
# File 'lib/net/smtp.rb', line 849

def (user, secret)
  check_auth_args user, secret
  res = critical {
    check_auth_continue get_response('AUTH LOGIN')
    check_auth_continue get_response(base64_encode(user))
    get_response(base64_encode(secret))
  }
  check_auth_response res
  res
end

#auth_plain(user, secret) ⇒ Object


840
841
842
843
844
845
846
847
# File 'lib/net/smtp.rb', line 840

def auth_plain(user, secret)
  check_auth_args user, secret
  res = critical {
    get_response('AUTH PLAIN ' + base64_encode("\0#{user}\0#{secret}"))
  }
  check_auth_response res
  res
end

#authenticate(user, secret, authtype = DEFAULT_AUTH_TYPE) ⇒ Object


834
835
836
837
838
# File 'lib/net/smtp.rb', line 834

def authenticate(user, secret, authtype = DEFAULT_AUTH_TYPE)
  check_auth_method authtype
  check_auth_args user, secret
  public_send auth_method(authtype), user, secret
end

#capable?(key) ⇒ Boolean

true if the EHLO response contains key.

Returns:

  • (Boolean)

294
295
296
297
# File 'lib/net/smtp.rb', line 294

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

#capable_auth_typesObject

Returns supported authentication methods on this server. You cannot get valid value before opening SMTP session.


329
330
331
332
333
# File 'lib/net/smtp.rb', line 329

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

#capable_cram_md5_auth?Boolean

true if server advertises AUTH CRAM-MD5. You cannot get valid value before opening SMTP session.

Returns:

  • (Boolean)

316
317
318
# File 'lib/net/smtp.rb', line 316

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

#capable_login_auth?Boolean

true if server advertises AUTH LOGIN. You cannot get valid value before opening SMTP session.

Returns:

  • (Boolean)

310
311
312
# File 'lib/net/smtp.rb', line 310

def 
  auth_capable?('LOGIN')
end

#capable_plain_auth?Boolean

true if server advertises AUTH PLAIN. You cannot get valid value before opening SMTP session.

Returns:

  • (Boolean)

304
305
306
# File 'lib/net/smtp.rb', line 304

def capable_plain_auth?
  auth_capable?('PLAIN')
end

#capable_starttls?Boolean

true if server advertises STARTTLS. You cannot get valid value before opening SMTP session.

Returns:

  • (Boolean)

289
290
291
# File 'lib/net/smtp.rb', line 289

def capable_starttls?
  capable?('STARTTLS')
end

#data(msgstr = nil, &block) ⇒ Object

This method sends a message. If msgstr is given, sends it as a message. If block is given, yield a message writer stream. You must write message before the block is closed.

# Example 1 (by string)
smtp.data(<<EndMessage)
From: [email protected]
To: [email protected]
Subject: I found a bug

Check vm.c:58879.
EndMessage

# Example 2 (by block)
smtp.data {|f|
  f.puts "From: [email protected]"
  f.puts "To: [email protected]"
  f.puts "Subject: I found a bug"
  f.puts ""
  f.puts "Check vm.c:58879."
}

998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
# File 'lib/net/smtp.rb', line 998

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

#debug_output=(arg) ⇒ Object Also known as: set_debug_output

WARNING: This method causes serious security holes. Use this method for only debugging.

Set an output stream for debug logging. You must call this before #start.

# example
smtp = Net::SMTP.new(addr, port)
smtp.set_debug_output $stderr
smtp.start do |smtp|
  ....
end

442
443
444
# File 'lib/net/smtp.rb', line 442

def debug_output=(arg)
  @debug_output = arg
end

#disable_starttlsObject

Disables SMTP/TLS (STARTTLS) for this object. Must be called before the connection is established to have any effect.


400
401
402
403
# File 'lib/net/smtp.rb', line 400

def disable_starttls
  @starttls = false
  @ssl_context_starttls = nil
end

#disable_tlsObject Also known as: disable_ssl

Disables SMTP/TLS for this object. Must be called before the connection is established to have any effect.


356
357
358
359
# File 'lib/net/smtp.rb', line 356

def disable_tls
  @tls = false
  @ssl_context_tls = nil
end

#ehlo(domain) ⇒ Object


938
939
940
# File 'lib/net/smtp.rb', line 938

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

#enable_starttls(context = nil) ⇒ Object

Enables SMTP/TLS (STARTTLS) for this object. context is a OpenSSL::SSL::SSLContext object.

Raises:

  • (ArgumentError)

382
383
384
385
386
387
# File 'lib/net/smtp.rb', line 382

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

#enable_starttls_auto(context = nil) ⇒ Object

Enables SMTP/TLS (STARTTLS) for this object if server accepts. context is a OpenSSL::SSL::SSLContext object.

Raises:

  • (ArgumentError)

391
392
393
394
395
396
# File 'lib/net/smtp.rb', line 391

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

#enable_tls(context = nil) ⇒ Object Also known as: enable_ssl

Enables SMTP/TLS (SMTPS: SMTP over direct TLS connection) for this object. Must be called before the connection is established to have any effect. context is a OpenSSL::SSL::SSLContext object.

Raises:

  • (ArgumentError)

345
346
347
348
349
350
# File 'lib/net/smtp.rb', line 345

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

#finishObject

Finishes the SMTP session and closes TCP connection. Raises IOError if not started.

Raises:

  • (IOError)

624
625
626
627
# File 'lib/net/smtp.rb', line 624

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

#helo(domain) ⇒ Object


934
935
936
# File 'lib/net/smtp.rb', line 934

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

#inspectObject

Provide human-readable stringification of class state.


271
272
273
# File 'lib/net/smtp.rb', line 271

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

#mailfrom(from_addr) ⇒ Object

from_addr is String or Net::SMTP::Address


943
944
945
946
# File 'lib/net/smtp.rb', line 943

def mailfrom(from_addr)
  addr = Address.new(from_addr)
  getok((["MAIL FROM:<#{addr.address}>"] + addr.parameters).join(' '))
end

#open_message_stream(from_addr, *to_addrs, &block) ⇒ Object Also known as: ready

Opens a message writer stream and gives it to the block. The stream is valid only in the block, and has these methods:

puts(str = '')

outputs STR and CR LF.

print(str)

outputs STR.

printf(fmt, *args)

outputs sprintf(fmt,*args).

write(str)

outputs STR and returns the length of written bytes.

<<(str)

outputs STR and returns self.

If a single CR (“r”) or LF (“n”) is found in the message, it is converted to the CR LF pair. You cannot send a binary message with this method.

Parameters

from_addr is a String or Net::SMTP::Address representing the source mail address.

to_addr is a String or Net::SMTP::Address or Array of them, representing the destination mail address or addresses.

Example

Net::SMTP.start('smtp.example.com', 25) do |smtp|
  smtp.open_message_stream('[email protected]', ['[email protected]']) do |f|
    f.puts 'From: [email protected]'
    f.puts 'To: [email protected]'
    f.puts 'Subject: test message'
    f.puts
    f.puts 'This is a test message.'
  end
end

Errors

This method may raise:

  • Net::SMTPServerBusy

  • Net::SMTPSyntaxError

  • Net::SMTPFatalError

  • Net::SMTPUnknownError

  • Net::ReadTimeout

  • IOError

Raises:

  • (IOError)

818
819
820
821
822
# File 'lib/net/smtp.rb', line 818

def open_message_stream(from_addr, *to_addrs, &block)   # :yield: stream
  raise IOError, 'closed session' unless @socket
  mailfrom from_addr
  rcptto_list(to_addrs) {data(&block)}
end

#quitObject


1025
1026
1027
# File 'lib/net/smtp.rb', line 1025

def quit
  getok('QUIT')
end

#rcptto(to_addr) ⇒ Object

to_addr is String or Net::SMTP::Address


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

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

#rcptto_list(to_addrs) ⇒ Object

Raises:

  • (ArgumentError)

948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
# File 'lib/net/smtp.rb', line 948

def rcptto_list(to_addrs)
  raise ArgumentError, 'mail destination not given' if to_addrs.empty?
  ok_users = []
  unknown_users = []
  to_addrs.flatten.each do |addr|
    begin
      rcptto addr
    rescue SMTPAuthenticationError
      unknown_users << addr.to_s.dump
    else
      ok_users << addr
    end
  end
  raise ArgumentError, 'mail destination not given' if ok_users.empty?
  ret = yield
  unless unknown_users.empty?
    raise SMTPAuthenticationError, "failed to deliver for #{unknown_users.join(', ')}"
  end
  ret
end

#rsetObject

Aborts the current mail transaction


926
927
928
# File 'lib/net/smtp.rb', line 926

def rset
  getok('RSET')
end

#send_message(msgstr, from_addr, *to_addrs) ⇒ Object Also known as: send_mail, sendmail

Sends msgstr as a message. Single CR (“r”) and LF (“n”) found in the msgstr, are converted into the CR LF pair. You cannot send a binary message with this method. msgstr should include both the message headers and body.

from_addr is a String or Net::SMTP::Address representing the source mail address.

to_addr is a String or Net::SMTP::Address or Array of them, representing the destination mail address or addresses.

Example

Net::SMTP.start('smtp.example.com') do |smtp|
  smtp.send_message msgstr,
                    '[email protected]',
                    ['[email protected]', '[email protected]']
end

Net::SMTP.start('smtp.example.com') do |smtp|
  smtp.send_message msgstr,
                    Net::SMTP::Address.new('[email protected]', size: 12345),
                    Net::SMTP::Address.new('[email protected]', notify: :success)
end

Errors

This method may raise:

  • Net::SMTPServerBusy

  • Net::SMTPSyntaxError

  • Net::SMTPFatalError

  • Net::SMTPUnknownError

  • Net::ReadTimeout

  • IOError

Raises:

  • (IOError)

765
766
767
768
769
# File 'lib/net/smtp.rb', line 765

def send_message(msgstr, from_addr, *to_addrs)
  raise IOError, 'closed session' unless @socket
  mailfrom from_addr
  rcptto_list(to_addrs) {data msgstr}
end

#start(*args, helo: nil, user: nil, secret: nil, password: nil, authtype: nil) ⇒ Object

:call-seq:

start(helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... }
start(helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... }

Opens a TCP connection and starts the SMTP session.

Parameters

helo is the HELO domain that you'll dispatch mails from; see the discussion in the overview notes.

If both of user and secret are given, SMTP authentication will be attempted using the AUTH command. authtype specifies the type of authentication to attempt; it must be one of :login, :plain, and :cram_md5. See the notes on SMTP Authentication in the overview.

Block Usage

When this methods is called with a block, the newly-started SMTP object is yielded to the block, and automatically closed after the block call finishes. Otherwise, it is the caller's responsibility to close the session when finished.

Example

This is very similar to the class method SMTP.start.

require 'net/smtp'
smtp = Net::SMTP.new('smtp.mail.server', 25)
smtp.start(helo: helo_domain, user: , secret: password, authtype: authtype) do |smtp|
  smtp.send_message msgstr, '[email protected]', ['[email protected]']
end

The primary use of this method (as opposed to SMTP.start) is probably to set debugging (#set_debug_output) or ESMTP (#esmtp=), which must be done before the session is started.

Errors

If session has already been started, an IOError will be raised.

This method may raise:

  • Net::SMTPAuthenticationError

  • Net::SMTPServerBusy

  • Net::SMTPSyntaxError

  • Net::SMTPFatalError

  • Net::SMTPUnknownError

  • Net::OpenTimeout

  • Net::ReadTimeout

  • IOError

Raises:

  • (ArgumentError)

591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
# File 'lib/net/smtp.rb', line 591

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

#started?Boolean

true if the SMTP session has been started.

Returns:

  • (Boolean)

532
533
534
# File 'lib/net/smtp.rb', line 532

def started?
  @started
end

#starttlsObject


930
931
932
# File 'lib/net/smtp.rb', line 930

def starttls
  getok('STARTTLS')
end

#starttls?Boolean

Returns truth value if this object uses STARTTLS. If this object always uses STARTTLS, returns :always. If this object uses STARTTLS when the server support TLS, returns :auto.

Returns:

  • (Boolean)

366
367
368
# File 'lib/net/smtp.rb', line 366

def starttls?
  @starttls
end

#starttls_always?Boolean

true if this object uses STARTTLS.

Returns:

  • (Boolean)

371
372
373
# File 'lib/net/smtp.rb', line 371

def starttls_always?
  @starttls == :always
end

#starttls_auto?Boolean

true if this object uses STARTTLS when server advertises STARTTLS.

Returns:

  • (Boolean)

376
377
378
# File 'lib/net/smtp.rb', line 376

def starttls_auto?
  @starttls == :auto
end

#tls?Boolean Also known as: ssl?

true if this object uses SMTP/TLS (SMTPS).

Returns:

  • (Boolean)

336
337
338
# File 'lib/net/smtp.rb', line 336

def tls?
  @tls
end