Screen-Parameters

Required/

Optional

Comment

EM,BG,nn,x

Required

EM,FR

EM,TO

Optional

Required

Specify a from address in Screen-Literal

To Address or Name

·        Screen-Literal = Recipient Name or Address

• At least one email address is required
• You can execute this API call multiple times to send to multiple recipients.  For MAPI, this is subject to the maximum email addresses allowed (100).

EM,CC

Optional

Carbon Copy (CC) Address or Name

·        Screen-Literal = CC Recipient Name or Address

• You can execute this API call multiple times.  For MAPI, it is subject to the maximum email addresses allowed.

EM,BC

Optional

Blind Carbon Copy(BCC) Address or Name

·        Screen-Literal = BCC Recipient Name or Address

·        You execute this API call multiple times.  For MAPI, it is subject to the maximum email addresses allowed.

EM,SB

Optional

Subject

·        Screen-Literal = Subject

EM,AT

Optional

Attached File

·        Screen-Area = Complete Path and File Name

**Note that the path is required and the attached file must exist.

·        Screen-Function-Values = Visible filename (opt)

If this area is used, the name of the file which will be visible to the recipient will be the value here followed by .TXT.

• For MAPI, it may be called up to 100 times per email

EM,TX

Optional

Text Content of the Body of the Email

·        Screen-Area = Text Line

• Screen-Area is a 160 bytes area with Screen-Literal making up the first 80 bytes and Screen-Alpha-Field making up the last 80 bytes.
• Screen-Numeric-Field = number of characters in the line to include.  If Screen-Numeric-Field = Zeroes, the system layer will calculate the length of the text.  If Screen-Numeric-Field = Zeroes and Screen-Area is blank, a new-line character (X”0a”) will be provided.
• You may call this API multiple times to construct a multi-line email body.
• The message body cannot exceed 64K.

EM,HF

EM,HP

EM,IN

EM,AB

Optional

Optional

Optional

Optional

Send email in HTML (not text) format.  This parameter generally is not necessary because the presence of "<" in the first position of the email body and "HTML" within the first 100 characters automatically sets the email to HTML mode.

Set the email to be high priority.

Make the email interactive

Abort the Email

• Abort constructing the current email.  The system will release all resources allocated for the current email that is being constructed.

·        The message and all its characteristics are ignored.

·        Use only after a successful “EM,BG.”  You do not need to use this API if “EM,BG” was not executed successfully.

EM,SE

Required

Send Email Message

·        Returns ‘Y’ in Screen-Answer if the message was successful.  For MAPI, receiving ‘Y’ does not guarantee the email is sent -- it simply indicates that MAPI has accepted the email, (i.e., emails may not send because MAPI may not be able to connect to the email transport server).

o    Screen-Numeric-Field will contain 0 if the message was sent; 1 if the message was cancelled by the user.

• Return ‘N’ in Screen-Answer if the message was not successful
• Screen-Numeric-Field will contain an error code
• Screen-Literal will contain an error message.

EM,EX

EM,VE

Required

Optional

Exit Email and Disconnect from Email Services

·        This does a logoff from the mail system.

·        This is automatically called by Elliott at shutdown.

• Follow this call with Cancel “NWSMMAPI” or Cancel "NWSMSMTP."
• When using MAPI, since the login process may be time consuming in certain environments, you may not want to call this API until all emails are sent.  However, you should make this call as soon as possible after you are done sending emails.