Sub-Field: 3.91

Parent File	Name	Number	Package
MESSAGE(#3.9)	RECIPIENT	3.91	MailMan

Field #	Name	Loc	Type	Details
.01	RECIPIENT	0;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>85!($L(X)<1) X` LAST EDITED: `JUL 30, 1997` HELP-PROMPT: `Answer must be 1-85 characters in length.` DESCRIPTION: The name of a recipient of this message. TECHNICAL DESCR: In a future patch, the field should be lengthened, perhaps to 99. UNEDITABLE CROSS-REFERENCE: `3.91^C` 1)= S ^XMB(3.9,DA(1),1,"C",$E(X,1,30),DA)="" 2)= K ^XMB(3.9,DA(1),1,"C",$E(X,1,30),DA)
1	LAST RESPONSE READ	0;2	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>99999)!(X<0)!(X?.E1"."1N.N) X` LAST EDITED: `JUL 28, 1997` HELP-PROMPT: `Type a Number between 0 and 99999, 0 Decimal Digits` DESCRIPTION: `The last response which this recipient read.` It actually points into 3.9001, the Response multiple for this message.
2	LAST READ DATE/TIME	0;3	DATE	INPUT TRANSFORM: `S %DT="ETXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `JUL 30, 1997` DESCRIPTION: The date and time this recipient last read this message.
3	REMOTE MESSAGE ID	0;4	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>45!($L(X)<3) X` LAST EDITED: `JUL 28, 1997` HELP-PROMPT: `Answer must be 3-45 characters in length.` DESCRIPTION: The identifier of the message at the remote location. Format: message ID@site TECHNICAL DESCR: In a future patch, this field should be lengthened, perhaps to 110 chars.
4	TRANSMISSION DATE/TIME	0;5	DATE	INPUT TRANSFORM: `S %DT="ETXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `JUL 30, 1997` DESCRIPTION: The date and time the remote message was transmitted.
5	STATUS	0;6	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<1) X` LAST EDITED: `JAN 20, 1984` HELP-PROMPT: `ANSWER MUST BE 1-30 CHARACTERS IN LENGTH` DESCRIPTION: `This field holds the status of the recipient, if the recipient is other than a local user. If this is a device, the status is "Awaiting Device" until the device has printed the message. If this is a server, the status` will be "Awaiting Server" until the server has read the message. In either of the above cases, the status becomes "done" when the process is complete, and "Last read" field describes when the process was complete. If the recipient is a remote user, the status is "awaiting transmission" and the Path field names the queue in which the message is waiting. When the message has been sent, the Transmission date is set, the remote message ID is set to the other domain's message number (providing bi-directional linkage of messages), and the Path field is cleared.
6	PATH	0;7	POINTER TO DOMAIN FILE (#4.2)	DOMAIN(#4.2) LAST EDITED: `SEP 20, 1992` DESCRIPTION: This field points to the queue in which this message resides. After transmission, the REMOTE MESSAGE ID field holds the message number and site to which the message was transmitted (which may be only a relay point). CROSS-REFERENCE: `3.91^AQUEUE` 1)= S ^XMB(3.9,DA(1),1,"AQUEUE",$E(X,1,30),DA)="" 2)= K ^XMB(3.9,DA(1),1,"AQUEUE",$E(X,1,30),DA) This cross reference makes it possible for network mail transmissions to immediately find the recipients to transmit a message to.
6.5	TYPE OF RECIPIENT	T;1	SET	'C' FOR cc; 'I' FOR Info; LAST EDITED: `AUG 11, 1997` DESCRIPTION: `This field indicates what type of recipient this is.` CC: indicates that the recipient is being sent a copy, but is not the primary recipient. He may reply. INFO: indicates that the recipient may not reply to the message; the message is being transmitted to him for information purposes only. These flags are set by the "Send to:" prompt by including them before a recipient name. "CC:JONES" would put JONES on the CC: list.
6.6	APPROVAL	T;2	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>65!($L(X)<1) X` LAST EDITED: `NOV 30, 1984` HELP-PROMPT: `ANSWER MUST BE 1-65 CHARACTERS IN LENGTH` DESCRIPTION: This field is set whenever the the recipient is named as a THRU: type, and issues the approval command after reading it.
7	TERMINATION DATE	D;1	DATE	INPUT TRANSFORM: `S %DT="ET" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `APR 24, 1984` DESCRIPTION: `This field, if set, inhibits MailMan from sending future replies to this message, allowing him to "drop out" of a conversation. This is accomplished with the "Terminate" option.` This field is displayed whenever a recipient queries the message. The drop-outs will have the notation "Terminated: mm/dd/yy" in their status line.
8	FORWARDED BY	F;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>110!($L(X)<1) X` LAST EDITED: `JUL 28, 1997` HELP-PROMPT: `Answer must be 1-110 characters in length.` DESCRIPTION: When a message is forwarded to another user, this field names the person who did the forwarding, along with the date and time that this was done. It is displayed in the query option after reading. UNEDITABLE
8.01	FORWARDED BY (XMDUZ)	F;2	POINTER TO NEW PERSON FILE (#200)	NEW PERSON(#200) LAST EDITED: `JUL 28, 1997` HELP-PROMPT: `Who forwarded the message to this recipient?` DESCRIPTION: This field uses the XMDUZ variable to identify the user who forwarded the message.
8.02	FWD TYPE	F;3	SET	'F' FOR Filter-Forward; 'A' FOR Auto-Forward; 'R' FOR Regular-Forward; LAST EDITED: `NOV 28, 2001` HELP-PROMPT: `What kind of forwarding?` DESCRIPTION: `Regular-Forward - A user simply forwarded this message to the recipient in the .01 field. This is the default, if this field is null.` Auto-Forward - A user has a forwarding address listing the recipient in the .01 field. This message was sent to the user and then automatically forwarded to the recipient. Filter-Forward - A user has an active message filter listing the recipient in the .01 field as a "forward to" person. This message was sent to the user and then automatically forwarded to the recipient during message delivery.
8.03	FWD BY ORIGINAL	F;4	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>110!($L(X)<1) X` LAST EDITED: `NOV 28, 2001` HELP-PROMPT: `Answer must be 1-110 characters in length.` DESCRIPTION: This field is only used if FWD TYPE is Auto-Forward. This field lists the original user (and possibly the user's surrogate) who forwarded the message to the user with the forwarding address.
8.04	FWD TYPE ORIGINAL	F;5	SET	'F' FOR Filter-Forward; 'R' FOR Regular-Forward; LAST EDITED: `NOV 28, 2001` HELP-PROMPT: `What kind of forwarding, originally?` DESCRIPTION: `This field is only used if FWD TYPE is Auto-Forward. This field reveals how the message was forwarded to the user who had the forwarding address listing the recipient in the .01 field.` Regular-Forward - A user simply forwarded this message to the user with the forwarding address. This is the default, if this field is null. Filter-Forward - A user has an active message filter listing the user with the forwarding address as a "forward to" person. This message was sent to the user and then automatically forwarded to the user during message delivery. Note that Auto-Forward is not a possibility, because Auto-Forward is allowed only to remote recipients or to devices or servers.
8.5	COPIED DATE/TIME	C;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>15!($L(X)<1) X` LAST EDITED: `APR 22, 2002` HELP-PROMPT: `Answer must be 1-15 characters in length.` DESCRIPTION: When a message is copied by a user, this field indicates the date and time at which this was done. It is displayed in the query option after reading the message. TECHNICAL DESCR: `Before patch XM7.1110, this field was in external format. After that patch, this field is in internal FileMan format. The data have not been changed, so you may see either format, depending on when the message was` copied.
9	NETWORK TRANSMISSION TIME	0;8	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>999999)!(X<0)!(X?.E1"."1N.N) X` LAST EDITED: `FEB 22, 1988` HELP-PROMPT: `Type a Number between 0 and 999999, 0 Decimal Digits` DESCRIPTION: This field records the elapsed time (in seconds) during a network transmission. UNEDITABLE
10	PRIORITY RESPONSES?	0;9	SET	'0' FOR YES; '1' FOR NO; LAST EDITED: `JUL 28, 1997` DESCRIPTION: `This field overrides the MESSAGE TYPE field in the zero node of the message, but only if it contains a "P". In this way, some recipients can keep receiving responses to a 'Priority Message' as priority mail, while` others may choose not to. One cannot, however, force the responses of an ordinary message to be delivered as 'Priority Mail'.
11	FIRST READ DATE/TIME	0;10	DATE	INPUT TRANSFORM: `S %DT="ETXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `JUL 30, 1997` DESCRIPTION: Into this field is set the date and time that a message was first seen by the recipient.
12	SURROGATE READER	S;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>35!($L(X)<3) X` LAST EDITED: `APR 03, 1996` HELP-PROMPT: `Answer must be 3-35 characters in length.` DESCRIPTION: This is the name of the surrogate who last read this message.
13	FAX RECIPIENT	0;11	POINTER TO AN UNDEFINED FILE	LAST EDITED: `FEB 11, 1997` HELP-PROMPT: `Enter the fax recipient` DESCRIPTION: `When the message is addressed to a fax recipient, this field points to the fax rolodex file. After the message is handed off to the fax software, the pointer in this field is deleted and the Fax ID field is set to the` fax ID number assigned to it by the fax software. CROSS-REFERENCE: `3.91^AFAX` 1)= S ^XMB(3.9,DA(1),1,"AFAX",$E(X,1,30),DA)="" 2)= K ^XMB(3.9,DA(1),1,"AFAX",$E(X,1,30),DA) This cross reference makes it possible for MailMan to immediately find the recipients to fax a message to.
14	FAX ID	0;12	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>14!($L(X)<1) X` LAST EDITED: `FEB 11, 1997` HELP-PROMPT: `Answer must be 1-14 characters in length.` DESCRIPTION: This is the fax ID as assigned by the fax software (AKF*).
15	FILTER FORWARD	0;13	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X` LAST EDITED: `OCT 17, 2000` HELP-PROMPT: `Type a Number between 0 and 999, 0 Decimal Digits` DESCRIPTION: `This is the IEN of the user's filter which was activated during message delivery. The filter indicates that this message should be forwarded to the addressees listed in the FORWARD TO multiple of the activated filter.` If this field is set to zero, the message has been forwarded. TECHNICAL DESCR: `When this field is set to a positive number (the IEN of the user's activated filter), it causes the whole-file "AF" xref to be set.` Routine ^XMTDT checks for the existence of the "AF" xref. It will do the actual forwarding of the message. Once it finishes forwarding, it will set this field to zero, which will kill the xref and won't reset it. If the field is null, filter forwarding has not yet occurred for this message for this user. If the field is not null, it means that the message has already been (or is scheduled to be) filter forwarded once for this user, and should not be filter forwarded again for this user. FIELD INDEX: `AF (#174) REGULAR IR SORTING ONLY WHOLE FILE (#3.9)` Short Descr: See Technical Description Set Logic: S ^XMB(3.9,"AF",X,DA(1),DA)="" Set Cond: S X=(X>0) Kill Logic: K ^XMB(3.9,"AF",X,DA(1),DA) Whole Kill: K ^XMB(3.9,"AF") X(1): FILTER FORWARD (3.91,15) (Subscr 1) (forwards)

Field #

Name

Loc

Type

Details

.01

RECIPIENT

0;1

FREE TEXT

INPUT TRANSFORM: K:$L(X)>85!($L(X)<1) X
LAST EDITED: JUL 30, 1997
HELP-PROMPT: Answer must be 1-85 characters in length.

DESCRIPTION:

The name of a recipient of this message.

TECHNICAL DESCR:

In a future patch, the field should be lengthened, perhaps to 99.

UNEDITABLE

CROSS-REFERENCE: 3.91^C

1)= S ^XMB(3.9,DA(1),1,"C",$E(X,1,30),DA)=""

