# Net::SMTP (Class)

In: | net/smtp.rb
Parent: | Object

Class providing SMTP client functionality.

See documentation for the file smtp.rb for examples of usage.

## Methods

default_port esmtp esmtp= esmtp? finish inspect new open_message_stream read_timeout= ready send_mail send_message sendmail set_debug_output start start started?

## Constants

Revision | = | %q$Revision: 1.69 $.split[1]
SMTPSession | = | SMTP

## Attributes

address | [R] | The address of the SMTP server to connect to.
open_timeout | [RW] | Seconds to wait while attempting to open a connection. If the connection cannot be opened within this time, a TimeoutError is raised.
port | [R] | The port number of the SMTP server to connect to.
read_timeout | [R] | Seconds to wait while reading one block (by one read(2) call). If the read(2) call does not complete within this time, a TimeoutError is raised.

## Public Class methods

default_port()

The default SMTP port, port 25.

[Source]

    # File net/smtp.rb, line 168
        def SMTP.default_port
          25
        end

new( address, port = nil )

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.

[Source]

    # File net/smtp.rb, line 176
        def initialize( address, port = nil )
          @address = address
          @port = (port || SMTP.default_port)
          @esmtp = true
          @socket = nil
          @started = false
          @open_timeout = 30
          @read_timeout = 60
          @error_occured = false
          @debug_output = nil
        end

start( address, port = nil, helo = 'localhost.localdomain', 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_domain,account,password,authtype)

        # example
        Net::SMTP.start('your.smtp.server') {
          smtp.send_message msgstr, 'from@example.com', ['dest@example.com']
        }

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.

`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.

This method may raise:

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

[Source]

    # File net/smtp.rb, line 288
        def SMTP.start( address, port = nil,
                        helo = 'localhost.localdomain',
                        user = nil, secret = nil, authtype = nil,
                        &block) # :yield: smtp

          new(address, port).start(helo, user, secret, authtype, &block)
        end

## Public Instance methods

inspect()

Provide human-readable stringification of class state.

[Source]

    # File net/smtp.rb, line 189
        def inspect
          "#<#{self.class} #{@address}:#{@port} started=#{@started}>"
        end

esmtp?()

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

[Source]

    # File net/smtp.rb, line 194
        def esmtp?
          @esmtp
        end

esmtp=( bool )

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

[Source]

    # File net/smtp.rb, line 203
        def esmtp=( bool )
          @esmtp = bool
        end

esmtp()

Alias for esmtp?

read_timeout=( sec )

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

[Source]

    # File net/smtp.rb, line 227
        def read_timeout=( sec )
          @socket.read_timeout = sec if @socket
          @read_timeout = sec
        end

set_debug_output( arg )

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 {
        ....
      }

[Source]

    # File net/smtp.rb, line 244
        def set_debug_output( arg )
          @debug_output = arg
        end

started?()

`true` if the SMTP session has been started.

[Source]

    # File net/smtp.rb, line 296
        def started?
          @started
        end

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

Opens a TCP connection and starts the SMTP session.

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

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.

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.

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

[Source]

    # File net/smtp.rb, line 327
        def start( helo = 'localhost.localdomain',
                   user = nil, secret = nil, authtype = nil ) # :yield: smtp

          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

finish()

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

[Source]

    # File net/smtp.rb, line 373
        def finish
          raise IOError, 'not started yet' unless started?
          do_finish
        end

send_message( msgstr, from_addr, *to_addrs )

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') {|smtp|
          smtp.send_message msgstr,
                            'from@example.com',
                            ['dest@example.com', 'dest2@example.com']
        }

This method may raise:

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

[Source]

    # File net/smtp.rb, line 418
        def send_message( msgstr, from_addr, *to_addrs )
          send0(from_addr, to_addrs.flatten) {
            @socket.write_message msgstr
          }
        end

send_mail( msgstr, from_addr, *to_addrs )

Alias for send_message

sendmail( msgstr, from_addr, *to_addrs )

Alias for send_message

open_message_stream( from_addr, *to_addrs ) {|stream| ...}

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.

`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) {|smtp|
          smtp.open_message_stream('from@example.com', ['dest@example.com']) {|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.'
          }
        }

This method may raise:

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

[Source]

    # File net/smtp.rb, line 463
        def open_message_stream( from_addr, *to_addrs, &block ) # :yield: stream

          send0(from_addr, to_addrs.flatten) {
            @socket.write_message_by_block(&block)
          }
        end

ready( from_addr, *to_addrs )

Alias for open_message_stream

[Validate]