ABAP Email Sending: CL_BCS, Attachments and HTML Mails

BCS Classes

Class	Description
`CL_BCS`	Main class for email sending
`CL_DOCUMENT_BCS`	Email document (body, attachments)
`CL_CAM_ADDRESS_BCS`	External email address
`CL_SAPUSER_BCS`	SAP user as recipient

Examples

1. Send Simple Email

DATA: lo_bcs      TYPE REF TO cl_bcs,
      lo_document TYPE REF TO cl_document_bcs,
      lo_sender   TYPE REF TO cl_sapuser_bcs,
      lo_recipient TYPE REF TO if_recipient_bcs.

TRY.
    " Create BCS instance
    lo_bcs = cl_bcs=>create_persistent( ).

    " Create document
    DATA(lt_text) = VALUE soli_tab(
      ( line = 'Dear Sir or Madam,' )
      ( line = '' )
      ( line = 'this is a test message.' )
      ( line = '' )
      ( line = 'Best regards' )
      ( line = 'Your SAP System' )
    ).

    lo_document = cl_document_bcs=>create_document(
      i_type    = 'RAW'                      " Text format
      i_text    = lt_text
      i_subject = 'Test mail from SAP'
    ).

    lo_bcs->set_document( lo_document ).

    " Sender (current user)
    lo_sender = cl_sapuser_bcs=>create( sy-uname ).
    lo_bcs->set_sender( lo_sender ).

    " Recipient
    lo_recipient = cl_cam_address_bcs=>create_internet_address(
      '[email protected]'
    ).
    lo_bcs->add_recipient( lo_recipient ).

    " Send
    DATA(lv_sent) = lo_bcs->send( ).

    IF lv_sent = abap_true.
      COMMIT WORK.
      WRITE: / 'Email was sent'.
    ENDIF.

  CATCH cx_bcs INTO DATA(lx_error).
    WRITE: / 'Error:', lx_error->get_text( ).
ENDTRY.

2. HTML Email

TRY.
    DATA(lo_bcs) = cl_bcs=>create_persistent( ).

    " HTML content
    DATA(lt_html) = VALUE soli_tab(
      ( line = '<html><body>' )
      ( line = '<h1>Welcome</h1>' )
      ( line = '<p>This is an <b>HTML email</b>.</p>' )
      ( line = '<table border="1">' )
      ( line = '<tr><th>Position</th><th>Quantity</th></tr>' )
      ( line = '<tr><td>Material A</td><td>100</td></tr>' )
      ( line = '<tr><td>Material B</td><td>250</td></tr>' )
      ( line = '</table>' )
      ( line = '</body></html>' )
    ).

    DATA(lo_document) = cl_document_bcs=>create_document(
      i_type    = 'HTM'                      " HTML format
      i_text    = lt_html
      i_subject = 'HTML test mail'
    ).

    lo_bcs->set_document( lo_document ).

    " Sender and recipient...
    lo_bcs->set_sender( cl_sapuser_bcs=>create( sy-uname ) ).
    lo_bcs->add_recipient(
      cl_cam_address_bcs=>create_internet_address( '[email protected]' )
    ).

    lo_bcs->send( ).
    COMMIT WORK.

  CATCH cx_bcs INTO DATA(lx_error).
    WRITE: / lx_error->get_text( ).
ENDTRY.

3. Email with Attachment

