formatMsgWithDoclinks (Newsletter - Java™)

Creates a document that contains a link to each document in the newsletter collection.

Defined in

Newsletter

Syntax

public Document formatMsgWithDoclinks(Database db)
    throws NotesException

Parameters


Database db

The database in which to create the newsletter document. If you specify this parameter as null, the document is created in the user's default mail database.

Return value


Document

A document that contains a link to each document in the newsletter collection.

Usage

The Body item of the returned document 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. You must set this property before calling the formatMsgWithDoclinks method.
  • If the IsDoSubject property is true and the SubjectItemName property has a value, a title for each document. You must set this property before calling the formatMsgWithDoclinks method.
  • The query that produced the newsletter collection.

If you want to save the newsletter, you must explicitly call the save method of Document.

If you want to mail the newsletter, you must explicitly call the send method of Document.

The target database must have a default view or the following occurs: "Notes® error: Special database object cannot be located."

Example