    indexing
    	description: "Implementation of SMTP protocol."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
    	revision: "$Revision: 56675 $"

    class interface
    	SMTP_PROTOCOL

    create
    	make (host: STRING_8; user: STRING_8)
    			-- Create an smtp protocol with 'host, 'user' and default port.
    		require
    			host_not_void: host /= Void
    			user_not_void: user /= Void
    		ensure
    			hostname_set: hostname = host
    			username_set: username = user
    			port_set: port = default_port

    feature -- Initialization

    	make (host: STRING_8; user: STRING_8)
    			-- Create an smtp protocol with 'host, 'user' and default port.
    		require
    			host_not_void: host /= Void
    			user_not_void: user /= Void
    		ensure
    			hostname_set: hostname = host
    			username_set: username = user
    			port_set: port = default_port

    feature -- Access

    	smtp_code_number: INTEGER_32
    			-- Last error code received from server.
    			-- (from EMAIL_PROTOCOL)

    	generating_type: STRING_8
    			-- Name of current object's generating type
    			-- (type of which it is a direct instance)
    			-- (from ANY)

    	generator: STRING_8
    			-- Name of current object's generating class
    			-- (base class of the type of which it is a direct instance)
    			-- (from ANY)

    	header (h: STRING_8): HEADER
    			-- Retrieve the content of the header 'h'
    			-- (from EMAIL_RESOURCE)

    	headers: HASH_TABLE [HEADER, STRING_8]
    			-- All information concerning each headers
    			-- (from EMAIL_RESOURCE)

    	hostname: STRING_8
    			-- hostname .. ex: smtp
    			-- (from EMAIL_PROTOCOL)

    	memory_resource: MEMORY_RESOURCE
    			-- Memory resource to be send
    			-- (from SENDING_PROTOCOL)

    	pipelining: BOOLEAN
    			-- Does the connection use pipeline?

    	smtp_reply: STRING_8
    			-- Replied message from SMTP protocol

    feature -- Comparison

    	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void
    			-- or attached to isomorphic object structures?
    			-- (from ANY)
    		ensure -- from ANY
    			shallow_implies_deep: standard_equal (some, other) implies Result
    			both_or_none_void: (some = Void) implies (Result = (other = Void))
    			same_type: (Result and (some /= Void)) implies some.same_type (other)
    			symmetric: Result implies deep_equal (other, some)

    	frozen equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void or attached
    			-- to objects considered equal?
    			-- (from ANY)
    		ensure -- from ANY
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

    	is_equal (other: like Current): BOOLEAN
    			-- Is `other' attached to an object considered
    			-- equal to current object?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			symmetric: Result implies other.is_equal (Current)
    			consistent: standard_is_equal (other) implies Result

    	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void or attached to
    			-- field-by-field identical objects of the same type?
    			-- Always uses default object comparison criterion.
    			-- (from ANY)
    		ensure -- from ANY
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

    	frozen standard_is_equal (other: like Current): BOOLEAN
    			-- Is `other' attached to an object of the same type
    			-- as current object, and field-by-field identical to it?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			same_type: Result implies same_type (other)
    			symmetric: Result implies other.standard_is_equal (Current)

    feature -- Status report

    	conforms_to (other: ANY): BOOLEAN
    			-- Does type of current object conform to type
    			-- of `other' (as per Eiffel: The Language, chapter 13)?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void

    	error: BOOLEAN
    			-- Is there an error?
    			-- (from EMAIL_RESOURCE)

    	is_connected: BOOLEAN
    			-- Is the connection done?
    			-- (from EMAIL_PROTOCOL)

    	is_header_valid: BOOLEAN
    			-- Is the email resource's header valid?
    			-- (from EMAIL_RESOURCE)

    	is_initiated: BOOLEAN
    			-- Has the connection has been initiated?
    			-- (from EMAIL_RESOURCE)

    	same_type (other: ANY): BOOLEAN
    			-- Is type of current object identical to type of `other'?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			definition: Result = (conforms_to (other) and other.conforms_to (Current))

    	transfer_error: TRANSFER_ERROR
    			-- Transfer error handling
    			-- (from EMAIL_RESOURCE)

    feature -- Status setting

    	disable_initiated
    			-- Unset is_initiated.
    			-- (from EMAIL_RESOURCE)

    	disable_transfer_error
    			-- Disable transfer error.
    			-- (from EMAIL_RESOURCE)

    	enable_initiated
    			-- Set is_initiated.
    			-- (from EMAIL_RESOURCE)

    	enable_transfer_error
    			-- Enable transfer error.
    			-- (from EMAIL_RESOURCE)

    	set_transfer_error_message (s: STRING_8)
    			-- Set transfer error message to 's'.
    			-- (from EMAIL_RESOURCE)

    feature -- Duplication

    	copy (other: like Current)
    			-- Update current object using fields of object attached
    			-- to `other', so as to yield equal objects.
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_equal: is_equal (other)

    	frozen deep_copy (other: like Current)
    			-- Effect equivalent to that of:
    			--		copy (`other' . deep_twin)
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, other)

    	frozen deep_twin: like Current
    			-- New object structure recursively duplicated from Current.
    			-- (from ANY)
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, Result)

    	frozen standard_copy (other: like Current)
    			-- Copy every field of `other' onto corresponding field
    			-- of current object.
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_standard_equal: standard_is_equal (other)

    	frozen standard_twin: like Current
    			-- New object field-by-field identical to `other'.
    			-- Always uses default copying semantics.
    			-- (from ANY)
    		ensure -- from ANY
    			standard_twin_not_void: Result /= Void
    			equal: standard_equal (Result, Current)

    	frozen twin: like Current
    			-- New object equal to `Current'
    			-- twin calls copy; to change copying/twining semantics, redefine copy.
    			-- (from ANY)
    		ensure -- from ANY
    			twin_not_void: Result /= Void
    			is_equal: Result.is_equal (Current)

    feature -- Basic operations

    	frozen default: like Current
    			-- Default value of object's type
    			-- (from ANY)

    	frozen default_pointer: POINTER
    			-- Default value of type `POINTER'
    			-- (Avoid the need to write `p'.default for
    			-- some `p' of type `POINTER'.)
    			-- (from ANY)

    	default_rescue
    			-- Process exception for routines with no Rescue clause.
    			-- (Default: do nothing.)
    			-- (from ANY)

    	frozen do_nothing
    			-- Execute a null action.
    			-- (from ANY)

    feature -- Access EMAIL_PROTOCOL

    	default_port: INTEGER_32 is 25
    			-- Smtp default port

    feature -- Basic operations.

    	close_protocol
    			-- Terminate the connection.
    		require -- from PROTOCOL_RESOURCE
    			is_initiated: is_initiated
    		require else
    			connection_exists: is_connected
    		ensure -- from PROTOCOL_RESOURCE
    			protocol_not_initiated: not is_initiated

    	initiate_protocol
    			-- Initiate the smtp connection
    			-- It can be a helo or a ehlo connection.
    		require -- from  PROTOCOL_RESOURCE
    			True
    		ensure -- from PROTOCOL_RESOURCE
    			protocol_initiated: is_initiated

    feature -- Constants for SMTP Protocol

    	ack_begin_connection: INTEGER_32 is 220
    			-- (from EMAIL_CONSTANTS)

    	ack_end_connection: INTEGER_32 is 221
    			-- (from EMAIL_CONSTANTS)

    	data: STRING_8 is "DATA"
    			-- (from EMAIL_CONSTANTS)

    	data_code: INTEGER_32 is 354
    			-- (from EMAIL_CONSTANTS)

    	ehlo: STRING_8 is "EHLO "
    			-- (from EMAIL_CONSTANTS)

    	helo: STRING_8 is "HELO "
    			-- (from EMAIL_CONSTANTS)

    	mail_bcc: STRING_8 is "RCPT BCC:"
    			-- (from EMAIL_CONSTANTS)

    	mail_cc: STRING_8 is "RCPT CC:"
    			-- (from EMAIL_CONSTANTS)

    	mail_from: STRING_8 is "MAIL FROM: "
    			-- (from EMAIL_CONSTANTS)

    	mail_reply_to: STRING_8 is "RCPT REPLY TO:"
    			-- (from EMAIL_CONSTANTS)

    	mail_to: STRING_8 is "RCPT TO: "
    			-- (from EMAIL_CONSTANTS)

    	no_valid_recipient: INTEGER_32 is 554
    			-- (from EMAIL_CONSTANTS)

    	ok: INTEGER_32 is 250
    			-- (from EMAIL_CONSTANTS)

    	quit: STRING_8 is "QUIT"
    			-- (from EMAIL_CONSTANTS)

    	remote_error: INTEGER_32 is 550
    			-- (from EMAIL_CONSTANTS)

    	size_error: INTEGER_32 is 500
    			-- (from EMAIL_CONSTANTS)

    	struct_error: INTEGER_32 is 552
    			-- (from EMAIL_CONSTANTS)

    feature -- Constants for email headers (Authorized keys for the Hashtables)

    	default_headers: ARRAY [STRING_8]
    			-- (from EMAIL_CONSTANTS)

    	h_bcc: STRING_8 is "Bcc"
    			-- (from EMAIL_CONSTANTS)

    	h_cc: STRING_8 is "Cc"
    			-- (from EMAIL_CONSTANTS)

    	h_from: STRING_8 is "From"
    			-- (from EMAIL_CONSTANTS)

    	h_reply_to: STRING_8 is "Reply-to"
    			-- (from EMAIL_CONSTANTS)

    	h_subject: STRING_8 is "Subject"
    			-- (from EMAIL_CONSTANTS)

    	h_to: STRING_8 is "To"
    			-- (from EMAIL_CONSTANTS)

    feature -- Implemantation (EMAIL_RESOURCE)

    	can_send: BOOLEAN is True
    			--Can a sending protocol send?
    			-- (from SENDING_PROTOCOL)

    feature -- Implementation (EMAIL_RESOURCE)

    	can_be_received: BOOLEAN is False
    			-- Can a protocol be received?
    			-- (from PROTOCOL_RESOURCE)

    	can_be_sent: BOOLEAN is False
    			-- Can a protocol resource be send?
    			-- (from PROTOCOL_RESOURCE)

    	can_receive: BOOLEAN is False
    			-- Can the Smtp protocolreceive?

    	initialize
    			-- Initialize the protocol to send a new email.

    feature -- Implementation (EMAIL_RESOURCE).

    	transfer (resource: MEMORY_RESOURCE)
    			-- Send the email and add a %R%N. at the end of the message.
    		require -- from EMAIL_RESOURCE
    			resource_exists: resource /= Void
    			is_valid_transfer: (resource.can_be_sent and can_send) or (resource.can_receive and can_be_received)
    			connection_is_initiated: (can_be_sent and resource.is_initiated) or (is_initiated and resource.can_be_received)

    feature -- Output

    	io: STD_FILES
    			-- Handle to standard file setup
    			-- (from ANY)

    	out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of tagged_out.
    			-- (from ANY)

    	print (some: ANY)
    			-- Write terse external representation of `some'
    			-- on standard output.
    			-- (from ANY)

    	frozen tagged_out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of out.
    			-- (from ANY)

    feature -- Platform

    	operating_environment: OPERATING_ENVIRONMENT
    			-- Objects available from the operating system
    			-- (from ANY)

    feature -- Setting

    	disable_pipelining
    			-- Unset pipelining.
    		ensure
    			pipelining_set: not pipelining

    	enable_pipelining
    			-- Set pipelining.
    		ensure
    			pipelining_set: pipelining

    feature -- Settings

    	disable_connected
    			-- Unset is_connected.
    			-- (from EMAIL_PROTOCOL)

    	enable_connected
    			-- Set is_connected.
    			-- (from EMAIL_PROTOCOL)

    	set_default_port (new_port: INTEGER_32)
    			-- Set the default port to 'new_port'.
    			-- (from EMAIL_PROTOCOL)

    invariant
    		-- from ANY
    	reflexive_equality: standard_is_equal (Current)
    	reflexive_conformance: conforms_to (Current)

    indexing
    	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
    	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
    	source: "[
    		Eiffel Software
    		356 Storke Road, Goleta, CA 93117 USA
    		Telephone 805-685-1006, Fax 805-685-6869
    		Website http://www.eiffel.com
    		Customer support http://support.eiffel.com
    	]"

    end -- class SMTP_PROTOCOL