TRY.
    DATA(lo_bcs) = cl_bcs=>create_persistent( ).

    " Main document (body)
    DATA(lt_body) = VALUE soli_tab(
      ( line = 'Please find the requested data attached.' )
    ).

    DATA(lo_document) = cl_document_bcs=>create_document(
      i_type    = 'RAW'
      i_text    = lt_body
      i_subject = 'Data export'
    ).

    " Create CSV as attachment
    DATA(lt_csv) = VALUE soli_tab(
      ( line = 'Customer;Name;City' )
      ( line = '1000;Miller GmbH;Berlin' )
      ( line = '1001;Schmidt AG;Hamburg' )
      ( line = '1002;Weber KG;Munich' )
    ).

    lo_document->add_attachment(
      i_attachment_type    = 'CSV'
      i_attachment_subject = 'customer_export.csv'
      i_att_content_text   = lt_csv
    ).

    lo_bcs->set_document( lo_document ).
    lo_bcs->set_sender( cl_sapuser_bcs=>create( sy-uname ) ).
    lo_bcs->add_recipient(
      cl_cam_address_bcs=>create_internet_address( '[email protected]' )
    ).

    lo_bcs->send( ).
    COMMIT WORK.

  CATCH cx_bcs INTO DATA(lx_error).
    WRITE: / lx_error->get_text( ).
ENDTRY.

4. Binary Attachment (PDF, Excel)

TRY.
    DATA(lo_bcs) = cl_bcs=>create_persistent( ).

    DATA(lt_body) = VALUE soli_tab(
      ( line = 'Please find the PDF document attached.' )
    ).

    DATA(lo_document) = cl_document_bcs=>create_document(
      i_type    = 'RAW'
      i_text    = lt_body
      i_subject = 'PDF document'
    ).

    " PDF data (e.g., from Smartform)
    DATA: lv_pdf_xstring TYPE xstring.
    " ... generate PDF ...

    " Convert XString to SOLIX table
    DATA(lt_pdf_content) = cl_bcs_convert=>xstring_to_solix( lv_pdf_xstring ).
    DATA(lv_size) = xstrlen( lv_pdf_xstring ).

    lo_document->add_attachment(
      i_attachment_type    = 'PDF'
      i_attachment_subject = 'document.pdf'
      i_attachment_size    = lv_size
      i_att_content_hex    = lt_pdf_content
    ).

    lo_bcs->set_document( lo_document ).
    lo_bcs->set_sender( cl_sapuser_bcs=>create( sy-uname ) ).
    lo_bcs->add_recipient(
      cl_cam_address_bcs=>create_internet_address( '[email protected]' )
    ).

    lo_bcs->send( ).
    COMMIT WORK.

  CATCH cx_bcs INTO DATA(lx_error).
    WRITE: / lx_error->get_text( ).
ENDTRY.

5. Multiple Recipients (TO, CC, BCC)

TRY.
    DATA(lo_bcs) = cl_bcs=>create_persistent( ).

    " Create document...
    DATA(lo_document) = cl_document_bcs=>create_document(
      i_type    = 'RAW'
      i_text    = VALUE soli_tab( ( line = 'Message to multiple recipients' ) )
      i_subject = 'Info for team'
    ).
    lo_bcs->set_document( lo_document ).

    " Sender
    lo_bcs->set_sender( cl_sapuser_bcs=>create( sy-uname ) ).

    " TO recipient
    lo_bcs->add_recipient(
      i_recipient = cl_cam_address_bcs=>create_internet_address( '[email protected]' )
      i_express   = abap_true    " Send immediately
    ).

    " CC recipient
    lo_bcs->add_recipient(
      i_recipient = cl_cam_address_bcs=>create_internet_address( '[email protected]' )
      i_copy      = abap_true    " CC
    ).

    " BCC recipient
    lo_bcs->add_recipient(
      i_recipient = cl_cam_address_bcs=>create_internet_address( '[email protected]' )
      i_blind     = abap_true    " BCC
    ).

    " SAP user as recipient
    lo_bcs->add_recipient(
      i_recipient = cl_sapuser_bcs=>create( 'MUSTERMANN' )
    ).

    lo_bcs->send( ).
    COMMIT WORK.

  CATCH cx_bcs INTO DATA(lx_error).
    WRITE: / lx_error->get_text( ).
ENDTRY.

6. Email Helper Class

