SAP ABAP Class CL_BCB_MESSAGE (BCB Message)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-CHA (Application Component) Communication Channel
     ⤷ ICI_BCB (Package) Business Communication Broker

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BCB_ITEM	BCB Item	20031113
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_MESSAGE_CONSTANTS	BCB Message Constants	20040112
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_MESSAGE_PROPS_ACCESS	BCB Message Properties Access	20040112

Properties

Class	CL_BCB_MESSAGE
Short Description	BCB Message
Super Class	CL_BCB_ITEM	BCB Item
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	ICI_BCB	Business Communication Broker
Created	20031113	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	BCB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BCB_MESSAGE_CONSTANTS	☐	☐	BCB Message Constants	20040112
2	IF_BCB_MESSAGE_PROPS_ACCESS	☐	☐	BCB Message Properties Access	20040112

Friends

#	Friend	Modeled only	Created on	Description
1	IF_BCB_MESSAGE_ACCESS	☐	20040114	BCB Message Access

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CA_DELETE	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
2	CA_SEND	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
3	CA_SETCONTENT	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
4	IS_ACCEPTED	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
5	IS_DRAFT	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
6	IS_SENT	Instance attribute	Public	☐	Attribute reference (LIKE)				20040112
7	M_ATTACHMENTS	Instance attribute	Private	☐	Type reference (TYPE)	BCB_ATTACHMENT_T		Table of attachments	20040112
8	M_ATTACHMENT_IDS	Instance attribute	Protected	☐	Type reference (TYPE)	STRING_TABLE		Table of attachment names	20040115
9	M_CHANNEL_CAPABILITY_OFFSET	Constant	Private	☐	Type reference (TYPE)	INT2	200	2 byte integer (signed)	20040202
10	M_CHANNEL_CAPABILITY_TEXT	Static Attribute	Private	☐	Type reference (TYPE)	STRING_TABLE		Capabilities Texts	20040112
11	M_CONTENT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		= null if not up-to-date	20040128
12	M_ICI_MESSAGE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ICI_MESSAGE		ICI Interface Object	20040112
13	M_IS_SEND_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		true if message represents a send status	20040112
14	M_MIME_MESSAGE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BCB_MIME_MESSAGE		Like parts of javax.mail. Wrapper for basis functionality.	20040128
15	M_ORIGINAL_MESSAGE_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		contains the Id of the original message if is_send_status	20040112
16	M_ORIGINATOR	Instance attribute	Private	☐	Type reference (TYPE)	STRING		sender	20040112
17	M_SUBJECT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		subject line	20040112
18	M_TEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		1st/main bodypart with Content-Type:Text	20040112

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CAPABILITY	Static method	Public	Method	Check capability value is a valid message capability	20031209
2	CHECK_STATUS	Static method	Public	Method	Check Mail Status	20031209
3	CREATE_BY_FOLDER	Static method	Protected	Method	Create a BCB message in a specified folder	20040109
4	CREATE_BY_MESSAGE_ID	Static method	Public	Method	Create a BCB message for an existing message	20040112
5	DELETE	Instance method	Public	Method	Deletes the message from the folder	20040113
6	GET_ATTACHMENT	Instance method	Public	Method	Returns an attachment	20040119
7	GET_ATTACHMENTS	Instance method	Public	Method	Returns the attachments	20040113
8	GET_ATTACHMENT_IDS	Instance method	Public	Method	Returns the attachment IDs	20040115
9	GET_CONTENT	Instance method	Private	Method	Returns the native content (also gets attachments)	20040128
10	GET_FOLDER_NAME	Instance method	Public	Method	returns folder name	20041111
11	GET_MIME_MESSAGE	Instance method	Public	Method	Returns the native content (also gets attachments)	20040128
12	GET_ORIGINAL_MESSAGE	Instance method	Public	Method	Returns the original message	20040113
13	GET_ORIGINATOR	Instance method	Public	Method	Returns the sender	20040113
14	GET_SUBJECT	Instance method	Public	Method	Returns the subject	20040113
15	GET_TEXT	Instance method	Public	Method	Returns the first body text part	20040113
16	INITIALIZE	Instance method	Private	Method	Initialize message instance	20040112
17	INITIALIZE_STATICS	Static method	Private	Method	Initialize static members	20040202
18	IS_HISTORIC_MESSAGE	Instance method	Public	Method	checks m_container	20050224
19	IS_SEND_STATUS	Instance method	Public	Method	Does message represent a send status?	20040113
20	SAME_ATTACHMENT_IDS	Instance method	Public	Method	Check equality of a list of attachment names	20040115
21	SEND	Instance method	Public	Method	Send the message	20040113
22	SET_CONTENT	Instance method	Private	Method	Ses the native content (hereby also the attachments)	20040128
23	SET_MIME_MESSAGE	Instance method	Public	Method	Ses the native content (hereby also the attachments)	20040128
24	UPDATE	Instance method	Public	Method	Change Message Attributes	20040112
25	XXXSPLIT_CONTENT	Instance method	Private	Method	Split content into its parts	20040128

