Skip to main content
Skip table of contents

Commands in EMAIL

SNDEMAIL (Send E-Mail)

The SNDEMAIL command is used to send a text or any file attachments from IBM Power Systems via e-mail. You can specify multiple recipients or copy recipients and up to 200 files from the IFS or DB2 file system. SNDMAIL sends these files as MIME attachments and works with any standard mail server.

The number of parameters available for selection depends on whether you specify a recipient and/or sender partner and/or a communication profile at SNDEMAIL.


ParameterPermissible valuesDescription ValuesDescription Command
Receiver Partner ID (PARTNER)
  1. *NONE
  2. Text
  1. No recipient partner ID is assigned. The information required for the recipient must then be specified in other parameters of this command.
  2. Specify the recipient partner ID.
At this point, you have the option of referring to a partner profile created in the master data (master data → Partner).

Profile no. (STECK LETTER)

  1. *NONE
  2. Text
  1. No collaboration profile is assigned. The specifications required for the remote system must then be specified in further parameters of this command.
  2. Specify the communication profile ID.
At this point, you have the option of referring to a communication profile created in the master data (Communication → Profile).
Sender Alias (ORIGINATOR)
  1. *NONE
  2. Text
  1. No sender profile is assigned. The information required for the sender must then be specified in further parameters of this command.
  2. Specify the sender profile ID.
