MimeEntity (HCL Domino API 1.0.27-SNAPSHOT API)

```
public interface MimeEntity
```
Represents a MIME entity stored in a document, which may be standalone or part of a tree.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MimeEntity.Encoding

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MimeEntity.Encoding`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`MimeHeader`	`addHeader(String headerName)` Adds a header with the provied `headerName` and blank content.
`MimeHeader`	`addHeader(String headerName, String value)` Adds a header with the provied `headerName` and blank with the provided value.
`void`	`appendChildEntity(MimeEntity entity)` Append a child entity beneath this entity, with an auto-generated boundary.
`MimeEntity`	`createChildEntity()` Creates a child entity beneath this entity, with an auto-generated boundary.
`MimeEntity`	`createChildEntity(MimeEntity sibling)` Creates a child entity beneath this entity and placed immediately before the provided entity, with an auto-generated boundary.
`Optional<String>`	`getBoundary()` Retrieves the boundary value used to separate children within this multipart entity
`Optional<Iterable<MimeEntity>>`	`getChildren()` Returns a mutable `Iterable` view of the children of this multipart entity's children.
`Optional<String>`	`getContentAsString()` Retrieves the content of this entity as a string.
`default Optional<jakarta.mail.internet.ContentType>`	`getContentType()` Retrieves and parses the `Content-Type` header of this entity, if present.
`MimeEntity.Encoding`	`getEncoding()`
`List<MimeHeader>`	`getHeaders()` Returns a list of all headers for this entity.
`List<MimeHeader>`	`getHeaders(String headerName)` Returns a list of all headers for this entity that match the provided `headerName`.
`default Optional<InputStream>`	`getInputStream()` Retrieves the content of the entity as an `InputStream`.
`Optional<InputStream>`	`getInputStream(boolean decode)` Retrieves the content of the entity as an `InputStream`.
`Optional<MimeEntity>`	`getParent()` Retrieves the parent of this entity, if it is part of a multipart tree.
`Optional<String>`	`getPreamble()` Gets the preamble of this multipart entity.
`Optional<Reader>`	`getReader()` Retrieves a `Reader` for the text content of this entity.
`default boolean`	`isMultipart()`
`void`	`removeChildEntity(MimeEntity child)` Removes the provided child entity from this multipart entity.
`void`	`removeHeaders(String headerName)` Removes all headers of the given name from this entity.
`void`	`setContent(InputStream is, MimeEntity.Encoding encoding)` Sets the content of the MIME entity from the provided `InputStream`, applying the requested storage encoding.
`void`	`setPreamble(String preamble)` Sets the preamble of this multipart entity.

- Method Detail
  - getEncoding
```
MimeEntity.Encoding getEncoding()
```
    Returns:
    
    the encoding used to store the MIME content
  - getInputStream
```
default Optional<InputStream> getInputStream()
```
    Retrieves the content of the entity as an InputStream. If the entity's content is encoded, this decodes it.
    This is equivalent to calling getInputStream(true).
    
    Returns:
    
    an Optional describing a InputStream of the content of the entity, decoded from storage format, or an empty one if this is a multipart entity
  - getInputStream
```
Optional<InputStream> getInputStream(boolean decode)
```
    Retrieves the content of the entity as an InputStream. If the entity's content is encoded, this decodes it if decode is true and leaves it encoded if it is false.
    This is equivalent to calling getInputStream(true).
    
    Parameters:
    
    decode - whether the content should be decoded from its storage format
    
    Returns:
    
    an Optional describing a InputStream of the content of the entity, optionally decoded from storage format, or an empty one if this is a multipart entity
  - getReader
```
Optional<Reader> getReader()
```
    Retrieves a Reader for the text content of this entity. If the entity is encoded, this decodes it. Additionally, this reader will obey any charset parameter in the entity's Content-Type header, if present.
    
    Returns:
    
    an Optional describing a Reader for the content of this entity as text, or an empty one if this is a multipart entity
  - getContentAsString
```
Optional<String> getContentAsString()
```
    Retrieves the content of this entity as a string. If the entity's content is encoded, this decodes it.
    
    Returns:
    
    an Optional describing the content of the entity as a String, or an empty one if this is a multipart entity
  - setContent
```
void setContent(InputStream is,
                MimeEntity.Encoding encoding)
```
    Sets the content of the MIME entity from the provided InputStream, applying the requested storage encoding.
    Note: the content of the stream should not be already encoded.
    
    Parameters:
    
    is - an InputStream to read; cannot be null
    
    encoding - the MimeEntity.Encoding value to use
    
    Throws:
    
    IllegalStateException - if this is a multipart entity
  - getContentType
```
default Optional<jakarta.mail.internet.ContentType> getContentType()
                                                            throws jakarta.mail.internet.ParseException