CLASS zcl_email_sender DEFINITION.
  PUBLIC SECTION.
    TYPES: ty_recipients TYPE TABLE OF string WITH EMPTY KEY,
           ty_attachments TYPE TABLE OF string WITH EMPTY KEY.

    METHODS: constructor.

    METHODS: set_subject
      IMPORTING iv_subject TYPE string
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: set_body_text
      IMPORTING iv_text TYPE string
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: set_body_html
      IMPORTING iv_html TYPE string
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: add_recipient
      IMPORTING iv_email TYPE string
                iv_copy  TYPE abap_bool DEFAULT abap_false
                iv_blind TYPE abap_bool DEFAULT abap_false
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: add_attachment_text
      IMPORTING iv_filename TYPE string
                iv_content  TYPE string
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: add_attachment_binary
      IMPORTING iv_filename TYPE string
                iv_content  TYPE xstring
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_sender.

    METHODS: send
      RETURNING VALUE(rv_success) TYPE abap_bool.

    METHODS: get_error_message
      RETURNING VALUE(rv_message) TYPE string.

  PRIVATE SECTION.
    DATA: mo_bcs      TYPE REF TO cl_bcs,
          mo_document TYPE REF TO cl_document_bcs,
          mv_error    TYPE string.

    METHODS: string_to_soli
      IMPORTING iv_string       TYPE string
      RETURNING VALUE(rt_lines) TYPE soli_tab.

    METHODS: get_file_extension
      IMPORTING iv_filename       TYPE string
      RETURNING VALUE(rv_extension) TYPE string.
ENDCLASS.

CLASS zcl_email_sender IMPLEMENTATION.
  METHOD constructor.
    TRY.
        mo_bcs = cl_bcs=>create_persistent( ).
      CATCH cx_bcs.
    ENDTRY.
  ENDMETHOD.

  METHOD set_subject.
    " Subject is set when creating the document
    ro_self = me.
  ENDMETHOD.

  METHOD set_body_text.
    TRY.
        mo_document = cl_document_bcs=>create_document(
          i_type    = 'RAW'
          i_text    = string_to_soli( iv_text )
          i_subject = 'Message'
        ).
      CATCH cx_document_bcs.
    ENDTRY.
    ro_self = me.
  ENDMETHOD.

  METHOD set_body_html.
    TRY.
        mo_document = cl_document_bcs=>create_document(
          i_type    = 'HTM'
          i_text    = string_to_soli( iv_html )
          i_subject = 'Message'
        ).
      CATCH cx_document_bcs.
    ENDTRY.
    ro_self = me.
  ENDMETHOD.

  METHOD add_recipient.
    TRY.
        mo_bcs->add_recipient(
          i_recipient = cl_cam_address_bcs=>create_internet_address( iv_email )
          i_copy      = iv_copy
          i_blind     = iv_blind
        ).
      CATCH cx_bcs.
    ENDTRY.
    ro_self = me.
  ENDMETHOD.

  METHOD add_attachment_text.
    TRY.
        DATA(lv_ext) = get_file_extension( iv_filename ).
        mo_document->add_attachment(
          i_attachment_type    = lv_ext
          i_attachment_subject = iv_filename
          i_att_content_text   = string_to_soli( iv_content )
        ).
      CATCH cx_document_bcs.
    ENDTRY.
    ro_self = me.
  ENDMETHOD.

  METHOD add_attachment_binary.
    TRY.
        DATA(lv_ext) = get_file_extension( iv_filename ).
        DATA(lt_content) = cl_bcs_convert=>xstring_to_solix( iv_content ).

        mo_document->add_attachment(
          i_attachment_type    = lv_ext
          i_attachment_subject = iv_filename
          i_attachment_size    = xstrlen( iv_content )
          i_att_content_hex    = lt_content
        ).
      CATCH cx_document_bcs.
    ENDTRY.
    ro_self = me.
  ENDMETHOD.

  METHOD send.
    TRY.
        mo_bcs->set_document( mo_document ).
        mo_bcs->set_sender( cl_sapuser_bcs=>create( sy-uname ) ).

        rv_success = mo_bcs->send( ).

        IF rv_success = abap_true.
          COMMIT WORK.
        ENDIF.

      CATCH cx_bcs INTO DATA(lx_error).
        mv_error = lx_error->get_text( ).
        rv_success = abap_false.
    ENDTRY.
  ENDMETHOD.

  METHOD get_error_message.
    rv_message = mv_error.
  ENDMETHOD.

  METHOD string_to_soli.
    SPLIT iv_string AT cl_abap_char_utilities=>newline INTO TABLE DATA(lt_lines).
    LOOP AT lt_lines INTO DATA(lv_line).
      APPEND VALUE #( line = lv_line ) TO rt_lines.
    ENDLOOP.
  ENDMETHOD.

  METHOD get_file_extension.
    DATA(lv_pos) = find( val = iv_filename sub = '.' occ = -1 ).
    IF lv_pos > 0.
      rv_extension = to_upper( iv_filename+lv_pos ).
    ELSE.
      rv_extension = 'BIN'.
    ENDIF.
  ENDMETHOD.
