indexing
description: "Objects that handle the retrieving of data"
legal: "See notice at end of class."
status: "See notice at end of class."
author: "david"
date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
revision: "$Revision: 56675 $"
deferred class interface
RETRIEVING_PROTOCOL
feature
code_number: INTEGER_32
EMAIL_PROTOCOL
default_port: INTEGER_32
EMAIL_PROTOCOL
generating_type: STRING_8
ANY
generator: STRING_8
ANY
header (h: STRING_8): HEADER
EMAIL_RESOURCE
headers: HASH_TABLE [HEADER, STRING_8]
EMAIL_RESOURCE
hostname: STRING_8
EMAIL_PROTOCOL
feature
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure 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
`some'`other'
ANY
ensure 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
`other'
ANY
require ANY
other_not_void: other /= Void
ensure 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
`some'`other'
ANY
ensure 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
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature
can_receive: BOOLEAN
EMAIL_RESOURCE
can_send: BOOLEAN
EMAIL_RESOURCE
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
error: BOOLEAN
EMAIL_RESOURCE
is_connected: BOOLEAN
EMAIL_PROTOCOL
is_header_valid: BOOLEAN
EMAIL_RESOURCE
is_initiated: BOOLEAN
EMAIL_RESOURCE
same_type (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
transfer_error: TRANSFER_ERROR
EMAIL_RESOURCE
feature
disable_initiated
EMAIL_RESOURCE
disable_transfer_error
EMAIL_RESOURCE
enable_initiated
EMAIL_RESOURCE
enable_transfer_error
EMAIL_RESOURCE
set_transfer_error_message (s: STRING_8)
EMAIL_RESOURCE
feature
copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
copy`other'deep_twin
ANY
require ANY
other_not_void: other /= Void
ensure ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
ANY
ensure ANY
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
`other'
ANY
ensure ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
`Current'
twincopycopy
ANY
ensure ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature
close_protocol
EMAIL_PROTOCOL
require PROTOCOL_RESOURCE
is_initiated: is_initiated
ensure PROTOCOL_RESOURCE
protocol_not_initiated: not is_initiated
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
execute_transfer
initiate_protocol
EMAIL_PROTOCOL
ensure PROTOCOL_RESOURCE
protocol_initiated: is_initiated
transfer (resource: EMAIL_RESOURCE)
EMAIL_RESOURCE
require 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
ack_begin_connection: INTEGER_32 is 220
EMAIL_CONSTANTS
ack_end_connection: INTEGER_32 is 221
EMAIL_CONSTANTS
data: STRING_8 is "DATA"
EMAIL_CONSTANTS
data_code: INTEGER_32 is 354
EMAIL_CONSTANTS
ehlo: STRING_8 is "EHLO "
EMAIL_CONSTANTS
helo: STRING_8 is "HELO "
EMAIL_CONSTANTS
mail_bcc: STRING_8 is "RCPT BCC:"
EMAIL_CONSTANTS
mail_cc: STRING_8 is "RCPT CC:"
EMAIL_CONSTANTS
mail_from: STRING_8 is "MAIL FROM: "
EMAIL_CONSTANTS
mail_reply_to: STRING_8 is "RCPT REPLY TO:"
EMAIL_CONSTANTS
mail_to: STRING_8 is "RCPT TO: "
EMAIL_CONSTANTS
no_valid_recipient: INTEGER_32 is 554
EMAIL_CONSTANTS
ok: INTEGER_32 is 250
EMAIL_CONSTANTS
quit: STRING_8 is "QUIT"
EMAIL_CONSTANTS
remote_error: INTEGER_32 is 550
EMAIL_CONSTANTS
size_error: INTEGER_32 is 500
EMAIL_CONSTANTS
struct_error: INTEGER_32 is 552
EMAIL_CONSTANTS
feature
default_headers: ARRAY [STRING_8]
EMAIL_CONSTANTS
h_bcc: STRING_8 is "Bcc"
EMAIL_CONSTANTS
h_cc: STRING_8 is "Cc"
EMAIL_CONSTANTS
h_from: STRING_8 is "From"
EMAIL_CONSTANTS
h_reply_to: STRING_8 is "Reply-to"
EMAIL_CONSTANTS
h_subject: STRING_8 is "Subject"
EMAIL_CONSTANTS
h_to: STRING_8 is "To"
EMAIL_CONSTANTS
feature
can_be_received: BOOLEAN is False
PROTOCOL_RESOURCE
can_be_sent: BOOLEAN is False
PROTOCOL_RESOURCE
feature
io: STD_FILES
ANY
out: STRING_8
ANYtagged_out
ANY
print (some: ANY)
`some'
ANY
frozen tagged_out: STRING_8
ANYout
ANY
feature
operating_environment: OPERATING_ENVIRONMENT
ANY
feature
disable_connected
EMAIL_PROTOCOL
enable_connected
EMAIL_PROTOCOL
set_default_port (new_port: INTEGER_32)
EMAIL_PROTOCOL
invariant
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 RETRIEVING_PROTOCOL