SAP ABAP Class CL_SMTP_CLIENT (SMTP Client Control Block)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RFC (Application Component) RFC
     ⤷ SSMTP (Package) Development Class for SMTP Communication

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SMTP_CLIENT	HTTP Client Abstraction	20000803

Properties

Class	CL_SMTP_CLIENT
Short Description	SMTP Client Control Block
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SSMTP	Development Class for SMTP Communication
Created	20000620	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	ISMTP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SMTP_CLIENT	☐	☐	HTTP Client Abstraction	20000803

Friends

Class CL_SMTP_CLIENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_AUTHENTICATE_TRIAL	Static Attribute	Public	☐	Type reference (TYPE)	I	3	Number of Logon Attempts	20000620
2	C_CLIENT_KERNEL_VERSION	Static Attribute	Private	☐	Type reference (TYPE)	I		Client Kernel Version	20120626
3	C_SAPGUI_IS_ON	Static Attribute	Private	☐	Type reference (TYPE)	I		Is GUI active?	20000620
4	ECODE_DESTINATION_NOT_FOUND	Static Attribute	Public	☐	Type reference (TYPE)	I	1001	Error Code: Destination Not Found	20000620
5	ECODE_NAME_TOO_LONG	Static Attribute	Public	☐	Type reference (TYPE)	I	1001	Error Code: Connection Name Too Long	20000620
6	HTTP_INVALID_STATE_ERROR	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	1001	Exception Status: HTTP_INVALID_STATE	20000620
7	HTTP_NO_OPEN_CONNECTION_ERROR	Constant	Public	☐	Type reference (TYPE)	SYSUBRC	1002	Exception Status: HTTP_NO_OPEN_CONNECTION	20000620
8	M_AUTH_TRIAL	Instance attribute	Public	☐	Type reference (TYPE)	I		Number of Logon Attempts	20000620
9	M_CONNECTION	Static Attribute	Private	☐	Type reference (TYPE)	SYSUUID_C		Connection ID (Unique Across All Internal Sessions)	20000620
10	M_ECODE	Instance attribute	Private	☐	Type reference (TYPE)	SYSUBRC		Error Code	20000620
11	M_EMESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Error Message	20000620
12	M_HOST	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Host Name of Server	20000620
13	M_LAST_RESPONSE_CODE	Instance attribute	Public	☐	Type reference (TYPE)	I		Last Response Status Code	20000620
14	M_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Object Name	20000620
15	M_PATCH	Instance attribute	Public	☐	Type reference (TYPE)	I		Support Package	20000620
16	M_PROXY_HOST	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Host Name of Server	20000620
17	M_PROXY_SERVICE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Host Name of Server	20000620
18	M_RESPONSE	Instance attribute	Public	☐	Type reference (TYPE)	XSTRING		raw response data	20000804
19	M_SCHEME	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1		Scheme (HTTP/HTTPS)	20000620
20	M_SERVICE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Service Number of Server	20000620
21	M_STATE	Instance attribute	Private	☐	Type reference (TYPE)	I		Status of Communication	20000620
22	REQUEST	Instance attribute	Private	☐	Attribute reference (LIKE)				20001117
23	RESPONSE	Instance attribute	Private	☐	Attribute reference (LIKE)				20001117
24	SCHEMETYPE_HTTP	Static Attribute	Public	☑	Type reference (TYPE)	CHAR1	'1'	HTTP Protocol	20000620
25	SCHEMETYPE_HTTPS	Static Attribute	Public	☑	Type reference (TYPE)	CHAR1	'2'	HTTP Protocol	20000620
26	SMTP_CLIENT_INSTANCES	Static Attribute	Private	☐	Type reference (TYPE)	ISMTP_CLIENT_INSTANCES		Natural Number	20010302
27	STATETYPE_CLOSE	Static Attribute	Public	☑	Type reference (TYPE)	I	3	Close Status	20000620
28	STATETYPE_ERROR	Static Attribute	Public	☑	Type reference (TYPE)	I	1	Send Status	20000620
29	STATETYPE_INITIAL	Static Attribute	Public	☑	Type reference (TYPE)	I	-1	Initial Status	20000620
30	STATETYPE_RECEIVE	Static Attribute	Public	☑	Type reference (TYPE)	I	2	Receive Status	20000620
31	STATETYPE_SEND	Static Attribute	Public	☑	Type reference (TYPE)	I	4	Error Status	20000620
32	STATISTIC_TABLE	Static Attribute	Private	☐	Type reference (TYPE)	ICF_STAT		Statistics for Internet Communication Framework	20000620
33	STATISTIC_WA	Static Attribute	Private	☐	Type reference (TYPE)	ICFSTAT		Statistics for Internet Communication Framework	20000620
34	VERSION	Instance attribute	Private	☐	Attribute reference (LIKE)				20001117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AUTHENTICATION	Instance method	Public	Method	Logon data	20000620
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20000620
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000620
4	CREATE	Static method	Public	Method	Creation of new IF_HTTP_Client object	20000620
5	CREATE_BY_DESTINATION	Static method	Public	Method	Creation of new IF_HTTP_Client object	20000620
6	GET_LAST_ERROR	Instance method	Private	Method		20001117
7	IS_SMTP_AUTH_IMPLEMENTED	Static method	Public	Method	Specifies whether the SMTP auth. is implemented in kernel	20120730
8	SEND	Instance method	Private	Method		20001117
9	SEND_REQUEST	Instance method	Public	Method	Call	20000620
10	SET_REQUEST_ORIGINATOR	Instance method	Private	Method		20001117
11	SET_RESPONSE_ORIGINATOR	Instance method	Private	Method		20001117
12	STATISTIC_BEGIN	Static method	Public	Method	Internal / do not use!	20000620
13	STATISTIC_END	Static method	Public	Method	Internal / do not use!	20000620
14	STATISTIC_EXPORT	Static method	Public	Method	Internal / do not use!	20000620
15	_APPEND_STRING_TO_XSTRING	Static method	Public	Method	Internal / do not use!	20000620
16	_APPEND_XSTRING_TO_STRING	Static method	Public	Method	Internal / do not use!	20000620