2)= K ^XMB(3.9,DA(1),1,"C",$E(X,1,30),DA)

1

LAST RESPONSE READ

0;2

NUMBER

INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JUL 28, 1997
HELP-PROMPT: Type a Number between 0 and 99999, 0 Decimal Digits

DESCRIPTION: The last response which this recipient read.

It actually points into 3.9001, the Response multiple for this message.

2

LAST READ DATE/TIME

0;3

DATE

INPUT TRANSFORM: S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUL 30, 1997

DESCRIPTION:

The date and time this recipient last read this message.

3

REMOTE MESSAGE ID

0;4

FREE TEXT

INPUT TRANSFORM: K:$L(X)>45!($L(X)<3) X
LAST EDITED: JUL 28, 1997
HELP-PROMPT: Answer must be 3-45 characters in length.

DESCRIPTION:

The identifier of the message at the remote location.  Format: message ID@site

TECHNICAL DESCR:

In a future patch, this field should be lengthened, perhaps to 110 chars.

4

TRANSMISSION DATE/TIME

0;5

DATE

INPUT TRANSFORM: S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUL 30, 1997

DESCRIPTION:

The date and time the remote message was transmitted.

5

STATUS

0;6

FREE TEXT

INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: JAN 20, 1984
HELP-PROMPT: ANSWER MUST BE 1-30 CHARACTERS IN LENGTH

