#
# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This file is part of Ronin Support.
#
# Ronin Support is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin Support is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
#

require 'ronin/network/pop3'

require 'net/pop'

module Net
  #
  # Creates a connection to the POP3 server.
  #
  # @param [String] host
  #   The host to connect to.
  #
  # @param [Hash] options
  #   Additional options.
  #
  # @option options [Integer] :port (Ronin::Network::POP3.default_port)
  #   The port the POP3 server is running on.
  #
  # @option options [String] :user
  #   The user to authenticate with when connecting to the POP3 server.
  #
  # @option options [String] :password
  #   The password to authenticate with when connecting to the POP3 server.
  #
  # @yield [session]
  #   If a block is given, it will be passed the newly created POP3 session.
  #
  # @yieldparam [Net::POP3] session
  #   The newly created POP3 session.
  #
  # @return [Net::POP3]
  #   The newly created POP3 session.
  #
  # @api public
  #
  def Net.pop3_connect(host,options={})
    host = host.to_s
    port = (options[:port] || Ronin::Network::POP3.default_port)
    user = options[:user]
    password = options[:password]

    session = Net::POP3.start(host,port,user,password)

    yield session if block_given?
    return session
  end

  #
  # Starts a session with the POP3 server.
  #
  # @param [String] host
  #   The host to connect to.
  #
  # @param [Hash] options
  #   Additional options.
  #
  # @yield [session]
  #   If a block is given, it will be passed the newly created POP3 session.
  #   After the block has returned, the session will be closed.
  #
  # @yieldparam [Net::POP3] session
  #   The newly created POP3 session.
  #
  # @return [nil]
  #
  # @api public
  #
  def Net.pop3_session(host,options={})
    session = Net.pop3_connect(host,options)

    yield session if block_given?

    session.finish
    return nil
  end
end