Mac Hyp: Reading an Enclosed File from a Message (62063)

   msmail(getEnclosure, messageRef [,fileName] [,replace] [,index])
   => fileName
				

MORE INFORMATION

The file is saved under the name "fileName". "fileName" can be a complete path or a partial path as explained under addEnclosure. If no name is provided, the standard Macintosh Save File dialog box is displayed, allowing the user to specify a name.

"messageRef" is a reference to a selected message obtained by making a call to the msmail function using a parameter that returns a message reference.

If the "replace" flag is true and a file with the name "fileName" already exists on your system, it will be overwritten. If "replace" is false, then "#n" (where "n" is a number) will be appended to the filename before it is saved so that the existing file is not overwritten. The "replace" flag is ignored if "fileName" is not specified.

The optional "index" parameter allows multiple enclosures to be extracted from a message. Since this feature was not implemented in Microsoft Mail 2.00, passing anything other than 0 (zero) in Mail 2.00 returns an error (0 is the default).

Note: The "index" parameter changed in Mail 3.00. The "index" parameter can be from 1 to the number of enclosed files. Updated scripts that were used with Mail 2.00 should be modified if they used the optional 0 index. Otherwise, a "Bad Index error" will be returned in MailResultText. The default in Mail 3.00 is 1.

In all cases, the name (not path) that the file was successfully saved with is returned.

This information is taken from the "Microsoft Mail HyperCard Interface Documentation."