DESCRIPTION: This field holds the status of the recipient, if the recipient is other than a local user. If this is a device, the status is "Awaiting Device" until the device has printed the message. If this is a server, the status

will be "Awaiting Server" until the server has read the message.  In either of the above cases, the status becomes "done" when the process is complete, and "Last read" field describes when the process was complete.

If the recipient is a remote user, the status is "awaiting transmission" and the Path field names the queue in which the message is waiting.  When the message has been sent, the Transmission date is set, the remote

message ID is set to the other domain's message number (providing bi-directional linkage of messages), and the Path field is cleared.

6

PATH

0;7

POINTER TO DOMAIN FILE (#4.2)

DOMAIN(#4.2)

LAST EDITED: SEP 20, 1992

DESCRIPTION:

This field points to the queue in which this message resides.  After transmission, the REMOTE MESSAGE ID field holds the message number and site to which the message was transmitted (which may be only a relay point).

CROSS-REFERENCE: 3.91^AQUEUE

1)= S ^XMB(3.9,DA(1),1,"AQUEUE",$E(X,1,30),DA)=""

2)= K ^XMB(3.9,DA(1),1,"AQUEUE",$E(X,1,30),DA)

This cross reference makes it possible for network mail transmissions to immediately find the recipients to transmit a message to.

