jakarta.mail.MultipartDataSource Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.mail;
import jakarta.activation.DataSource;
/**
* MultipartDataSource is a DataSource that contains body
* parts. This allows "mail aware" DataContentHandlers to
* be implemented more efficiently by being aware of such
* DataSources and using the appropriate methods to access
* BodyParts.
*
* Note that the data of a MultipartDataSource is also available as
* an input stream.
*
* This interface will typically be implemented by providers that
* preparse multipart bodies, for example an IMAP provider.
*
* @author John Mani
* @see jakarta.activation.DataSource
*/
public interface MultipartDataSource extends DataSource {
/**
* Return the number of enclosed BodyPart objects.
*
* @return number of parts
*/
public int getCount();
/**
* Get the specified Part. Parts are numbered starting at 0.
*
* @param index the index of the desired Part
* @return the Part
* @exception IndexOutOfBoundsException if the given index
* is out of range.
* @exception MessagingException for other failures
*/
public BodyPart getBodyPart(int index) throws MessagingException;
}