The default SMTP port number, 25.

The default mail submission port number, 587.

The default SMTPS port number, 465.

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.

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.

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

This method is equivalent to:

  Net::SMTP.new(address, port).start(helo_domain, account, password, authtype)

Example

    Net::SMTP.start('your.smtp.server') do |smtp|
      smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
    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.localdomain’.

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.

Errors

This method may raise:

• Net::SMTPAuthenticationError
• Net::SMTPServerBusy
• Net::SMTPSyntaxError
• Net::SMTPFatalError
• Net::SMTPUnknownError
• IOError
• TimeoutError

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

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

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

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

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

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: john@example.com
  To: betty@example.com
  Subject: I found a bug

  Check vm.c:58879.
  EndMessage

  # Example 2 (by block)
  smtp.data {|f|
    f.puts "From: john@example.com"
    f.puts "To: betty@example.com"
    f.puts "Subject: I found a bug"
    f.puts ""
    f.puts "Check vm.c:58879."
  }

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

Alias for disable_tls

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

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

Alias for enable_tls

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

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

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.

Alias for 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).

true if the SMTP object uses ESMTP (which it does by default).

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

Provide human-readable stringification of class state.

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

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 representing the source mail address.

to_addr is a String or Strings or Array of Strings, representing the destination mail address or addresses.

Example

    Net::SMTP.start('smtp.example.com', 25) do |smtp|
      smtp.open_message_stream('from@example.com', ['dest@example.com']) do |f|
        f.puts 'From: from@example.com'
        f.puts 'To: dest@example.com'
        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
• IOError
• TimeoutError

Set the number of seconds to wait until timing-out a read(2) call.

Alias for open_message_stream

Alias for send_message

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 representing the source mail address.

to_addr is a String or Strings or Array of Strings, representing the destination mail address or addresses.

Example

    Net::SMTP.start('smtp.example.com') do |smtp|
      smtp.send_message msgstr,
                        'from@example.com',
                        ['dest@example.com', 'dest2@example.com']
    end

Errors

This method may raise:

• Net::SMTPServerBusy
• Net::SMTPSyntaxError
• Net::SMTPFatalError
• Net::SMTPUnknownError
• IOError
• TimeoutError

Alias for send_message

Alias for debug_output=

Alias for tls?

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_domain, account, password, authtype) do |smtp|
      smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
    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
• IOError
• TimeoutError

true if the SMTP session has been started.

SMTP command dispatcher

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.

true if this object uses STARTTLS.

true if this object uses STARTTLS when server advertises STARTTLS.

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