6.5

TYPE OF RECIPIENT

T;1

SET

'C' FOR cc;
'I' FOR Info;

LAST EDITED: AUG 11, 1997

DESCRIPTION: This field indicates what type of recipient this is.

CC:  indicates that the recipient is being sent a copy, but is not the primary recipient.  He may reply.

INFO: indicates that the recipient may not reply to the message; the message is being transmitted to him for information purposes only.

These flags are set by the "Send to:" prompt by including them before a recipient name.  "CC:JONES" would put JONES on the CC: list.

6.6

APPROVAL

T;2

FREE TEXT

INPUT TRANSFORM: K:$L(X)>65!($L(X)<1) X
LAST EDITED: NOV 30, 1984
HELP-PROMPT: ANSWER MUST BE 1-65 CHARACTERS IN LENGTH

DESCRIPTION:

This field is set whenever the  the recipient is named as a THRU: type, and issues the approval command after reading it.

7

TERMINATION DATE

D;1

DATE

INPUT TRANSFORM: S %DT="ET" D ^%DT S X=Y K:Y<1 X
LAST EDITED: APR 24, 1984
DESCRIPTION: This field, if set, inhibits MailMan from sending future replies to this message, allowing him to "drop out" of a conversation. This is accomplished with the "Terminate" option.
```
This field is displayed whenever a recipient queries the message.  The drop-outs will have the notation "Terminated: mm/dd/yy" in their status line.
```