```
    Retrieves and parses the Content-Type header of this entity, if present.
    
    Returns:
    
    an Optional describing the ContentType object, or an empty one if no header is set
    
    Throws:
    
    jakarta.mail.internet.ParseException - if the Content-Type header is present and invalid
  - getParent
```
Optional<MimeEntity> getParent()
```
    Retrieves the parent of this entity, if it is part of a multipart tree.
    
    Returns:
    
    an Optional describing the the parent MimeEntity, or an empty one if this entity has no parent
  - isMultipart
```
default boolean isMultipart()
                     throws jakarta.mail.internet.ParseException
```
    Returns:
    
    true if this entity is a multipart type
    
    Throws:
    
    jakarta.mail.internet.ParseException - if the Content-Type header is present and invalid
  - getPreamble
```
Optional<String> getPreamble()
```
    Gets the preamble of this multipart entity.
    
    Returns:
    
    an Optional describing the preamble text of the entity, an Optional empty string if there is no preamble, or an empty Optional if this is not a multipart entity
  - setPreamble
```
void setPreamble(String preamble)
```
    Sets the preamble of this multipart entity.
    
    Parameters:
    
    preamble - the text of the preamble to set, or null to clear an existing preamble
    
    Throws:
    
    IllegalStateException - if this is not a multipart entity
  - getBoundary
```
Optional<String> getBoundary()
```
    Retrieves the boundary value used to separate children within this multipart entity
    
    Returns:
    
    an Optional describing the multipart boundary string, or an empty one if this is not a multipart entity
  - createChildEntity
```
MimeEntity createChildEntity()
```
    Creates a child entity beneath this entity, with an auto-generated boundary.
    If this entity does not currently have a multipart content type, this method sets the content type to multipart/mixed and any existing content is removed.
    
    Returns:
    
    the newly-created child entity
  - createChildEntity
```
MimeEntity createChildEntity(MimeEntity sibling)
```
    Creates a child entity beneath this entity and placed immediately before the provided entity, with an auto-generated boundary.
    If this entity does not currently have a multipart content type, this method sets the content type to multipart/mixed and any existing content is removed.
    
    Parameters:
    
    sibling - the entity in front of which to place the new child
    
    Returns:
    
    the newly-created child entity
    
    Throws:
    
    IllegalArgumentException - if sibling is not a child of the current entity
  - appendChildEntity
```
void appendChildEntity(MimeEntity entity)
```
    Append a child entity beneath this entity, with an auto-generated boundary.
    If the provided entity already has a parent entity, it is removed from that tree.
    
    If this entity does not currently have a multipart content type, this method sets the content type to multipart/mixed and any existing content is removed.
    
    Parameters:
    
    entity - the entity to append
  - removeChildEntity
```
void removeChildEntity(MimeEntity child)
```
    Removes the provided child entity from this multipart entity.
    
    Parameters:
    
    child - the child MimeEntity to remove
  - getChildren
```
Optional<Iterable<MimeEntity>> getChildren()
```
    Returns a mutable Iterable view of the children of this multipart entity's children.
    Calling createChildEntity(MimeEntity) will invalidate any objects previously returned by this method.
    
    Returns:
    
    an Optional describing a mutable Iterable, or an empty one if this is not a multipart entity
  - getHeaders
```
List<MimeHeader> getHeaders()
```
    Returns a list of all headers for this entity.
    
    Returns:
    
    an immutable List of MimeHeaders
  - getHeaders
```
List<MimeHeader> getHeaders(String headerName)
```
    Returns a list of all headers for this entity that match the provided headerName.
    
    Parameters:
    
    headerName - the name of the headers to retrieve
    
    Returns:
    
    an immutable List of MimeHeaders
  - addHeader
```
MimeHeader addHeader(String headerName)
```
    Adds a header with the provied headerName and blank content.
    
    Parameters:
    
    headerName - the name of the header to create
    
    Returns:
    
    the newly-created MimeHeader
  - addHeader
```
MimeHeader addHeader(String headerName,
                     String value)
```
    Adds a header with the provied headerName and blank with the provided value.
    value is treated as the entire content of the header, and may contain parameters.
    
    Parameters:
    
    headerName - the name of the header to create
    
    value - the value of the header to set
    
    Returns:
    
    the newly-created MimeHeader
  - removeHeaders
```
void removeHeaders(String headerName)
```
    Removes all headers of the given name from this entity.
    
    Parameters:
    
    headerName - the name of the headers to remove

Interface MimeEntity

Nested Class Summary

Method Summary

Method Detail

getEncoding

getInputStream

getInputStream

getReader

getContentAsString

setContent

getContentType

getParent

isMultipart

getPreamble

setPreamble

getBoundary

createChildEntity

createChildEntity

appendChildEntity

removeChildEntity

getChildren

getHeaders

getHeaders

addHeader

addHeader

removeHeaders