ENDCLASS.


" Usage
DATA(lo_email) = NEW zcl_email_sender( ).

DATA(lv_success) = lo_email->set_body_html(
  '<html><body><h1>Report</h1><p>Data in attachment</p></body></html>'
)->add_recipient(
  '[email protected]'
)->add_recipient(
  iv_email = '[email protected]'
  iv_copy  = abap_true
)->add_attachment_text(
  iv_filename = 'data.csv'
  iv_content  = 'A;B;C' && cl_abap_char_utilities=>newline && '1;2;3'
)->send( ).

IF lv_success = abap_false.
  WRITE: / lo_email->get_error_message( ).
ENDIF.

7. Email from Smartform

" Generate Smartform as PDF and send via email
DATA: lv_pdf      TYPE xstring,
      lt_lines    TYPE TABLE OF tline,
      lv_function TYPE rs38l_fnam.

" Determine Smartform function module
CALL FUNCTION 'SSF_FUNCTION_MODULE_NAME'
  EXPORTING
    formname           = 'ZSMARFORM_ORDER'
  IMPORTING
    fm_name            = lv_function
  EXCEPTIONS
    no_form            = 1
    no_function_module = 2
    OTHERS             = 3.

" Generate PDF
DATA: ls_output_options TYPE ssfcompop,
      ls_control        TYPE ssfctrlop.

ls_output_options-tdgetotf = abap_true.
ls_control-no_dialog = abap_true.
ls_control-getotf    = abap_true.

CALL FUNCTION lv_function
  EXPORTING
    control_parameters = ls_control
    output_options     = ls_output_options
    is_order           = ls_order
  IMPORTING
    job_output_info    = DATA(ls_job_info)
  EXCEPTIONS
    OTHERS             = 1.

" Convert OTF to PDF
CALL FUNCTION 'CONVERT_OTF'
  EXPORTING
    format       = 'PDF'
  IMPORTING
    bin_file     = lv_pdf
  TABLES
    otf          = ls_job_info-otfdata
    lines        = lt_lines
  EXCEPTIONS
    OTHERS       = 1.

" Send via email
DATA(lo_email) = NEW zcl_email_sender( ).
lo_email->set_body_text( 'Please find your order confirmation attached.' ).
lo_email->add_recipient( '[email protected]' ).
lo_email->add_attachment_binary(
  iv_filename = 'order.pdf'
  iv_content  = lv_pdf
).
lo_email->send( ).

8. Email Templates

CLASS zcl_email_template DEFINITION.
  PUBLIC SECTION.
    METHODS: constructor
      IMPORTING iv_template_id TYPE string.

    METHODS: set_placeholder
      IMPORTING iv_name  TYPE string
                iv_value TYPE string
      RETURNING VALUE(ro_self) TYPE REF TO zcl_email_template.

    METHODS: get_subject
      RETURNING VALUE(rv_subject) TYPE string.

    METHODS: get_body
      RETURNING VALUE(rv_body) TYPE string.

  PRIVATE SECTION.
    DATA: mv_subject TYPE string,
          mv_body    TYPE string,
          mt_placeholders TYPE TABLE OF string.
