Xmitip User Reference Guide

1685787559
ADVERTISEMENT
Xmitip user reference guide

File Name: XMITIP-Guide.pdf

File Size: 796.04 KB

File Type: Application/pdf

Last Modified: 1 year

Status: Available

Last checked: 1 days ago!

This Document Has Been Certified by a Professional

100% customizable

Language: English

We recommend downloading this file onto your computer

Summary

XMITIP User Reference Guide
SMTP (E-Mail) from z/OS to the World
Version 18.03 Revised March 28, 2018
Lionel B. Dyck
E-Mail: [email protected]
XMITIP User Reference Guide Page 1 of 54 8/6/2021
Table of Contents
Table of Contents ............................................................................................................................2
Introduction ....................................................................................................................................5
Acknowledgements.........................................................................................................................6
Local Customizations (alter this section for your site and republish for your users) ...........................7
Using XMITIP in Batch .....................................................................................................................8
Usage Notes ...................................................................................................................................9
Performance Considerations ........................................................................................................................................ 9
XMITIP - The Command (syntax) ................................................................................................... 10
To-Address .................................................................................................................................................................. 11
Other Keywords .............................................................................................................................................................. 11
AddressFile and AddressFileDD .................................................................................................................................. 11
ASA ............................................................................................................................................................................. 12
BCC ............................................................................................................................................................................. 12
CC................................................................................................................................................................................ 12
CONFIG ....................................................................................................................................................................... 12
CONFIGDD .................................................................................................................................................................. 13
DEBUG ........................................................................................................................................................................ 13
EMSG .......................................................................................................................................................................... 13
ERRORSTO .................................................................................................................................................................. 13
FILE ............................................................................................................................................................................. 13
FILEDD ........................................................................................................................................................................ 13
FILEDESC ..................................................................................................................................................................... 14
FILENAME ................................................................................................................................................................... 14
FILEO ........................................................................................................................................................................... 14
FOLLOWUP ................................................................................................................................................................. 14
FORMAT...................................................................................................................................................................... 15
FORMAT TXT ........................................................................................................................................................... 15
FORMAT CSV .......................................................................................................................................................... 15
FORMAT BIN ........................................................................................................................................................... 15
FORMAT GIF ........................................................................................................................................................... 15
FORMAT ICAL .......................................................................................................................................................... 15
FORMAT HTML ....................................................................................................................................................... 15
FORMAT PDF .......................................................................................................................................................... 16
FORMAT RTF ........................................................................................................................................................... 17
FORMAT XMIT ........................................................................................................................................................ 18
FORMAT ZIP ............................................................................................................................................................ 18
FORMAT ZIPBIN ...................................................................................................................................................... 18
FORMAT ZIPCSV...................................................................................................................................................... 18
FORMAT ZIPGIF ...................................................................................................................................................... 19
FORMAT ZIPHTML .................................................................................................................................................. 19
FORMAT ZIPPDF ..................................................................................................................................................... 19
FORMAT ZIPRTF ...................................................................................................................................................... 19
FORMAT ZIPXMIT ................................................................................................................................................... 20
FROM .......................................................................................................................................................................... 20
HLQ ............................................................................................................................................................................. 20
HTML .......................................................................................................................................................................... 20
IDVAL .......................................................................................................................................................................... 20
IMPORTANCE .............................................................................................................................................................. 21
XMITIP User Reference Guide Page 2 of 54 8/6/2021
IGNORECC ................................................................................................................................................................... 21
IGNOREENC ................................................................................................................................................................ 21
IGNORESUFFIX ............................................................................................................................................................ 21
LANG ........................................................................................................................................................................... 21
MACH ......................................................................................................................................................................... 21
MARGIN ...................................................................................................................................................................... 21
MSGDD ....................................................................................................................................................................... 21
MSGDS ........................................................................................................................................................................ 22
MSGQ ......................................................................................................................................................................... 22
MSGT .......................................................................................................................................................................... 22
MSG72 ........................................................................................................................................................................ 22
MURPHY ..................................................................................................................................................................... 22
NOCONFIRM ............................................................................................................................................................... 22
NOEMPTY ................................................................................................................................................................... 23
NOIDVAL ..................................................................................................................................................................... 23
NOMSG ....................................................................................................................................................................... 23
NORTFXLATE ............................................................................................................................................................... 23
NOSPOOF .................................................................................................................................................................... 23
NOSTRIP ...................................................................................................................................................................... 23
PAGE ........................................................................................................................................................................... 23
PDFIDX ........................................................................................................................................................................ 24
PRIORITY ..................................................................................................................................................................... 24
RC0 ............................................................................................................................................................................. 24
RECEIPT ....................................................................................................................................................................... 24
REPLYTO ..................................................................................................................................................................... 24
RESPOND .................................................................................................................................................................... 24
SENSITIVITY................................................................................................................................................................. 25
SIG .............................................................................................................................................................................. 25
SIGDD.......................................................................................................................................................................... 25
SUBJECT ...................................................................................................................................................................... 25
TLS .............................................................................................................................................................................. 26
TPAGELEN ................................................................................................................................................................... 26
VIANJE ........................................................................................................................................................................ 26
ZIPMETHOD ................................................................................................................................................................ 26
ZIPPASS ....................................................................................................................................................................... 26
Minimum required syntax: ............................................................................................................................................. 28
XMITIP Examples .......................................................................................................................... 29
Example 1: Send a PDS Member with No Message ....................................................................................................... 29
Example 2: Send a message to One Address. ................................................................................................................ 29
Example 3: Send a Message with CC and FROM specified............................................................................................. 30
Example 4: Send a Single PDS Member To One Address. .............................................................................................. 30
Example 5: Send a Dataset in Landscape with a 9 point font. ....................................................................................... 30
Example 6: Send a Passed Dataset to a List using Blind Copies. .................................................................................... 30
Example 7: Send a Dataset Using an AddressFile Dataset: ............................................................................................ 31
Example 8: Using MSGQ................................................................................................................................................. 31
Example 9: Send a SYSOUT file as a Text Attachment: .................................................................................................. 32
Example 10: Send a Dataset in RTF Format using ZIP to save space .............................................................................. 32
Example 11: Send a Comma Separated Value (CSV) Dataset. ....................................................................................... 33
Example 12: Sample using MSGT .................................................................................................................................. 33
Example 13: Using a XMITIP Configuration File ............................................................................................................. 34
Example 14: Sending a Message to a Pager if Job Abnormally Ends ............................................................................. 34
Example 15: Splitting a Report into Individual E-Mails based on a KeyValue ................................................................ 35
Example 16: PDF creation example using a PDF Configuration File ............................................................................... 36
XMITIP User Reference Guide Page 3 of 54 8/6/2021
XMITIPTD – Timed Delivery Routine .............................................................................................. 37
XMITIPSP – File Split/Separation Utility ......................................................................................... 38
XMITIPSP Syntax ............................................................................................................................................................. 38
XMITIPSP Control Statements ........................................................................................................................................ 38
COMBINE .................................................................................................................................................................... 38
FILENAME ................................................................................................................................................................... 38
GMAIL ......................................................................................................................................................................... 39
KEYMAIL ..................................................................................................................................................................... 39
KEYPREF ...................................................................................................................................................................... 39
KEYV............................................................................................................................................................................ 39
KEYSUBJ ...................................................................................................................................................................... 39
MERGEMAIL ............................................................................................................................................................... 40
MSGDD ....................................................................................................................................................................... 40
MSGDS ........................................................................................................................................................................ 40
MSGSTART .................................................................................................................................................................. 40
MSGEND ..................................................................................................................................................................... 40
SEPLINES ..................................................................................................................................................................... 40
SEPLOC........................................................................................................................................................................ 40
SEPPAGES ................................................................................................................................................................... 40
SUBJECT ...................................................................................................................................................................... 41
TO ............................................................................................................................................................................... 41
XMITIPCONFIG ............................................................................................................................................................ 41
XMITIPSP Required Statements ..................................................................................................................................... 41
XMITIPSP Mutually Exclusive Statements ...................................................................................................................... 41
XMITIPSP Required JCL ................................................................................................................................................... 41
ISPF Dialog.................................................................................................................................... 42
Batch JCL and XMITIP Generation from the ISPF Dialog................................................................................................. 44
Address List Dialog ......................................................................................................................................................... 46
File Attachment Panel .................................................................................................................................................... 47
Format Prompting .......................................................................................................................................................... 47
XMITIP Tools ................................................................................................................................. 49
ALLOCGDG ...................................................................................................................................................................... 49
EDIMAIL .......................................................................................................................................................................... 49
MAILFILE ......................................................................................................................................................................... 49
MAILHFSE ....................................................................................................................................................................... 49
SETSDSFK and XMITSDSF ................................................................................................................................................ 50
TXT2HTML ...................................................................................................................................................................... 51
TXT2RTF .......................................................................................................................................................................... 51
TXT2PDF ......................................................................................................................................................................... 52
XMITIPED ........................................................................................................................................................................ 52
XMITIPFE......................................................................................................................................................................... 52
XMITIPPD ........................................................................................................................................................................ 52
XMITBULK ....................................................................................................................................................................... 52
Reading the Attachment on the Workstation: ............................................................................... 53
Change History ............................................................................................................................. 54
XMITIP User Reference Guide Page 4 of 54 8/6/2021
Introduction
XMITIP is a mainframe based electronic mail application that is capable of sending electronic mail to any
valid Intranet or Internet address. Along with messages, XMITIP can also send mainframe files in one of
several different file attachment formats. The recipients can be on any mail system that connects to the
Internet (the world) or Intranet (in house). The Simple Mail Transport Protocol, or SMTP, is used for sending
the mail with data sets attached using the appropriate SMTP statements

