getMIMEEntity (Document - Java™)

Gets a top-level MIME entity.

Note: This method is new with Release 6.

Defined in

Document

Syntax

public MIMEEntity getMIMEEntity()
    throws NotesException
public MIMEEntity getMIMEEntity(String itemName)
    throws NotesException

Parameters

String itemName

The name of the item containing the MIME entity. "Body" is the default.

Return value

MIMEEntity

The MIME entity.

Usage

An item containing a MIME entity is of type MIME_PART.

This method returns null if the requested item does not exist or is not of type MIME_PART.

This method is equivalent to Document.getFirstItem followed by Item.getMIMEEntity.

Example