At this point, you have the option of referring to a sender profile created in the master data (master data → sender).
E-mail recipient (RECIPIENT)
  1. Text
  2. %USER%
  3. %SPLUSER%
  1. Own input.
  2. The e-mail address of the current user on the machine's SMTP distribution list is used for this variable during processing. The SMTP distribution list is maintained in the system with WRKNAMSMTP TBLTYPE(*SYSTEM) and WRKDIRE (network user ID).
  3. Only in connection with the i-effect *SERVER *SPOOL/*MONITOR! The e-mail address of the user who created the spool file is taken from the SMTP distribution list of the system during processing for this variable. The SMTP distribution list is maintained in the system with WRKNAMSMTP TBLTYPE(*SYSTEM) and WRKDIRE (network user ID).

For variable control of the receiver, CC and BCC addresses, any number of receiver, CC and BCC addresses can be stored for a partner. You can create these addresses in the partner master with selection 10 before the corresponding partner entry (recipient list). If the partner is then specified in the "Recipient Partner ID" parameter in SNDEMAIL, the e-mail is sent to all defined addresses.

Enter the e-mail addresses to which the attached files and/or the entered text should be sent. The e-mail address must be entered in the format "name@domain.xy". Up to 100 recipients can be entered.
Subject (SUBJECT)
  1. Text
  1. Own input e.g. "Hello World"

The text entered here will be transmitted as subject in the headers of the e-mail. The information for the subject can also be taken from any file in which the text is already encoded (e.g. UTF-8, Unicode, etc.)

For this purpose, the fully qualified file name must be specified in this parameter. ( for example, /tmp/mySubject.txt or /QSYS.LIB/MYLIB/SUBJECT.FILE/SUBJECT.MBR ).

Message text/file (MSGTEXT)
  1. Text

In addition to the files included in the e-mail attachment, a simple text can be entered here, which is displayed by the receiving mail client as message text (INLINE).

The information for this message text can also be taken from any file. To do this, you must specify the fully qualified file name in this parameter. ( for example, /tmp/document.txt or /QSYS.LIB/MYLIB/TEXT.FILE/TEST.MBR ). Data read from an external file can only be displayed in the mail client of the recipient INLINE if the document type is supported there. This is usually the case with TEXT and HTML files. In all other cases, the file specified here is displayed in the mail client of the recipient as an attachment file.

The following control characters can be used to support easy formatting of text manually entered in this parameter:

  • Line feed (\n)
    At this point the text in the eMail is wrapped
  • Tab (\r)At this point a standard tabulator is inserted in the text.
Format
  1. *DEFAULT
  2. *PLAIN
  3. *HTML
  4. *BOTH
  1. The default for this parameter is taken from the module configuration.
  2. The entered text or the text read from an external file should be sent as an e-mail with content type "text/plain".
  3. The entered text or the text read from an external file should be sent as an e-mail with content type "text/html". The text is packed into a standard HTML framework. If the external file is available in HTML format (file extension .htm or .html), the content is not packed into a HTML framework but sent as it is. Thus it is possible to send any HTML content as an e-mail.The entered text or the text read from an external file is sent with content type "multipart/alternative" ("text/plain" and "text/html"). The text is packed into a standard HTML skeleton. The email client at the receiving end then decides which of the two parts it displays (preferred display of the respective email client program).
This parameter determines in which form the message text is available and in which format the message text should be sent.
Kodierung
  1. *DEFAULT
  2. *JOB
  1. The default for this parameter is taken from the module configuration. The CCSID of the current job is read out and converted to the corresponding coding scheme according to the following table. The coding scheme is *UNICODE if the CCSID of the job is not contained in the following list. The list of available CCSID's can be found at the command prompt.
Specifies the character set to be used for this text. The data is therefore converted to the code page specified here according to this specification before sending.
Annex (ATTACH)
  1. Text
  1. Path to the file to be sent as attachment. Wildcard (*=All) is allowed.

In connection with the i-effect *SERVER the following variables are also available:

%TMP%, %HOME%, %CURDIR%, %USER%, %DATE%, %YEAR%, %YEAR2%, %MONTH%, %MONTHNAME%, %WEEKDAY%, %TIME%, %TIMESTAMP%, %DEFAULTPATH%, %SRVDIR%, ,%IFSPATH%, %IFSFILE%

This parameter takes the names of up to 200 files that will be added as attachments to the email to be sent. Generic names are allowed!

Z. For example, you can attach all PDF files in the tmp directory to the email by specifying /tmp/*.pdf.

If /tmp/*.* is specified, all files from /tmp are sent with the e-mail.

CC
  1. Text

A valid e-mail address.

For variable control of the receiver, CC and BCC addresses, any number of receiver, CC and BCC addresses can be stored for a partner. You can create these addresses in the partner master with selection 10 before the corresponding partner entry (recipient list). If the partner is then specified in the "Recipient Partner ID" parameter in SNDEMAIL, the e-mail is sent to all defined addresses.

Enter the e-mail addresses to which the attached files and/or the entered text should be sent as a copy. The e-mail address must be entered in the format "name@domain.xy". Up to 100 recipients can be entered.
BCC
  1. Text

A valid e-mail address.

For variable control of the receiver, CC and BCC addresses, any number of receiver, CC and BCC addresses can be stored for a partner. You can create these addresses in the partner master with selection 10 before the corresponding partner entry (recipient list). If the partner is then specified in the "Recipient Partner ID" parameter in SNDEMAIL, the e-mail is sent to all defined addresses.

Here you enter the e-mail addresses to which the attached files and/or the entered text should be sent as a hidden copy. Covert because none of the recipients in the fields "To" and "Cc" can see to whom the message has been sent as a covert copy. The e-mail address must be entered in the format "name@domain.xy". Up to 100 recipients can be entered.
Priority (PRIO)
  1. *DEFAULT
  2. *NORMAL
  3. *LOW
  4. *HIGH
  1. The default for this parameter is taken from the module configuration.
  2. The e-mail is marked with normal priority.
  3. The e-mail is marked with low priority.
  4. The e-mail is marked with high priority.
Defines the priority with which the e-mail should be marked in the recipient's mailbox.
Acknowledgement of receipt (MDN)
  1. *DEFAULT
  2. *YES
  3. *NO
  1. The default for this parameter is taken from the module configuration.
  2. The received system is requested to send an acknowledgement of receipt.
  3. No confirmation is requested.
This parameter can be used to specify whether an acknowledgement of receipt is requested for sending this e-mail. If the received system supports this function, it automatically generates an e-mail confirming receipt of the e-mail when confirmation is requested.
Maximum mail size in KB (SIZE)
  1. Text
  2. *NOMAX
  1. Specified in KB e.g. 9500.
  2. As a possible special value, *NOMAX is allowed, which indicates that outgoing e-mails are not subject to any size limit.
The use of e-mail servers is occasionally restricted with regard to the maximum size of e-mails, either by the provider or on the recipient's side. At this point you can take this into account by setting a maximum size for the e-mail file created. If this maximum size is exceeded by, for example, the number and size of attachments, the attachments are automatically distributed and sent to several e-mails.

A maximum size of 9500kb is recommended.


Signature Algorithm (SIGN)
  1. *DEFAULT
  2. *NONE
  3. MD5
  4. *SHA1, *SHA224, *SHA256, *SHA384, *SHA512
  5. *RIPEMD128, *RIPEMD160, *RIPEMD256
  1. The default for this parameter is taken from the module configuration.
  2. The e-mail is not signed.
  3. The signature is generated using the MD5 algorithm. MD5 (Message Digest Algorithm 5) is a widely used cryptographic hash function that generates a 128-bit hash value.
  4. The signature is generated using SHAXXX. The secure hash algorithm (English
    secure hash algorithm), SHA for short, denotes a group of standardized cryptographic hash functions. SHA-1 (Message Digest Algorithm 5) is a cryptographic hash function that generates a 160-bit hash value.
  5. The message is written after RIPEMD128, RIPEMD160 or RIPEMD256 (RACE Integrity Primitives Evaluation
    Message Digest) algorithm signed.

The parameter consists of two elements. The first element specifies the signature algorithm to be used. The parameter consists of two elements. The second element specifies the entry (alias) of the public key/certificate in the keystore that is to be used for encryption (master data → Certificates - Keystore: *CRYPT).

With this parameter it can be specified whether the outgoing e-mail is to be electronically signed. An e-mail that has been electronically signed in this way can be examined by the recipient using the sender's public key for authenticity and integrity, as well as for its original origin.




The second element names the entry (alias) of the

private key in the keystore to be used for the signature


Encryption algorithm (ENCRYPT)
  1. *DEFAULT
  2. *NONE
  3. *TRIPLEDES
  4. AES128, AES192, AES256
  1. The default for this parameter is taken from the module configuration.
  2. The e-mail is not signed.
  3. The message is signed with 3DES encryption.
  4. The message is encrypted with AES (Advanced Encryption
    Standard) 128, 192 or 265 bits signed.


The parameter consists of two elements. The first element specifies the encryption algorithm to be used. The parameter consists of two elements. The second element specifies the entry (alias) of the public key/certificate in the keystore that is to be used for encryption (master data → certificates - keystore: *CRYPT).

This parameter can be used to specify whether the e-mail to be sent is electronically encrypted. An e-mail that has been encrypted in this way can only be restored by the recipient using his or her private key.

will be decrypted.

SMTP-Server
  1. Text
  1. Enter the following parameters:
    1. DNS Name or IP: Enter the name of the SMTP mail server here. You can enter an IP address or the DNS name of the mail server.
    2. TCP/IP Port: Enter the port on which the mail server accepts jobs in the SMTP protocol (the default port is 25).
    3. User name: Enter the user name for logging into the mail server here.
    4. Password: Enter the password of the previously specified authorized user here.
    5. SSL: Specify here whether SSL (Secure Socket Layer) should be used for the connection to the mail server.
    6. Import certificates: Specify here whether you allow the automatic import of the mail server certificate. The mail server authenticates itself to the e-mail client with its certificate by sending it to the client when the connection is established. If it is determined that this certificate is not in the i-effect keystore, it will be imported automatically. If the value is set to *NO, an error will occur if the server's certificate is not in the i-effect Keystore when the connection is established

This parameter consists of six elements that contain information about the mail server to be used.

If you enter the special value *DEFAULT in parameter "DNS Name or IP", the values for all SMTP elements are taken from the module configuration.

E-mail address of sender
  1. DEFAULT
  2. %USER%
  3. %SPLUSER%
  1. With this standard entry, the current value for this parameter is taken from the i-effect master data of the *EMAIL module.
  2. The e-mail address of the current user from the system's SMTP distribution list (WRKNAMSMTP TBLTYPE(*SYSTEM)) is used for this variable during processing.
  3. Only in connection with the i-effect *SERVER *SPOOL/*MONITOR! The e-mail address of the user who created the spool file is taken from the SMTP distribution list of the system during processing for this variable. The SMTP distribution list is maintained in the system with WRKNAMSMTP TBLTYPE(*SYSTEM) and WRKDIRE (network user ID).
This is the e-mail address that will be entered as the sender of the e-mail.
Reply-to e-mail address
  1. *SENDER
  2. *DEFAULT
  3. %USER%
  4. %SPLUSER%
  1. The Reply-to e-mail address corresponds to the sender address.
  2. With this standard entry, the current value for this parameter is taken from the i-effect master data of the *EMAIL module.
  3. The e-mail address of the current user from the system's SMTP distribution list (WRKNAMSMTP TBLTYPE(*SYSTEM)) is used for this variable during processing.
  4. Only in connection with the i-effect *SERVER *SPOOL/*MONITOR! The e-mail address of the user who created the spool file is taken from the SMTP distribution list of the system during processing for this variable. The SMTP distribution list is maintained in the system with WRKNAMSMTP TBLTYPE(*SYSTEM) and WRKDIRE (network user ID).
This is the e-mail address to which replies are sent by the recipient of this e-mail.
Email address error
  1. *SENDER
  2. *DEFAULT
  3. %USER%
  4. %SPLUSER%
  1. The Reply-to e-mail address corresponds to the sender address.
  2. With this standard entry, the current value for this parameter is taken from the i-effect master data of the *EMAIL module.
  3. The e-mail address of the current user from the system's SMTP distribution list (WRKNAMSMTP TBLTYPE(*SYSTEM)) is used for this variable during processing.
  4. Only in connection with the i-effect *SERVER *SPOOL/*MONITOR! The e-mail address of the user who created the spool file is taken from the SMTP distribution list of the system during processing for this variable. The SMTP distribution list is maintained in the system with WRKNAMSMTP TBLTYPE(*SYSTEM) and WRKDIRE (network user ID).
This is the e-mail address to which transmission errors are reported.
i-effect application server (EFFSERVER)
  1. Text
  1. The parameter consists of three elements:
    1. DNS Name or IP: Enter either the DNS name or the IP address of your i-effect server here. Special value: *LOCALHOST: This default value indicates that you run the command on the same system where i-effect is installed. In this case it is not necessary to specify a port in the next parameter.
    2. TCP/IP port: Enter the port on which the i-effect command should be called. This port depends on the range of TCP/IP ports that you have specified in the default settings of the *BASE module. The following setting is possible: base port + 1, so choose the base i-effect TCP/IP port range for this parameter and add the number shown in the previous table depending on the selected command.
    3. Type of call:
      1. Synchronous means that the response of the remote call is waited for, i.e. in the case of SNDOFTP, that all available send files have been sent. Only then is the server available for further input.
      2. The Power Systems server is immediately available again for further input, while the remote call is processed in the background.

With i-effect you have the possibility to call some tasks remotely from other IBM Power Systems in the network. So it is also possible to call this command remotely. In this case, you must enter the server on which i-effect is installed and licensed.




Here you can determine whether the server from which the call is made should first wait for the result of the call or should be available again immediately for further input.

SNDEMAIL (Send E-mail)

The RCVEMAIL command is used to retrieve e-mail from a POP or IMAP-compatible mail server. File attachments or texts from e-mails are automatically decoded and stored in the assigned directories.

ParameterPermissible valuesDescription ValuesDescription Command
Profile No. (PROFILE)
  1. *NONE
  2. Text
  1. No collaboration profile is assigned. The specifications required for the remote system must then be specified in further parameters of this command.
  2. Specify the communication profile ID.
At this point, you have the option of referring to an already created communication profile (Kommunikation→ Profile).
Storage directory
  1. Text
  1. Specification of the paths:
    1. Inline bodytext: Enter a path or or *DEFAULT: The default for this parameter is taken from the module configuration.
    2. Appendix: Enter a path or or *DEFAULT: The default for this parameter is taken from the module configuration.
This parameter consists of 2 elements and defines the directories to be used for receiving e-mails.
Assign Partner (ASSIGNPRT)
  1. *YES
  2. *NO
  1. Default - Assignment is activated.
  2. Assignment is deactivated.
Activates or deactivates the partner assignment for mail receipt. If the assignment is deactivated, no search for a partner entry for the sender address of a retrieved e-mail takes place. A defined assignment of mail address to partner thus remains without effect. Only the parameters or the module configuration specified in the RCVEMAIL command are then used. If the assignment is activated, processing with partner settings is performed, if configured accordingly.
POP3/IMAP Server
  1. Text
  1. Enter the following parameters:
    1. DNS name or IP: Here you must specify the mail server to be used to receive mails. Either a DNS name or a TCP/IP address in the form xxx.xxx.xxx.xxx can be specified. All mail servers that work according to the POP3 or IMAP protocol, such as Lotus Notes or Microsoft Exchange, can be used. A corresponding account must be set up on the mail server, which can be read out with RCVEMAIL.
    2. TCP/IP Port: The TCP/IP port number at which the mail server can be reached. The default value for an SMTP mail server is 25, for POP3 it is 110 and for IMAP usually 143.
    3. User name: For authentication, a login to the POP3/IMAP server is usually required. The user name entered here is used for this.
    4. Password: The password for the user name defined in the previous parameter must be entered here.
    5. Delete mails on the server: Defines whether messages successfully read by the POP3 mail server should be deleted on the mail server.
    6. Protocol: The protocol to be used for receiving email (IMAP or POP).
    7. SSL: Specify here whether SSL (Secure Socket Layer) should be used for the connection to the mail server.
    8. Import certificates: Specify here whether you allow the automatic import of the mail server certificate. The mail server authenticates itself to the e-mail client with its certificate by sending it to the client when the connection is established. If it is determined that this certificate is not in the i-effect keystore, it will be imported automatically. If the value is set to *NO, an error will occur if the server's certificate is not in the i-effect Keystore when the connection is established

This parameter consists of eight elements containing information about the mail server to be used. The mail server must use the POP3 or IMAP protocols.

If you enter the special value *DEFAULT for parameter "DNS name", the values for all eight elements are taken from the module configuration.

i-effect application server (EFFSERVER)
  1. Text
  1. The parameter consists of three elements:
    1. DNS name or IP: Enter either the DNS name or the IP address of your i-effect server here. Special value: *LOCALHOST: This default value indicates that you are running the command on the same system where i-effect is installed. In this case it is not necessary to specify a port in the next parameter.
    2. TCP/IP port: Enter the port on which the i-effect command should be called. This port depends on the range of TCP/IP ports that you have specified in the default settings of the *BASE module. The following setting is possible: base port + 1, so choose the base i-effect TCP/IP port range for this parameter and add the number shown in the previous table depending on the selected command.
    3. Type of call:
      1. Synchronous means that the response of the remote call is waited for, i.e. in the case of SNDOFTP, that all available send files have been sent. Only then is the server available for further input.
      2. The Power Systems server is immediately available again for further input, while the remote call is processed in the background.

With i-effect you have the possibility to call some tasks remotely from other IBM Power Systems in the network. So it is also possible to call this command remotely. In this case, you must enter the server on which i-effect is installed and licensed.




Here you can determine whether the server from which the call is made should first wait for the result of the call or should be available again immediately for further input.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.