T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
MAIL ITK functions

All ITK functions of group MAIL supported by T4x. More...

Functions

 MAIL_add_envelope_receiver EnvelopeTag UserTag
 This function calls the ITK pipe server function MAIL_add_envelope_receiver to add user to the receiver list. More...
 
 MAIL_add_external_receiver EnvelopeTag HexExternalAddr
 This function calls the ITK pipe server function MAIL_add_external_receiver to add external email address to the receiver list. More...
 
 MAIL_send_envelope EnvelopeTag
 This function calls the ITK pipe server function MAIL_send_envelope sends an email. More...
 

Detailed Description

All ITK functions of group MAIL supported by T4x.

This group specifies all ITK functions of group MAIL for which wrappers have been defined in T4x

Function Documentation

◆ MAIL_add_envelope_receiver()

ITK::MAIL_add_envelope_receiver   EnvelopeTag UserTag  

This function calls the ITK pipe server function MAIL_add_envelope_receiver to add user to the receiver list.

Parameters
EnvelopeTagTeamcenter Mail envelope tag in a Tcl string representation
UserTagTeamcenter User tag in a Tcl string representation
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().

◆ MAIL_add_external_receiver()

ITK::MAIL_add_external_receiver   EnvelopeTag HexExternalAddr  

This function calls the ITK pipe server function MAIL_add_external_receiver to add external email address to the receiver list.

Parameters
EnvelopeTagTeamcenter Mail envelope tag in a Tcl string representation
HexExternalAddrExternal email address provided as "hex-formated string"
Returns
ITK_ok (=0) or list of ITK status and error message

Sample code sequence

1 set Subject "My Subject"
2 set MailTxt "My Mail Text"
3 set HexExternalAddr [tpco_scanHEX16 "name@company.com"]
4 set ItkStatus [::ITK::TCTYPE_simplified_create_object "Envelope" "object_name" $Subject "object_desc" $MailTxt]
5 if {[::ITK::isITK_ok $ItkStatus]} {
6  set EnvelopeTag [lindex $ItkStatus 1]
7  set ItkStatus [::ITK::MAIL_add_external_receiver $EnvelopeTag $HexExternalAddr]
8  if {[::ITK::isITK_ok $ItkStatus]} {
9  # Okay; now we can sent the envelope
10  set ItkStatus [::ITK::MAIL_send_envelope $EnvelopeTag]
11  }
12 }

◆ MAIL_send_envelope()

ITK::MAIL_send_envelope   EnvelopeTag  

This function calls the ITK pipe server function MAIL_send_envelope sends an email.

Parameters
EnvelopeTagTeamcenter Mail envelope tag in a Tcl string representation
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::WORKFLOW::BATCHJOB::CUSTOM::sendTC_InfoEMail().