The name, XMITIP, derives from the TSO TRANSMIT command, which has an alias of XMIT, and from IP,
which stands for Internet Protocol. Thus XMITIP is TSO TRANSMIT using the Internet Protocol

XMITIP can be executed as a step within a batch job, under TSO as a command, or under ISPF using a robust
ISPF interface. It can also be used within an automated operations tool to generate messages related to system
events

XMITIP can be used very effectively as a step within a batch job to send a report generated by that job via
electronic mail rather than printing the report. With this approach the report will arrive in the intended users
electronic mail inbox within a few minutes after the job completes. This is much faster than waiting for the
hours for the report to be printed, removed from the printer, separated from the other reports that were printed
at the same time, and then delivered or placed in a mail box for pickup. The user can then view the report
online or print as their needs dictate

Some of the features of XMITIP are:
- send electronic mail to one or more addresses
- send a quick message as a page
- send one or more data sets as file attachments in one of the following formats: plain text, HTML, Rich
Text Format (RTF), Portable Document Format (PDF), Comma Separated Value (CSV), TSO Transmit
(XMIT), and binary
- supports address lists
- supports CC and BCC
- supports Priority, Sensitivity, and Importance
- The ISPF interface:
- field level help for all entry fields
- validation of all entered fields
- address table for lookup and selection
- data set table for multiple data set selection and formatting
- reports the complete XMITIP command syntax generated
- option to create a file with a complete Batch Job which can be submitted, browsed, edited, or copied

