FormatMsgWithDoclinks (NotesNewsletter - LotusScript®)
Creates a newsletter document in the given database that contains a link to each document in the newsletter's collection.
Defined in
Syntax
Set notesDocument = notesNewsletter .FormatMsgWithDoclinks( notesDatabase )
Parameters
notesDatabase
The database in which to create the newsletter document. If you do not specify a notesDatabase, the document is created in the user's default mail database.
Return value
notesDocument
A document that contains a link to each document in the newsletter's collection; also contains the name of notesDatabase and the text of the original query that produced the collection, if any.
Usage
The Body item of the returned notesDocument contains the following:
- The file name of the database that contains the documents in the newsletter collection.
- A link to each document in the newsletter collection.
- If the collection is sorted and the DoScore property is True, the relevance score of each document.
- If the DoSubject property is True and the SubjectItemName property has a value, a title for each document. You must set these properties before calling the FormatMsgWithDoclinks method.
- The query that produced the newsletter's collection.
If you want to save the newsletter, you must explicitly call the Save method on the NotesDocument. The document is saved to the notesDatabase you specify.
If you want to mail the newsletter, you must explicitly call the Send method on the NotesDocument.
The target database must have a default view or the following occurs: "Notes® error: Special database object cannot be located."