SAP ABAP Class CL_BCS_MESSAGE (BCS: Send Message)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-COM (Application Component) Communication Services: Mail, Fax, SMS, Telephony
     ⤷ SBCS_SEND (Package) BCS: Send Interface

Properties

Class	CL_BCS_MESSAGE
Short Description	BCS: Send Message
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SBCS_SEND	BCS: Send Interface
Created	20081014	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ABAP_CHAR_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_BCS_MESSAGE has no interface implemented.

Friends

Class CL_BCS_MESSAGE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ALWAYS	Constant	Public	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS	'A'	Status: Always	20090206
2	GC_BCC	Constant	Public	☐	Type reference (TYPE)	BCS_COPY	'B'	Blind Copy (BCC)	20090127
3	GC_CC	Constant	Public	☐	Type reference (TYPE)	BCS_COPY	'C'	Copy Recipients (CC)	20090127
4	GC_DELIVER	Constant	Public	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS	'D'	Status: When transferred	20090206
5	GC_DISCL_ADD_AS_MAIN	Constant	Public	☐	Type reference (TYPE)	BCS_DISCLOSURE	2	Insert Disclosures as New Main Document	20090127
6	GC_DISCL_ADD_TO_MAIN	Constant	Public	☐	Type reference (TYPE)	BCS_DISCLOSURE	1	Insert Disclosures in Main Document (if possible)	20090127
7	GC_DISCL_ALREADY_ADDED	Constant	Public	☐	Type reference (TYPE)	BCS_DISCLOSURE	3	Disclosures Already Inserted	20090127
8	GC_DISCL_NOT_SET	Constant	Public	☐	Type reference (TYPE)	BCS_DISCLOSURE	0	Not set	20090127
9	GC_ERROR	Constant	Public	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS	'E'	Status: Only if errors occur	20090206
10	GC_IMPORTANCE_HIGH	Constant	Public	☐	Type reference (TYPE)	BCS_IMPORTANCE	'H'	E-Mail Attribute Importance	20090127
11	GC_IMPORTANCE_LOW	Constant	Public	☐	Type reference (TYPE)	BCS_IMPORTANCE	'L'	E-Mail Attribute Importance	20090127
12	GC_IMPORTANCE_NORMAL	Constant	Public	☐	Type reference (TYPE)	BCS_IMPORTANCE	'N'	E-Mail Attribute Importance	20090127
13	GC_NEVER	Constant	Public	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS	'N'	Status: Never	20090206
14	GC_READ	Constant	Public	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS	'R'	Status: When read	20090206
15	GC_SENS_COMPANY	Constant	Public	☐	Type reference (TYPE)	BCS_SENSITIVITY	'C'	Company Confidential	20090127
16	GC_SENS_PERSONAL	Constant	Public	☐	Type reference (TYPE)	BCS_SENSITIVITY	'E'	Personal	20090127
17	GC_SENS_PRIVATE	Constant	Public	☐	Type reference (TYPE)	BCS_SENSITIVITY	'P'	Private	20090127
18	MO_INTERN	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BCS_MSG_INTERN		Send Message (Internal Use)	20090127

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTACHMENT	Instance method	Public	Method	Add Attachment	20090127
2	ADD_RECIPIENT	Instance method	Public	Method	Add Recipients	20090203
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20090127
4	SEND	Instance method	Public	Method	Send Message	20090127
5	SET_ALT_DOC	Instance method	Public	Method	Set Alternative Document	20090127
6	SET_DISCLOSURE	Instance method	Public	Method	Insert Disclosure (See Constants, Defaul 0)	20090127
7	SET_ENCRYPT	Instance method	Public	Method	Request External Encryption (3rd Party required)	20090127
8	SET_IMPORTANCE	Instance method	Public	Method	Set Importance (See Constants, Default = Normal)	20090127
9	SET_LANGUAGE	Instance method	Public	Method	Set Language (Default sy-langu)	20090127
10	SET_MAIN_DOC	Instance method	Public	Method	Set Main Document	20090127
11	SET_REPLY_TO	Instance method	Public	Method	Set Response Recipient (Default: Empty)	20090127
12	SET_REQUESTED_STATUS	Instance method	Public	Method	Set Status Request (N,E,A; Default = All)	20090127
13	SET_SENDER	Instance method	Public	Method	Set Sender (Optional, Default is current user)	20090127
14	SET_SEND_IMMEDIATELY	Instance method	Public	Method	Send Immediately	20090127
15	SET_SENSITIVITY	Instance method	Public	Method	Set Sensitivity (See Constants, Default space)	20090127
16	SET_SIGN	Instance method	Public	Method	Request External Signature (3rd party required)	20090127
17	SET_STATUS_MAIL	Instance method	Public	Method	Request Status Mail (N,E,A; Default = Only if errors occur)	20090127
18	SET_SUBJECT	Instance method	Public	Method	Set Subject	20090127
19	SET_UPDATE_TASK	Instance method	Public	Method	Send to Update	20090203
20	SET_VSI_PROFILE	Instance method	Public	Method	Set Virus Scan Profile (Default: Empty)	20120723
21	SHOW_SEND_LOG	Instance method	Public	Method	Display Send Log	20090203

