Automatic generation produced by ISE Eiffel
note description: "Implementation of SMTP protocol." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-06-25 04:16:34 -0800 (Fri, 25 Jun 2021) $" revision: "$Revision: 105580 $" class interface SMTP_PROTOCOL create make (host: READABLE_STRING_8; user: READABLE_STRING_8) -- Create an smtp protocol with 'host, 'user' and default port. require host_not_void: host /= Void host_not_empty: not host.is_empty user_not_void: user /= Void user_not_empty: not user.is_empty 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: TYPE [detachable SMTP_PROTOCOL] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty header (h: READABLE_STRING_8): detachable HEADER -- Retrieve the content of the header 'h' -- (from EMAIL_RESOURCE) headers: HASH_TABLE [HEADER, READABLE_STRING_8] -- All information concerning each headers -- (from EMAIL_RESOURCE) hostname: READABLE_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: detachable STRING_8 -- Replied message from SMTP protocol feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: SMTP_PROTOCOL): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: SMTP_PROTOCOL): 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 ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: SMTP_PROTOCOL): 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: SMTP_PROTOCOL) -- 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: Current ~ other frozen deep_copy (other: SMTP_PROTOCOL) -- 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: SMTP_PROTOCOL -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: SMTP_PROTOCOL) -- 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: SMTP_PROTOCOL -- 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: SMTP_PROTOCOL -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable SMTP_PROTOCOL -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class send_mail -- Send mail using smtp protocol. require -- from SENDING_PROTOCOL connection_exists: is_connected connection_initiated: is_initiated valid_headers: memory_resource.can_be_sent feature -- Access EMAIL_PROTOCOL Default_port: INTEGER_32 = 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 = 220 -- (from EMAIL_CONSTANTS) Ack_end_connection: INTEGER_32 = 221 -- (from EMAIL_CONSTANTS) Data: STRING_8 = "DATA" -- (from EMAIL_CONSTANTS) Data_code: INTEGER_32 = 354 -- (from EMAIL_CONSTANTS) Ehlo: STRING_8 = "EHLO " -- (from EMAIL_CONSTANTS) Helo: STRING_8 = "HELO " -- (from EMAIL_CONSTANTS) Mail_bcc: STRING_8 = "RCPT BCC:" -- (from EMAIL_CONSTANTS) Mail_cc: STRING_8 = "RCPT CC:" -- (from EMAIL_CONSTANTS) Mail_from: STRING_8 = "MAIL FROM: " -- (from EMAIL_CONSTANTS) Mail_reply_to: STRING_8 = "RCPT REPLY TO:" -- (from EMAIL_CONSTANTS) Mail_to: STRING_8 = "RCPT TO: " -- (from EMAIL_CONSTANTS) No_valid_recipient: INTEGER_32 = 554 -- (from EMAIL_CONSTANTS) Ok: INTEGER_32 = 250 -- (from EMAIL_CONSTANTS) Quit: STRING_8 = "QUIT" -- (from EMAIL_CONSTANTS) Remote_error: INTEGER_32 = 550 -- (from EMAIL_CONSTANTS) Size_error: INTEGER_32 = 500 -- (from EMAIL_CONSTANTS) Struct_error: INTEGER_32 = 552 -- (from EMAIL_CONSTANTS) feature -- Constants for email headers (Authorized keys for the Hashtables) H_bcc: STRING_8 = "Bcc" -- (from EMAIL_CONSTANTS) H_cc: STRING_8 = "Cc" -- (from EMAIL_CONSTANTS) H_date: STRING_8 = "Date" -- (from EMAIL_CONSTANTS) H_from: STRING_8 = "From" -- (from EMAIL_CONSTANTS) H_reply_to: STRING_8 = "Reply-to" -- (from EMAIL_CONSTANTS) H_subject: STRING_8 = "Subject" -- (from EMAIL_CONSTANTS) H_to: STRING_8 = "To" -- (from EMAIL_CONSTANTS) feature -- Implemantation (EMAIL_RESOURCE) Can_send: BOOLEAN = True --Can a sending protocol send? -- (from SENDING_PROTOCOL) feature -- Implementation (EMAIL_RESOURCE) Can_be_received: BOOLEAN = False -- Can a protocol be received? -- (from PROTOCOL_RESOURCE) Can_be_sent: BOOLEAN = False -- Can a protocol resource be send? -- (from PROTOCOL_RESOURCE) Can_receive: BOOLEAN = 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) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void 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) note copyright: "Copyright (c) 1984-2021, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., 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 -- Generated by Eiffel Studio --
For more details: eiffel.org