The ISPF interface is an excellent tool to use to model the XMITIP usage and once it is working completely
then the generated command can be integrated into a batch job step or TSO application

Included with the XMITIP package are several tools that can be used to invoke XMITIP from other
applications. These tools interface to XMITIP from SDSF, from IOF, and from other ISPF applications

XMITIP is written almost completely in z/OS REXX, with one z/OS Assembler program that performs the
MIME (Multipurpose Internet Mail Encoding) used for PDF and Binary attachments. The ISPF interface is
also written in z/OS REXX using the z/OS ISPF APIs

This is an evolving application and any comments, suggestions, or bugs should be reported to the author's e-
mail ([email protected]). Please indicate the version of XMITIP that you are using in any e-mail

XMITIP User Reference Guide Page 5 of 54 8/6/2021
Acknowledgements
I would like to acknowledge the contributions of the following individuals who provided pieces of the
XMITIP application that you are now installing:
IBM for significant assistance in answering various SMTP issues over the years

Dana Mitchell for the Interlink support information

Doug Adams for many ISPF table-coding examples, including the excellent FIND routines

Doug Nadel for the routine to convert a number to include commas

Felipe Cvitanich for his contributions of the national language enablement tools

Joel Ewing for his contribution to the XMITIPSP code

John Ellis for his contributions, including the interface to UDSMTP and the code to process all, or selected
via mask, members of a PDS