Events

Class CL_BCS_MESSAGE has no event.

Types

Class CL_BCS_MESSAGE has no local type.

Method Signatures

Method ADD_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CODEPAGE	Call by reference	☑	Type reference (TYPE)	BCS_CODEPAGE		Zeichensatz eines Dokuments	20090127
2	Importing	IV_CONTENTS_BIN	Call by reference	☑	Type reference (TYPE)	XSTRING		Binärer Dokumenteninhalt	20090127
3	Importing	IV_CONTENTS_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Textueller Dokumenteninhalt	20090127
4	Importing	IV_CONTENT_ID	Call by reference	☑	Type reference (TYPE)	BCS_CONTENT_ID		Bodypart Content ID (für Related Bodyparts)	20090127
5	Importing	IV_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	BCS_DESCRIPTION		Kurze Beschreibung des Inhaltes	20090127
6	Importing	IV_DOCTYPE	Call by reference	☑	Type reference (TYPE)	BCS_DOCTYPE		Dokumententyp	20090127
7	Importing	IV_FILENAME	Call by reference	☑	Type reference (TYPE)	BCS_FILENAME		Dateiname (mit Erweiterung)	20090127

Method ADD_ATTACHMENT on class CL_BCS_MESSAGE has no exception.

Method ADD_RECIPIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS	Call by reference	☐	Type reference (TYPE)	BCS_ADDRESS		Kommunikationsadresse (für INT, FAX, SMS...)	20090203
2	Importing	IV_COMMTYPE	Call by reference	☐	Type reference (TYPE)	BCS_COMMTYPE	'INT'	Kommunikationsart	20090203
3	Importing	IV_COPY	Call by reference	☑	Type reference (TYPE)	BCS_COPY		Kopieempfänger (kein, CC, BCC)	20090203
4	Importing	IV_FAX_COUNTRY	Call by reference	☑	Type reference (TYPE)	BCS_FAX_COUNTRY		Land für Telefon-/Faxnummer	20090203
5	Importing	IV_VISIBLE_NAME	Call by reference	☑	Type reference (TYPE)	BCS_VISNAME		Anzeigename einer Adresse	20090203

Method ADD_RECIPIENT on class CL_BCS_MESSAGE has no exception.

Method CONSTRUCTOR Signature

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

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ERR_RECIPIENTS	Value transfer	☐	Type reference (TYPE)	BCST_REC_STATUS		Empfängertabelle mit Status	20090203

#	Exception	Resumable	Description	Created on
1	CX_BCS_SEND	☐	Ausnahmen Sendeschnittstelle	20090127

Method SET_ALT_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENTS_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Alternativdokument	20090127
2	Importing	IV_DOCTYPE	Call by reference	☐	Type reference (TYPE)	BCS_DOCTYPE	'txt'	Dokumententyp	20090127

Method SET_ALT_DOC on class CL_BCS_MESSAGE has no exception.

Method SET_DISCLOSURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DISCLOSURE	Value transfer	☐	Type reference (TYPE)	BCS_DISCLOSURE		Einstellung, ob Disclosure eingefügt werden soll	20090127

Method SET_DISCLOSURE on class CL_BCS_MESSAGE has no exception.

Method SET_ENCRYPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENCRYPT	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Boolean	20090127

Method SET_ENCRYPT on class CL_BCS_MESSAGE has no exception.

Method SET_IMPORTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IMPORTANCE	Call by reference	☑	Type reference (TYPE)	BCS_IMPORTANCE		E-Mail Attribut Importance	20090127

Method SET_IMPORTANCE on class CL_BCS_MESSAGE has no exception.

Method SET_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	BCS_LANGUAGE		Sprache, in der das Dokument angelegt wird	20090127

