Use CL_BCS library to send email with ABAP

Many a time you need a report for which the output needs to be an email. SO_NEW_DOCUMENT_SEND_API1 is heavily used to achieve the task but let's explore another way of achieving the same using CL_BCS.

This post talks about how to use the CL_BCS library provided by SAP to easily send emails.

CL_BCS Library

The class serves as the interface from BCS to the applications. The methods of the class cater for the send functions.

Using CL_BCS, You can:

– Attach files to email
– Build the HTML/raw of the body.
– Set email’s Senders & Receiver
– Send an email, etc.
Let's see the steps one by one:

Initiating CL_BCS:

The first thing you need is to initiate a persistent send request.

	DATA:
	lo_send_request TYPE REF TO cl_bcs.
	TRY.
	lo_send_request = cl_bcs=>create_persistent( ).
	CATCH cx_send_req_bcs.
	ENDTRY.

view raw cl_bcs_persistent.abap hosted with ❤ by GitHub

Creating BCS Document:

Create the BCS document object which will be sent with the CL_BCS interface to BCS. In this case the Email.

	DATA:
	lo_document TYPE REF TO cl_document_bcs.
	DATA:
	lt_email_body TYPE soli_tab.
	APPEND 'My Email Body' TO lt_email_body.
	TRY.
	lo_document = cl_document_bcs=>create_document(
	i_type = 'RAW'
	i_subject = 'My Subject line'
	i_text = lt_email_body
	).
	CATCH cx_document_bcs. "
	ENDTRY.

view raw cl_bcs_create_document.abap hosted with ❤ by GitHub

SET_DOCUMENT

Once we have the document, It needs to be set to the send request.

	DATA:
	lo_send_request TYPE REF TO cl_bcs,
	lo_document TYPE REF TO cl_document_bcs.
	lo_send_request->set_document( lo_document ).

view raw cl_bcs_set_document.abap hosted with ❤ by GitHub

SET_SENDER

Assign the sender to the send request.

	DATA:
	lo_sender TYPE REF TO if_sender_bcs,
	lo_send_request TYPE REF TO cl_bcs.
	"Crate sender from SAP user.
	lo_sender = cl_sapuser_bcs=>create( sy-uname ).
	"OR, Create internet address manually
	lo_sender = cl_cam_address_bcs=>create_internet_address( 'User@Domain.com' ).
	"Set sender.
	lo_send_request->set_sender( lo_sender ).

view raw cl_bcs_set_sender.abap hosted with ❤ by GitHub

ADD_RECIPIENT

Pass a recipient to the send request.

	DATA:
	lo_send_request TYPE REF TO cl_bcs,
	lo_recipient TYPE REF TO if_recipient_bcs .
	" Add using SAP user
	lo_recipient = cl_sapuser_bcs=>create( sy-uname )
	"OR domain adress
	lo_recipient = cl_cam_address_bcs=>create_internet_address( 'email@domain.com' ).
	lo_send_request->add_recipient( lo_recipient ) .

view raw cl_bcs_set_recipient.abap hosted with ❤ by GitHub

SEND

Send the email.

	DATA: lo_send_request TYPE REF TO cl_bcs.
	lo_send_request->send( ).

view raw cl_bcs_send.abap hosted with ❤ by GitHub

Here is a small working code snippet to send an email with a text file as an attachment,

	REPORT syst-repid.
	DATA:
	lt_txt_file TYPE soli_tab.
	DATA:
	lo_document TYPE REF TO cl_document_bcs,
	lo_send_request TYPE REF TO cl_bcs.
	TRY.
	lo_send_request = cl_bcs=>create_persistent( ).
	lo_document = cl_document_bcs=>create_document( i_type = 'RAW'
	i_subject = 'TEST MAIL'
	).
	"Add random text to your attachment file.
	APPEND 'My attached txt file content.' TO lt_txt_file.
	lo_document->add_attachment( i_attachment_type = 'TXT' " Document Class for Attachment
	i_attachment_subject = 'My_Txt_FILE.TXT' " Attachment Title
	i_att_content_text = lt_txt_file " Content (Textual)
	).
	lo_send_request->add_recipient( cl_cam_address_bcs=>create_internet_address( 'Test@domain.com' ) ) .
	lo_send_request->set_document( lo_document ).
	lo_send_request->set_sender( cl_cam_address_bcs=>create_internet_address( 'Test@domain.com' ) ).
	lo_send_request->send( ).
	COMMIT WORK AND WAIT.
	CATCH cx_document_bcs
	cx_send_req_bcs
	cx_address_bcs.
	MESSAGE e000(db) WITH 'Error Sending Email.'.
	ENDTRY.

view raw cl_bcs_working_example.abap hosted with ❤ by GitHub

As always, hope you like the post and use this knowledge in your day to day work.