Leland Lucius for his contributions of the PDF conversion routine, the initial routine to do MIME
conversion, and the time zone detection routine. Most recently for the PDF security routines and
enhancements to the TXT2PDF code

L. A. Thomas for taking the time to provide extensive suggestions on documents, the ISPF help panels, the
ISPF dialog, and the processing of the application

Mark Regan for setting up the XMITIP Listserv group on Yahoo

Mark Feldman for the XMITB64 assembler program

Mike Porter for the UDSMTP program

Ken Tomiak and Barry Gilder for their contribution of the REXX routine CONDCODE that is used to
capture the step completion information for the active job

Paul Wells for providing the Murphy (XMITIPMU) REXX routine

Rich Stuemke for the Machine Carriage Control information

Wolfram Schwenzer for code to support the characters \{} in the RTF files

Hartmut Beckmann for numerous enhancements and suggestions

Alain Janssens for the code in TXT2HTML to convert CSV files to HTML tables
Yvon Roy for code to detect daylight savings time

Plus numerous individuals who have performed the task of beta testing as well as others who took the time to
send me comments, suggestions, and bug reports

XMITIP User Reference Guide Page 6 of 54 8/6/2021
Local Customizations (alter this section for your site and republish for your users)
Some of the local customizations that you need to be aware of are:
1. ZIP option
The ZIP option is enabled and utilizes PKZIP/MVS. This utility is only available on a few of the
systems. Before relying upon this option you should verify that the ZIP utility is available on the
systems upon which your jobs will be executing

2. PKZIP/MVS is not licensed on all systems. Thus if using a ZIP option in XMITIP the following JCL
statement must be inserted into the batch JCL after the JOB statement:
//JBS BIND PKZIP.LIC
3. The Data Set used in batch mode on the //SYSEXEC DD depends upon the environment:
Environment Data Set Name
Hawaii SYS2.USER.CMDPROC
National SYS1.USER.REXX
Northern California SYS2.REXX.EXEC
XMITIP User Reference Guide Page 7 of 54 8/6/2021
Using XMITIP in Batch
When using XMITIP in batch using the Batch TMP some suggestions and restrictions to be aware of are:
1. The data set name format is the same as under TSO. Fully qualify with single quotes or be aware of
what your TSO PROFILE PREFIX is set to as the prefix will be appended to the start of the data set
name if it is not fully qualified

2. The SYSTSIN DD will ignore any text in columns 73 to 80

3. Statements in the XMITIP command can be continued to additional statements by coding either a
plus (+) or a minus (-) at the end of the statement to be continued. A plus (+) is recommended as it
pass less white space within the merged command

4. Messages are reported in the SYSTSPRT DD
XMITIP User Reference Guide Page 8 of 54 8/6/2021
Usage Notes
Some considerations for using XMITIP are:
1. Use a SUBJECT to inform the recipient what the e-mail is about
2. Always use a FROM address which should map to your normal e-mail address on your production e-
mail system. This allows the recipient to easily reply to your e-mail address. If you forget a FROM
then a default FROM is generated using the e-mail address of the TSO session or the userid of the
Batch JOB

3. The largest record length supported is either 998 or 1024. The SMTP standards (RFC 2821) define a
limit of 998 bytes per record while the IBM SMTP limit is 1024 bytes. There is an installation
customization option for XMITIP that defines which limit is enforced

4. Before implementing XMITIP into a production process run several tests to verify that the results
(e.g. the report format) are what you expect

Use the ISPF dialog to experiment with the various XMITIP options and use the generated XMITIP JCL and
command as a starting point for a production implementation