ENDCLASS.

CLASS zcl_email_template IMPLEMENTATION.
  METHOD constructor.
    " Load template from database/customizing
    CASE iv_template_id.
      WHEN 'ORDER_CONFIRMATION'.
        mv_subject = 'Order Confirmation {{ORDER_NO}}'.
        mv_body = |<html><body>| &&
                  |<h1>Thank you for your order</h1>| &&
                  |<p>Your order number: <b>\{\{ORDER_NO\}\}</b></p>| &&
                  |<p>Customer: \{\{CUSTOMER_NAME\}\}</p>| &&
                  |<p>Amount: \{\{AMOUNT\}\} \{\{CURRENCY\}\}</p>| &&
                  |</body></html>|.

      WHEN 'SHIPPING_NOTICE'.
        mv_subject = 'Shipping Notice {{DELIVERY_NO}}'.
        mv_body = '...'.
    ENDCASE.
  ENDMETHOD.

  METHOD set_placeholder.
    REPLACE ALL OCCURRENCES OF |{\\{{iv_name}\\}}|
      IN mv_subject WITH iv_value.
    REPLACE ALL OCCURRENCES OF |{\\{{iv_name}\\}}|
      IN mv_body WITH iv_value.
    ro_self = me.
  ENDMETHOD.

  METHOD get_subject.
    rv_subject = mv_subject.
  ENDMETHOD.

  METHOD get_body.
    rv_body = mv_body.
  ENDMETHOD.
ENDCLASS.


" Usage
DATA(lo_template) = NEW zcl_email_template( 'ORDER_CONFIRMATION' ).
lo_template->set_placeholder( iv_name = 'ORDER_NO' iv_value = '0000001234' ).
lo_template->set_placeholder( iv_name = 'CUSTOMER_NAME' iv_value = 'Miller GmbH' ).
lo_template->set_placeholder( iv_name = 'AMOUNT' iv_value = '1,234.50' ).
lo_template->set_placeholder( iv_name = 'CURRENCY' iv_value = 'EUR' ).

DATA(lo_email) = NEW zcl_email_sender( ).
lo_email->set_body_html( lo_template->get_body( ) ).
lo_email->add_recipient( '[email protected]' ).
lo_email->send( ).

9. Check Email Status

" View sent emails in SOST
" Transaction: SOST (SAPconnect Send Orders)

" Check status programmatically
DATA: lt_messages TYPE TABLE OF soos1.

CALL FUNCTION 'SO_OBJECT_READ'
  EXPORTING
    folder_id       = 'OUTBOX'
    object_id       = lv_object_id
  TABLES
    objhead         = lt_objhead
    objcont         = lt_objcont
  EXCEPTIONS
    OTHERS          = 1.

10. Activate Immediate Sending

TRY.
    DATA(lo_bcs) = cl_bcs=>create_persistent( ).

    " ... document and recipients ...

    " Immediate sending (don't wait for job)
    lo_bcs->set_send_immediately( abap_true ).

    lo_bcs->send( ).
    COMMIT WORK AND WAIT.  " Wait for commit

  CATCH cx_bcs INTO DATA(lx_error).
    " ...
ENDTRY.


" Alternative: Start SAPconnect job manually
CALL FUNCTION 'RSCP_START_SENDING'
  EXCEPTIONS
    OTHERS = 1.

Important Transactions

Transaction	Description
SOST	Display send orders
SCOT	SAPconnect administration
SO01	SAP Office inbox

Important Notes / Best Practice

Don’t forget COMMIT WORK after send( ).
cl_bcs=>create_persistent for permanent sending.
HTM type for HTML emails.
Binary attachments via solix table.
SOST to check send status.
set_send_immediately for immediate sending.
Templates for recurring email types.
Error handling with TRY-CATCH.
In ABAP Cloud: Use alternative APIs.
Combine with Smartforms for PDF generation.