Email Service User's Guide

Version 1.1.6

Last updated: February 27, 2006

Overview

The Email service will send an email message to a list of recipients.


Installation and Configuration

Install Java 1.2 or later.

Install STAF 2.5.0 or later (but less than Version 3.0.0) by following the installation instructions in the STAF documentation.

  • Install the Email V1.1.6 service:

    Download the EmailV116.zip/tar file from Get Services for STAF V2 into a local directory (e.g. C:/STAF/services or /usr/local/staf/services) and extract it.

    Configure the Email service:


    Request Syntax

    The Email service provides the following requests:

    SEND

    SEND send an email message to a list of recipients

    Syntax

    SEND TO <address> ... [SUBJECT <subject>] < MESSAGE <message> | FILE <file> [MACHINE machine] >
     
    TO specifies an email address to which the email will be sent.  You may specify multiple TO options. This option will resolve variables.

    SUBJECT specifies subject of the email and is optional. This option will resolve variables.

    MESSAGE is the body of the email. This option will resolve variables.

    FILE is the file which contains the body of the email. This option will resolve variables.

    MACHINE is the machine where the FILE is located. If not specified, it assumes the file is on the machine submitting the EMAIL SEND request. This option will resolve variables.

    Security

    This request requires at least trust level 3.

    Results

    Upon successful return, the result buffer will be empty.

    Examples

    Goal: Send an email message to 2 email addresses:

    staf local email send to user1@us.ibm.com to user2@us.ibm.com message "Hello, this is the new STAFEmail Service\n\nThanks" subject "Introducing the new STAFEmail Service"
     
    Goal: Send an email message where the body of the email message is in c:/results/testoutput.txt:

    staf local email send to user3@us.ibm.com file c:/results/testoutput.txt
     

    VERSION

    VERSION displays the Email Service version.

    Syntax

    VERSION

    Results

    The result is the version number of the Email service.

    HELP

    HELP displays the request options and how to use them.

    Syntax

    HELP

    Results

    The result buffer contains the Help messages for the request options for the Email service.