Performance Considerations
There is overhead to using this utility however if the usage is infrequent then that overhead is normally
acceptable. One of the reasons the DEBUG keyword was added to the tool was to provide information on
what the SMTP data stream consists of so that a programmer can take that and implement it in their program
for their specific purposes

XMITIP User Reference Guide Page 9 of 54 8/6/2021
XMITIP - The Command (syntax)
XMITIP is a normal TSO command and must be executed under TSO or using the batch terminal monitor
program (TMP). See the Examples section for examples of the JCL which can be used, the complete syntax is:
%XMITIP [email protected]
or ([email protected] [email protected]..)
or *list-id*
or *
AddressFile
AddressFileDD
ASA or MACH or IGNORECC
BCC [email protected]
or BCC ([email protected] [email protected] ..)
CC [email protected]
or CC ([email protected] [email protected] ..)
CONFIG filename
or CONFIGDD ddname
DEBUG
EMSG
ERRROSTO [email protected]
FILE dsn
or FILE (dsn1 dsn2 ...)
FILEDD ddn1
or FILEDD (ddn1 ddn2 ...)
FILEDESC file-description
or FILEDESC (desc1 desc2 ...)
FILENAME filename
or FILENAME (file1 file2 ..)
FILEO hfs-file-name
or FILEO (hfs-file-name1 hfs-file-name2 ..)
FOLLOWUP date
FORMAT options (see the doc)
FROM [email protected]
HLQ high-level-qualifier
HTML (for MSGDx only)
IDVAL
IGNORESUFFIX
IMPORTANCE High Normal or Low
LANG default_language
MARGIN Lm/Rm/Tm/Bm
or MARGIN (Lm/Rm/Tm/Bm Lm/Rm/Tm/Bm ...)
MSGDS data-set-name
or MSGDS *
or MSGDD ddname or MSGQ or MSGT
or NOMSG (if no MSGDS, MSGDD, MSGT or MSGQ)
MSG72
Murphy
NOConfirm
NoRTFXlate
NoSpoof
NOStrip
PAGE ‘page message text’
PDFIDX row/column/length
PRIORITY Urgent Normal or Non-Urgent
RC0
RECEIPT [email protected]
REPLYTO [email protected]
RESPOND option(s)
SENSITIVITY Private Personal or Confidential
SIG dsname or SIGDD ddname
SUBJECT 'subject text'
TLS On or Off
VIANJE ‘NJE-Node’
ZIPMETHOD zip-compression-method
ZIPPASS password for zip files
XMITIP User Reference Guide Page 10 of 54 8/6/2021
The command syntax is keyword or keyword followed by an option with no intervening equal sign. If
multiple options are used then they are enclosed within parentheses

%XMITIP is the command. The % indicates that the command is a REXX Exec and not a compiled
command. If entered without any parameters either an error message will be generated or, if executed under
ISPF it will invoke the ISPF interface. The command requires a minimum set of parameters to function,
including a to-address and either a message keyword (msgds, msgdd, or msgq) or a file attachment (file,
filedd, or fileo). Use of msg72 will limit the message text to the first 72 columns (to avoid sequence
numbers)

To-Address
The only positional parameter to XMITIP is the To-Address, which is the electronic mail address of the
intended recipient. Note that you do not code To-Address rather you code the actual address of the recipient

The format of this parameter is:
- address
e.g. [email protected]
- “name”


e.g. “First Last”
- (address1 address2 …)
multiple addresses are enclosed with parentheses separated by at least one blank or a comma
- (“name1” “name2” …)
multiple addresses are enclosed with parentheses separated by at least one blank or a comma
- *
an asterisk is used if you are using the ADDRESSFILE or ADDRESSFILEDD keywords to define a
distribution list of addresses. The single asterisk will result in the To field being blank on the users e-mail

- *address-list-description*
this is similar to the usage of a single asterisk except that the text enclosed by the two asterisks will be
specified on in the To field and will appear in the users e-mail. There must be no blanks between the two
asterisks

The name within quotes, referred to in this document as the qualified address, will appear in the users inbox
rather than the e-mail address

Other Keywords
The remaining keywords used by XMITIP are not positional or required. The keywords will be presented in
alphabetical order below

