A newsletter is a summary document containing a picture of another document or links to other documents. Use the createNewsletter method of Session to create a Newsletter object based on a document collection. Use one of the following methods to format the newsletter:

• formatDocument formats the newsletter to contain a picture of one document in the document collection that is the basis for the newsletter. You must iterate through the document collection to format all the documents.
• formatMsgWithDoclinks formats the newsletter to contain links to all the documents in the document collection that is the basis for the newsletter.

You can use the save method of Document to save documents based on newsletters.

The following methods access the Newsletter properties. The boolean properties are useful only with formatMsgWithDoclinks.

• isDoScore returns true if the formatted newsletter is to contain each document's relevance score; set this property to true or false with setDoScore before calling formatMsgWithDoclinks.
• isDoSubject returns true if the formatted newsletter is to contain the content of each document's subject field; set this property to true or false (default) with setDoSubject before calling formatMsgWithDoclinks.
• getSubjectItemName returns the name of the field associated with isDoSubject; set this property with setSubjectItemName if you set setDoSubject to true.
• getParent returns a Session object representing the current session.

Accessing Domino sessions

Glossary