UPS_SEND_START_MAIL SAP Function module - send start mail

UPS_SEND_START_MAIL is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name UPS_SEND_START_MAIL into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: UPS_C
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM UPS_SEND_START_MAIL - UPS SEND START MAIL

CALL FUNCTION 'UPS_SEND_START_MAIL' "send start mail
  EXPORTING
    ir_document =               " if_ixml_document  IF_IXML_DOCUMENT
    it_email =                  " ups_yt_email  Table on UPS_YS_EMAIL
    i_version =                 " ups_y_version  Planning Session/Version
    i_teilplan =                " ups_y_teilplan  Subplan in STS
    ir_sts =                    " cl_ups_sts    Initial Class STS
*   is_attribute =              " ups_ys_attribute  Single-Character Flag
*   i_mode =                    " i             First. new start mail 2 .. Reminder
  EXCEPTIONS
    FAILED = 1                  "               Error sending mail
    .  "  UPS_SEND_START_MAIL

ABAP code example for Function Module UPS_SEND_START_MAIL

The ABAP code below is a full code listing to execute function module UPS_SEND_START_MAIL including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA(ld_ir_document) = 'Check type of data required'.

DATA(ld_it_email) = 'Check type of data required'.

DATA(ld_i_version) = 'Check type of data required'.

DATA(ld_i_teilplan) = 'Check type of data required'.

DATA(ld_ir_sts) = 'Check type of data required'.

DATA(ld_is_attribute) = 'Check type of data required'.

DATA(ld_i_mode) = 'Check type of data required'.
.

CALL FUNCTION 'UPS_SEND_START_MAIL'
  EXPORTING
    ir_document =                ld_ir_document
    it_email =                   ld_it_email
    i_version =                  ld_i_version
    i_teilplan =                 ld_i_teilplan
    ir_sts =                     ld_ir_sts
*   is_attribute =               ld_is_attribute
*   i_mode =                     ld_i_mode
  EXCEPTIONS
    FAILED =                     1
    .  "  UPS_SEND_START_MAIL

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_ir_document
 
 TYPE IF_IXML_DOCUMENT ,
ld_it_email
 
 TYPE UPS_YT_EMAIL ,
ld_i_version
 
 TYPE UPS_Y_VERSION ,
ld_i_teilplan
 
 TYPE UPS_Y_TEILPLAN ,
ld_ir_sts
 
 TYPE CL_UPS_STS ,
ld_is_attribute
 
 TYPE UPS_YS_ATTRIBUTE ,
ld_i_mode
 
 TYPE I .


ld_ir_document = 'Check type of data required'.
ld_it_email = 'Check type of data required'.
ld_i_version = 'Check type of data required'.
ld_i_teilplan = 'Check type of data required'.
ld_ir_sts = 'Check type of data required'.
ld_is_attribute = 'Check type of data required'.
ld_i_mode = 'Check type of data required'.