AddressFile and AddressFileDD
These keywords describe a sequential data set or member of a partitioned data set that contains a distribution
list of addresses. The syntax is:
ADDRESSFILE data-set-name
Or
ADDRESSFILEDD ddname
AddressFile may be abbreviated as AFile

AddressFileDD may be abbreviated as AFileDD

The format of the address list is:
Column 1: * for a comment or an action (To, CC, BCC, FROM or REPLYTO)
Started one blank after the action is a valid e-mail address (See the recipient address description for the
allowed formats)

XMITIP User Reference Guide Page 11 of 54 8/6/2021
Example:
* Sample XMITIP AddressFile Address List
To [email protected]
Cc [email protected]
Bcc [email protected]
Cc “Fourth Last” [email protected]
From [email protected]
ReplyTo [email protected]
Note that the address list is case insensitive. The text can be all upper case, all lower case, or mixed case with
no problems

Use of qualified addresses is also allowed

ASA
ASA instructs XMITIP to assume that the file attachments contain ASA carriage control. The default is to use
the carriage control defined in the DCB of the input data set. This keyword should be used if FILEDD is used
and refers to a data set on VIO

(see MACH and IGNORECC)

BCC
BCC is the Blind Carbon Copy address keyword. The syntax is:
BCC [email protected]
Or
BCC (fi[email protected] [email protected] [email protected] …)
Note that with the BCC the qualified name (within quotes) is not required or used

CC
CC is the keyword for Carbon Copy. The syntax is similar to that for BCC except that the qualified name may
be coded as it will be used if provided:
CC [email protected]
Or
CC “First Last”
Or
CC (“First Last” “Second Last” < [email protected]>
[email protected] …)
CONFIG
This option allows the user to define a XMITIP configuration file containing XMITIP keywords and options
for the current XMITIP execution. The configuration file must be a sequential dataset or a member of a PDS

CONFIG data-set-name
CONFIG may be abbreviated as CFG

Notes:
• Only data in columns 1 to 72 are used (to avoid sequence numbers)
• A ‘+’ or ‘-‘ may be used as a continuation character if desired but it is optional
• Keywords and options may span records
• Any keywords used will over-ride any specified on the XMITIP command
• Both CONFIG and CONFIGDD may be specified multiple times in one command
• Both CONFIG and CONFIGDD are recursive (you can include them in other configuration files)
• The last occurrence of a keyword is the one that is used
• An * in column 1 indicates a comment
XMITIP User Reference Guide Page 12 of 54 8/6/2021

- data set table for multiple data set selection and formatting - reports the complete XMITIP command syntax generated - option to create a file with a complete Batch Job which can be …

Download Now

Documemt Updated

ADVERTISEMENT

Popular Download

ADVERTISEMENT

Frequently Asked Questions

What is xmitip?

XMITIP is an z/OS application written in z/OS REXX with an optional z/OS TSO ISPF front-end. In the package is full Users Guide (in Adobe Acrobat PDF format, Microsoft Word, and RTF formats) and an Installation Guide (in Adobe Acrobat PDF format and Microsoft Word).

How do i continue a xmitip command?

Statements in the XMITIP command can be continued to additional statements by coding either a plus (+) or a minus (-) at the end of the statement to be continued. A plus (+) is recommended as it pass less white space within the merged command. 4. Messages are reported in the SYSTSPRT DD XMITIP User Reference Guide Page 9of 548/6/2021

What are the jcl xmitipsp requirements?

XMITIPSP Required JCL XMITIPSP must be run under the Terminal Monitor Program (TMP) either in the foreground or in batch. All the standard TMP DD’s are required (SYSPRINT, SYSTSPRT, and SYSTSIN) along with the REPORT DD which is where the XMITIPSP processing report will be written. XMITIP User Reference Guide Page 42of 548/6/2021 ISPF Dialog

What format is used to send a dataset to xmitip?

FORMAT XMIT This format is used when sending a dataset created by the TSO Transmit command. The dataset will be attached as a binary file attachment. If the input is not in TSO Transmit format then XMITIP will use TSO Transmit to put it into XMIT format. FORMAT ZIP