Events

Class CL_BCB_MESSAGE has no event.

Types

Class CL_BCB_MESSAGE has no local type.

Method Signatures

Method CHECK_CAPABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CAPABILITY	Value transfer	☐	Type reference (TYPE)	INT2		Capability to be checked	20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031209

Method CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATUS	Value transfer	☐	Type reference (TYPE)	STRING		Status to be checked	20031209

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031209

Method CREATE_BY_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_FOLDER		BCB Folder	20040109
2	Returning	MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MESSAGE		BCB Message	20040109
3	Importing	MESSAGE_PROPS	Value transfer	☑	Object reference (TYPE REF TO)	CL_BCB_MESSAGE_PROPS		BCB Message Properties	20040112
4	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20040109

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040109

Method CREATE_BY_MESSAGE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MESSAGE		BCB Message instance	20040112
2	Importing	MESSAGE_ID	Value transfer	☐	Type reference (TYPE)	STRING		ID of an existing message	20040112
3	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20040112

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040112

Method DELETE Signature

Method DELETE on class CL_BCB_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040113

Method GET_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATTACHMENT	Value transfer	☐	Type reference (TYPE)	BCB_ATTACHMENT		Anlage	20040119
2	Importing	CONTENT_ID	Value transfer	☑	Type reference (TYPE)	STRING		Attachment Content ID	20040119
3	Importing	FILE_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Attachment Filename	20040119
4	Importing	ID	Value transfer	☑	Type reference (TYPE)	ATTACH_ID		Attachment (numeric) ID	20040119

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040119

Method GET_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATTACHMENTS	Value transfer	☐	Type reference (TYPE)	BCB_ATTACHMENT_T		Table of attachments	20040113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040115

Method GET_ATTACHMENT_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATTACHMENT_IDS	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Zeichentabelle	20040115

Method GET_ATTACHMENT_IDS on class CL_BCB_MESSAGE has no exception.

Method GET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20040128

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040128

Method GET_FOLDER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_FOLDER_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20041111

Method GET_FOLDER_NAME on class CL_BCB_MESSAGE has no exception.

Method GET_MIME_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MIME_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MIME_MESSAGE		Mime Message instance	20040128

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040128

Method GET_ORIGINAL_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ORIGINAL_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MESSAGE		BCB Message	20040113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040113

Method GET_ORIGINATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ORIGINATOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ADDRESS		BCB Address	20040113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040113

Method GET_SUBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SUBJECT	Value transfer	☐	Type reference (TYPE)	STRING			20040113

Method GET_SUBJECT on class CL_BCB_MESSAGE has no exception.

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20040113

Method GET_TEXT on class CL_BCB_MESSAGE has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_BCB_MESSAGE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040112

Method INITIALIZE_STATICS Signature

Method INITIALIZE_STATICS on class CL_BCB_MESSAGE has no parameter.
Method INITIALIZE_STATICS on class CL_BCB_MESSAGE has no exception.

Method IS_HISTORIC_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_HISTORIC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050224

Method IS_HISTORIC_MESSAGE on class CL_BCB_MESSAGE has no exception.

Method IS_SEND_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_SEND_STATUS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20040113

Method IS_SEND_STATUS on class CL_BCB_MESSAGE has no exception.

Method SAME_ATTACHMENT_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTACHMENT_IDS_TO_BE_CHECKED	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Attachments to be checked	20040115
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		True if attachments are equal	20040115

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040115

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FAILURE_NOTIFICATION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040113
2	Importing	SUCCESS_NOTIFICATION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20040113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040113

Method SET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20040128

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040128

Method SET_MIME_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MIME_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MIME_MESSAGE		Like parts of javax.mail. Wrapper for basis functionality.	20040128

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040128

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MESSAGE_CHANGES	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MESSAGE_CHANGES		Message Changes	20040112
2	Importing	MESSAGE_PROPS	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_MESSAGE_PROPS		BCB Message Properties	20040112

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040112

Method XXXSPLIT_CONTENT Signature

Method XXXSPLIT_CONTENT on class CL_BCB_MESSAGE has no parameter.
Method XXXSPLIT_CONTENT on class CL_BCB_MESSAGE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in