Events

Class CL_SMTP_CLIENT has no event.

Types

Class CL_SMTP_CLIENT has no local type.

Method Signatures

Method AUTHENTICATION Signature

Method AUTHENTICATION on class CL_SMTP_CLIENT has no parameter.
Method AUTHENTICATION on class CL_SMTP_CLIENT has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SMTP_CLIENT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SMTP_CLIENT has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SMTP_CLIENT has no parameter.
Method CONSTRUCTOR on class CL_SMTP_CLIENT has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SMTP_CLIENT		HTTP Client Abstraction	20000620
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		logische Destination (Wird bei Funktionsaufruf angegeben)	20000620
3	Importing	PROXY_HOST	Call by reference	☑	Type reference (TYPE)	STRING		logische Destination (Wird bei Funktionsaufruf angegeben)	20000620
4	Importing	PROXY_SERVICE	Call by reference	☑	Type reference (TYPE)	STRING		Portnummer	20000620
5	Importing	SERVICE	Call by reference	☐	Type reference (TYPE)	STRING		Portnummer	20000620

#	Exception	Resumable	Description	Created on
1	ARGUMENT_NOT_FOUND	☐	Verbindungsparmaeter (host oder service) nicht verfügbar	20000620
2	INTERNAL_ERROR	☐	Interner Fehler ( z. B. name zu groß)	20000620

Method CREATE_BY_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20000620
2	Importing	DESTINATION	Call by reference	☑	Type reference (TYPE)	RFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20000620
3	Importing	SCHEME	Call by reference	☐	Type reference (TYPE)	CHAR1	SCHEMETYPE_HTTP	HTTP/HTTPS	20000620

#	Exception	Resumable	Description	Created on
1	ARGUMENT_NOT_FOUND	☐	Verbindungsparmaeter (Destination) nicht verfügbar	20000620
2	DESTINATION_NOT_FOUND	☐	Destination ist nicht fefunden	20000620
3	DESTINATION_NO_AUTHORITY	☐	Keine Berechtigung zur Verwendung der HTTP-Destination	20000620
4	INTERNAL_ERROR	☐	Interner Fehler ( z. B. name zu groß)	20000620

Method GET_LAST_ERROR Signature

Method GET_LAST_ERROR on class CL_SMTP_CLIENT has no parameter.
Method GET_LAST_ERROR on class CL_SMTP_CLIENT has no exception.

Method IS_SMTP_AUTH_IMPLEMENTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_IMPLEMENTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		ob die SMTP Auth implementiert ist	20120730

Method IS_SMTP_AUTH_IMPLEMENTED on class CL_SMTP_CLIENT has no exception.

Method SEND Signature

Method SEND on class CL_SMTP_CLIENT has no parameter.
Method SEND on class CL_SMTP_CLIENT has no exception.

Method SEND_REQUEST Signature

Method SEND_REQUEST on class CL_SMTP_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	COMMUNICATION_ERROR	☐	Kommunikationsfehler	20000620

Method SET_REQUEST_ORIGINATOR Signature

Method SET_REQUEST_ORIGINATOR on class CL_SMTP_CLIENT has no parameter.
Method SET_REQUEST_ORIGINATOR on class CL_SMTP_CLIENT has no exception.

Method SET_RESPONSE_ORIGINATOR Signature

Method SET_RESPONSE_ORIGINATOR on class CL_SMTP_CLIENT has no parameter.
Method SET_RESPONSE_ORIGINATOR on class CL_SMTP_CLIENT has no exception.

Method STATISTIC_BEGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TAG	Call by reference	☐	Type reference (TYPE)	CHAR64		Characterfeld der Länge 64	20000620

Method STATISTIC_BEGIN on class CL_SMTP_CLIENT has no exception.

Method STATISTIC_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TAG	Call by reference	☐	Type reference (TYPE)	CHAR64		Characterfeld der Länge 64	20000620

Method STATISTIC_END on class CL_SMTP_CLIENT has no exception.

Method STATISTIC_EXPORT Signature

Method STATISTIC_EXPORT on class CL_SMTP_CLIENT has no parameter.
Method STATISTIC_EXPORT on class CL_SMTP_CLIENT has no exception.

Method _APPEND_STRING_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DEST	Call by reference	☐	Type reference (TYPE)	XSTRING		dest	20000620
2	Importing	SOURCE	Call by reference	☐	Type reference (TYPE)	STRING		source	20000620

Method _APPEND_STRING_TO_XSTRING on class CL_SMTP_CLIENT has no exception.

Method _APPEND_XSTRING_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DEST	Call by reference	☐	Type reference (TYPE)	STRING		dest	20000620
2	Importing	SOURCE	Call by reference	☐	Type reference (TYPE)	XSTRING		source	20000620

Method _APPEND_XSTRING_TO_STRING on class CL_SMTP_CLIENT has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	50A