com.hcl.domino.mime.MimeReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * Licensed under the  Apache License, Version 2.0  (the "License").  You may
 * not use this file except in compliance with the License.  You may obtain a
 * copy of the License at .
 *
 * Unless  required  by applicable  law or  agreed  to  in writing,  software
 * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
 * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the  specific language  governing permissions  and limitations
 * under the License.
 * ==========================================================================
 */
package com.hcl.domino.mime;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Set;

import com.hcl.domino.data.Document;

import jakarta.mail.internet.MimeMessage;

/**
 * Utility class to read MIME content from a document
 */
public interface MimeReader {

  /**
   * Used to specify which part of the document MIME content should be read
   */
  public enum ReadMimeDataType {
    MIMEHEADERS, RFC822HEADERS
  }

  /**
   * Returns an {@link InputStream} to read the MIME content
   *
   * @param doc      document to read MIME
   * @param itemName name of item for the MIME content (e.g. "body")
   * @param dataType specifies with MIME data types should be read
   * @return stream
   */
  InputStream readMIMEAsStream(Document doc, String itemName, Set dataType);

  /**
   * Reads MIME content from a document and returns it as a {@link MimeMessage}.
   *
   * @param doc      document to read MIME
   * @param itemName name of item for the MIME content (e.g. "body")
   * @param dataType specifies with MIME data types should be read
   * @return MIME message
   */
  MimeMessage readMIME(Document doc, String itemName, Set dataType);

  /**
   * Reads MIME content from a document into an {@link OutputStream} in a streaming
   * fashion.
   *
   * @param doc          document to read MIME
   * @param itemName     name of item for the MIME content (e.g. "body")
   * @param dataType     specifies with MIME data types should be read
   * @param targetOut stream to receive the MIME content
   * @throws IOException in case of I/O errors writing into the {@link Writer}
   */
  void readMIME(Document doc, String itemName, Set dataType, OutputStream targetOut) throws IOException;

}