8

FORWARDED BY

F;1

FREE TEXT

INPUT TRANSFORM: K:$L(X)>110!($L(X)<1) X
LAST EDITED: JUL 28, 1997
HELP-PROMPT: Answer must be 1-110 characters in length.

DESCRIPTION:

When a message is forwarded to another user, this field names the person who did the forwarding, along with the date and time that this was done.  It is displayed in the query option after reading.

UNEDITABLE

8.01

FORWARDED BY (XMDUZ)

F;2

POINTER TO NEW PERSON FILE (#200)

NEW PERSON(#200)

LAST EDITED: JUL 28, 1997
HELP-PROMPT: Who forwarded the message to this recipient?

DESCRIPTION:

This field uses the XMDUZ variable to identify the user who forwarded the message.

8.02

FWD TYPE

F;3

SET

'F' FOR Filter-Forward;
'A' FOR Auto-Forward;
'R' FOR Regular-Forward;

LAST EDITED: NOV 28, 2001
HELP-PROMPT: What kind of forwarding?

DESCRIPTION: Regular-Forward - A user simply forwarded this message to the recipient in the .01 field. This is the default, if this field is null.

Auto-Forward - A user has a forwarding address listing the recipient in the .01 field.  This message was sent to the user and then automatically forwarded to the recipient.

Filter-Forward - A user has an active message filter listing the recipient in the .01 field as a "forward to" person.  This message was sent to the user and then automatically forwarded to the recipient during message

delivery.

8.03

FWD BY ORIGINAL

F;4

FREE TEXT

INPUT TRANSFORM: K:$L(X)>110!($L(X)<1) X
LAST EDITED: NOV 28, 2001
HELP-PROMPT: Answer must be 1-110 characters in length.

DESCRIPTION:

This field is only used if FWD TYPE is Auto-Forward.  This field lists the original user (and possibly the user's surrogate) who forwarded the message to the user with the forwarding address.

8.04

FWD TYPE ORIGINAL

F;5

SET

'F' FOR Filter-Forward;
'R' FOR Regular-Forward;

LAST EDITED: NOV 28, 2001
HELP-PROMPT: What kind of forwarding, originally?

DESCRIPTION: This field is only used if FWD TYPE is Auto-Forward. This field reveals how the message was forwarded to the user who had the forwarding address listing the recipient in the .01 field.

Regular-Forward - A user simply forwarded this message to the user with the forwarding address.  This is the default, if this field is null.

Filter-Forward - A user has an active message filter listing the user with the forwarding address as a "forward to" person.  This message was sent to the user and then automatically forwarded to the user during message

delivery.

Note that Auto-Forward is not a possibility, because Auto-Forward is allowed only to remote recipients or to devices or servers.

8.5

COPIED DATE/TIME

C;1

FREE TEXT

INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: APR 22, 2002
HELP-PROMPT: Answer must be 1-15 characters in length.

DESCRIPTION:

When a message is copied by a user, this field indicates the date and time at which this was done.  It is displayed in the query option after reading the message.

TECHNICAL DESCR: Before patch XM*7.1*110, this field was in external format. After that patch, this field is in internal FileMan format. The data have not been changed, so you may see either format, depending on when the message was
```
copied.
```

9

NETWORK TRANSMISSION TIME

0;8

NUMBER

INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: FEB 22, 1988
HELP-PROMPT: Type a Number between 0 and 999999, 0 Decimal Digits

DESCRIPTION:

This field records the elapsed time (in seconds) during a network transmission.

UNEDITABLE

10

PRIORITY RESPONSES?

0;9

SET

'0' FOR YES;
'1' FOR NO;

LAST EDITED: JUL 28, 1997
DESCRIPTION: This field overrides the MESSAGE TYPE field in the zero node of the message, but only if it contains a "P". In this way, some recipients can keep receiving responses to a 'Priority Message' as priority mail, while
```
others may choose not to.  One cannot, however, force the responses of an ordinary message to be delivered as 'Priority Mail'.
```

11

FIRST READ DATE/TIME

0;10

DATE

INPUT TRANSFORM: S %DT="ETXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUL 30, 1997

DESCRIPTION:

Into this field is set the date and time that a message was first seen by the recipient.

12

SURROGATE READER

S;1

FREE TEXT

INPUT TRANSFORM: K:$L(X)>35!($L(X)<3) X
LAST EDITED: APR 03, 1996
HELP-PROMPT: Answer must be 3-35 characters in length.

DESCRIPTION:

This is the name of the surrogate who last read this message.

13

FAX RECIPIENT

0;11

POINTER ** TO AN UNDEFINED FILE **

LAST EDITED: FEB 11, 1997
HELP-PROMPT: Enter the fax recipient
DESCRIPTION: When the message is addressed to a fax recipient, this field points to the fax rolodex file. After the message is handed off to the fax software, the pointer in this field is deleted and the Fax ID field is set to the
```
fax ID number assigned to it by the fax software.
```

CROSS-REFERENCE: 3.91^AFAX

1)= S ^XMB(3.9,DA(1),1,"AFAX",$E(X,1,30),DA)=""

2)= K ^XMB(3.9,DA(1),1,"AFAX",$E(X,1,30),DA)

This cross reference makes it possible for MailMan to immediately find the recipients to fax a message to.

14

FAX ID

0;12

FREE TEXT

INPUT TRANSFORM: K:$L(X)>14!($L(X)<1) X
LAST EDITED: FEB 11, 1997
HELP-PROMPT: Answer must be 1-14 characters in length.

DESCRIPTION:

This is the fax ID as assigned by the fax software (AKF*).

15

FILTER FORWARD

0;13

NUMBER

INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: OCT 17, 2000
HELP-PROMPT: Type a Number between 0 and 999, 0 Decimal Digits
DESCRIPTION: This is the IEN of the user's filter which was activated during message delivery. The filter indicates that this message should be forwarded to the addressees listed in the FORWARD TO multiple of the activated filter.
```
If this field is set to zero, the message has been forwarded.
```

TECHNICAL DESCR: When this field is set to a positive number (the IEN of the user's activated filter), it causes the whole-file "AF" xref to be set.

Routine ^XMTDT checks for the existence of the "AF" xref.  It will do the actual forwarding of the message.  Once it finishes forwarding, it will set this field to zero, which will kill the xref and won't reset it.

If the field is null, filter forwarding has not yet occurred for this message for this user.

If the field is not null, it means that the message has already been (or is scheduled to be) filter forwarded once for this user, and should not be filter forwarded again for this user.

FIELD INDEX: AF (#174) REGULAR IR SORTING ONLY WHOLE FILE (#3.9)

Short Descr:  See Technical Description

Set Logic:  S ^XMB(3.9,"AF",X,DA(1),DA)=""

Set Cond:  S X=(X>0)

Kill Logic:  K ^XMB(3.9,"AF",X,DA(1),DA)

Whole Kill:  K ^XMB(3.9,"AF")

X(1):  FILTER FORWARD  (3.91,15)  (Subscr 1)  (forwards)

Customize PDF page

Package: MailMan

MESSAGE(#3.9)-->3.91

Sub-Field: 3.91

Information

Details