Method SET_LANGUAGE on class CL_BCS_MESSAGE has no exception.

Method SET_MAIN_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CODEPAGE	Call by reference	☑	Type reference (TYPE)	BCS_CODEPAGE		Zeichensatz eines Dokuments	20090127
2	Importing	IV_CONTENTS_BIN	Call by reference	☑	Type reference (TYPE)	XSTRING		Hauptdokument, 1. Bodypart (binär)	20090127
3	Importing	IV_CONTENTS_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Hauptdokument, 1. Bodypart	20090127
4	Importing	IV_DOCTYPE	Call by reference	☐	Type reference (TYPE)	BCS_DOCTYPE	'txt'	Dokumententyp	20090127

Method SET_MAIN_DOC on class CL_BCS_MESSAGE has no exception.

Method SET_REPLY_TO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Kommunikationsadresse (für INT, FAX, SMS...)	20090127
2	Importing	IV_COMMTYPE	Call by reference	☐	Type reference (TYPE)	BCS_COMMTYPE	'INT'	Kommunikationsart	20090127
3	Importing	IV_VISIBLE_NAME	Call by reference	☑	Type reference (TYPE)	BCS_VISNAME		Anzeigename einer Adresse	20090127

Method SET_REPLY_TO on class CL_BCS_MESSAGE has no exception.

Method SET_REQUESTED_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUESTED_STATUS	Value transfer	☐	Type reference (TYPE)	BCS_REQUESTED_STATUS		Angeforderte Status	20090127

Method SET_REQUESTED_STATUS on class CL_BCS_MESSAGE has no exception.

Method SET_SENDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESS	Call by reference	☐	Type reference (TYPE)	BCS_ADDRESS		Kommunikationsadresse (für INT, FAX, SMS...)	20090127
2	Importing	IV_COMMTYPE	Call by reference	☐	Type reference (TYPE)	BCS_COMMTYPE	'INT'	Kommunikationsart	20090127
3	Importing	IV_FAX_COUNTRY	Call by reference	☑	Type reference (TYPE)	BCS_FAX_COUNTRY		Land für Telefon-/Faxnummer	20090127
4	Importing	IV_VISIBLE_NAME	Call by reference	☑	Type reference (TYPE)	BCS_VISNAME		Anzeigename einer Adresse	20090127

Method SET_SENDER on class CL_BCS_MESSAGE has no exception.

Method SET_SEND_IMMEDIATELY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IMMEDIATELY	Value transfer	☐	Type reference (TYPE)	BCS_IMMEDIATELY		Sofortversand einer Nachricht	20090127

Method SET_SEND_IMMEDIATELY on class CL_BCS_MESSAGE has no exception.

Method SET_SENSITIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SENSITIVITY	Call by reference	☑	Type reference (TYPE)	BCS_SENSITIVITY		E-Mail Attribut Sensitivity	20090127

Method SET_SENSITIVITY on class CL_BCS_MESSAGE has no exception.

Method SET_SIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SIGN	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Boolean	20090127

Method SET_SIGN on class CL_BCS_MESSAGE has no exception.

Method SET_STATUS_MAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS_MAIL	Value transfer	☐	Type reference (TYPE)	BCS_STATUS_MAIL		Einstellung, welche Status per Mail gemeldet werden	20090127

Method SET_STATUS_MAIL on class CL_BCS_MESSAGE has no exception.

Method SET_SUBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SUBJECT	Call by reference	☑	Type reference (TYPE)	BCS_SUBJECT		E-Mail Attribut Subject	20090127

Method SET_SUBJECT on class CL_BCS_MESSAGE has no exception.

Method SET_UPDATE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UPDATE_TASK	Call by reference	☐	Type reference (TYPE)	BCS_UPDATE_TASK		In der Verbuchung senden	20090203

Method SET_UPDATE_TASK on class CL_BCS_MESSAGE has no exception.

Method SET_VSI_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VSI_PROFILE	Call by reference	☐	Type reference (TYPE)	VSCAN_PROFILE		Viren-Scan-Profil	20120723

Method SET_VSI_PROFILE on class CL_BCS_MESSAGE has no exception.

Method SHOW_SEND_LOG Signature

Method SHOW_SEND_LOG on class CL_BCS_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCS_SEND	☐	Ausnahmen Sendeschnittstelle	20090203

History

Last changed by/on	SAP	20130531
SAP Release Created in	740