Z-UNDO

This document covers the following topics:


Description

Undo addressees of a mail item, including invitations to a meeting.

If none of the addressees has read the mail item, you can undo the whole mail item. In this case, it is not required to specify the parameter Address-index.

If the mail item has already been read by one of the addressees, you can only remove an addressee who has not yet read the mail item. In this case, you have to specify the addressee to be undone in the parameter Address-index. For example, to undo the 7th addressee, specify "7" in the parameter Address-index.

If you want to undo mail to all addressees who have not yet read the mail item, specify "-1" in the parameter Address-index.

You cannot undo the whole mail item, if it has been sent to an external addressee (e.g. SNADS).

When repeated delivery has been specified for a mail item, an X is returned in the parameter Repeated-delivery. This means that the counter for repeated delivery has been reset to zero. The addressees, however, have not yet been undone. In this case, you have to invoke Z-UNDO once more to undo the addressees.

When the sent mail item has not been undone completely (i.e. if there are still addressees who have received the mail item), an X is returned in the parameter Sent.

The return code 93 indicates that more than 500 Adabas calls were made and some addressees could not be undone. In this case, the user should execute any program providing screen input/output to prevent the NAT3009 error in online mode.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet in which the mail item or invitation is to be undone.
Password A8 R   The password of the above cabinet.
ISN P10 R X Input: ISN of the mail item or invitation to be undone. Output: ISN of the mail item or invitation that has been undone.
Address-index P7 O   Do not specify this parameter, if you want to undo the whole mail item. To undo only the nth addressee, specify "n". This value can be obtained with Z-ALISTM. If you want to undo mail to all addressees who have not yet read the mail item, specify "-1".
Repeated-delivery A1   X X indicates that repeated delivery has been reset to zero.
Sent A1   X X indicates that the mail item has not been undone completely.

Return Codes

00 Success
02 Invalid cabinet name
03 Password incorrect
04 ISN was not found
18 API context buffer not available
24 Security violation
90 No address list or mailed item found
91 Mail item cannot be undone since it has been already been read, or it has been sent to an external addressee
92 No addressee exists for specified Address-index
93 Some addressees have not been undone
94 Only the last version of a meeting can be undone
99 Undo is not valid for this item

Subprograms

Z-0420
Z-0420A
Z-100
Z-110
Z-120
Z-122
Z-123
Z-124
Z-165
Z-175
Z-180
Z-190
Z-194
Z-197
Z-209
Z-216
Z-222
Z-223
Z-400
Z-401
Z-711
Z-711A
Z-728
Z-729
Z-734
Z-735
Z-736
Z-737
Z-1200&0

Example

* Undo addressees
*
DEFINE DATA
LOCAL
*
1 RETURN-CODE       (N2)
1 CABINET           (A8)
1 PASSWORD          (A8)
1 ISN               (P10)
1 ADDRESS-INDEX     (P7)
1 REPEATED-DELIVERY (A1)
1 SENT              (A1)
*
END-DEFINE
*
MOVE 'Cabinet'  TO CABINET
MOVE 'Password' TO PASSWORD
MOVE 70680      TO ISN
MOVE 2          TO ADDRESS-INDEX
*
CALLNAT 'Z-UNDO'
  RETURN-CODE
  CABINET
  PASSWORD
  ISN
  ADDRESS-INDEX
  REPEATED-DELIVERY
  SENT
*
WRITE
  '=' CABINET  /
  '=' PASSWORD /
  '=' ISN      /
*
IF SENT NE ' '
  WRITE '   Sent (undone) addressees still exist!' SENT /
END-IF
*
IF REPEATED-DELIVERY NE ' '
  WRITE '   Only repeated delivery undone' REPEATED-DELIVERY /
END-IF
*
IF RETURN-CODE NE 0
  WRITE / 'Return code' RETURN-CODE
ELSE
  WRITE / 'Return status OK'
END-IF
*
END