This document covers the following topics:
Return the mail status message of a specific user, the time range in which it is to appear and Cc information.
If Cc is specified in the mail status message, it informs who is to receive a copy of each mail item that is sent to this user.
The timezone is always GMT. Other timezones are not considered.
This subprogram is similar to Z-MLGETA with the exception that it also returns the Cc information.
This subprogram can be invoked prior to Z-MAILA or Z-MAILAX to find out whether the user has set a mail status message. However, it can also be used independently.
You cannot specify more than one ID in the Cabinet parameter. If you want to get the mail status message for several users, you must invoke this subprogram for each user.
For another cabinet than your own, the mail status message is only returned when it has been activated (i.e. when the user has marked the "Set Mail Status Message" field).
For your own cabinet, the mail status message is also returned when it has not been activated.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | X | ||
| Cabinet | A8 | R | The cabinet in which the mail status message is to be returned. | |
| Active | A1 | X | If marked, the mail status message has been activated. | |
| Start-date | A8 | X | Format yyymmdd. | |
| Start-time | A4 | X | Format hhmm. | |
| End-date | A8 | X | Format yyymmdd. | |
| End-time | A4 | X | Format hhmm. | |
| Mail-status-message | A37/1:10 | X | The text of the mail status message. | |
| Cc-flag | A1 | X | If marked, Cc has been set. | |
| Cc | A20 | X | ||
| Cc-address-type | N2 | X | One of the following: 1=address (nickname), 4=bulletin board, 5=cabinet, 33=user ID. | |
| Cc-address-source | A1 | X | Only if Cc-address-type is 1 (address): S=address is from cabinet SYSCNT. Blank=address is from Cabinet-name. | |
| Cc-last-first-name | A20 | X | Only if Cc-address-type is 1 (external address) or 33 (user ID). Blank if Cc-address-type is 1 and this is not an external address (e.g. nickname for user ID). | |
| Cc-node-name | A8 | X | Only if Cc-address-type is 1 (external address). Node name if this is a nickname for an external node. Blank if this is not a Cc for an external node. | |
| Cc-status | A1 | X | Blank=Cc is valid. X=Cc of given Cc-address-type was not found in Con-nect. |
| 00 | Success |
| 02 | Invalid cabinet name or - in batch mode only - locked cabinet |
Z-723
0010 ********************************************************************* 0020 * Return the mail status message of a user 0030 ********************************************************************* 0040 * 0050 DEFINE DATA 0060 * 0070 LOCAL 0080 * 0090 1 RETURN-CODE (N2) 0100 1 CABINET (A8) 0110 1 ACTIVE (A1) 0120 1 START-DATE (A8) 0130 1 START-TIME (A4) 0140 1 END-DATE (A8) 0150 1 END-TIME (A4) 0160 1 MAIL-STATUS-MESSAGE (A37/1:10) 0170 1 CC-FLAG (A1) 0180 1 CC (A20) 0190 1 CC-ADDRESS-TYPE (N2) 0200 1 CC-ADDRESS-SOURCE (A1) 0210 1 CC-LAST-FIRST-NAME (A20) 0220 1 CC-NODE-NAME (A8) 0230 1 CC-STATUS (A1) 0240 * 0250 END-DEFINE 0260 * 0270 * Input API parameters 0280 * 0290 INPUT (AD=I'_') 0300 // 25X '********** Z-MLGETB **********' // 0310 ' Cabinet' CABINET / 0320 * 0330 CALLNAT 'Z-MLGETB' 0340 RETURN-CODE 0350 CABINET 0360 ACTIVE 0370 START-DATE 0380 START-TIME 0390 END-DATE 0400 END-TIME 0410 MAIL-STATUS-MESSAGE(*) 0420 CC-FLAG 0430 CC 0440 CC-ADDRESS-TYPE 0450 CC-ADDRESS-SOURCE 0460 CC-LAST-FIRST-NAME 0470 CC-NODE-NAME 0480 CC-STATUS 0490 * 0500 IF RETURN-CODE EQ 0 0510 WRITE NOTITLE NOHDR 0520 '=' CABINET / 0530 '=' ACTIVE // 0540 'Mail status message :' // 0550 ' 1' MAIL-STATUS-MESSAGE (1) / 0560 ' 2' MAIL-STATUS-MESSAGE (2) / 0570 ' 3' MAIL-STATUS-MESSAGE (3) / 0580 ' 4' MAIL-STATUS-MESSAGE (4) / 0590 ' 5' MAIL-STATUS-MESSAGE (5) / 0600 ' 6' MAIL-STATUS-MESSAGE (6) / 0600 ' 6' MAIL-STATUS-MESSAGE (6) / 0610 ' 7' MAIL-STATUS-MESSAGE (7) / 0620 ' 8' MAIL-STATUS-MESSAGE (8) / 0630 ' 9' MAIL-STATUS-MESSAGE (9) / 0640 '10' MAIL-STATUS-MESSAGE (10) // 0650 '=' START-DATE 30T '=' START-TIME / 0660 '=' END-DATE 30T '=' END-TIME // 0670 'Mark' CC-FLAG 0680 'to set CC:' CC 0690 'CC Type:' CC-ADDRESS-TYPE 0700 'CC Source:' CC-ADDRESS-SOURCE 0710 'CC STATUS:' CC-STATUS / 0720 'Last/First Name:' CC-LAST-FIRST-NAME 0730 'Node:' CC-NODE-NAME 0740 ELSE 0750 WRITE '=' RETURN-CODE 0760 END-IF 0770 * 0780 END