/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.mail;
A DataSource
that also implements EncodingAware
may specify the Content-Transfer-Encoding
to use for its data. Valid Content-Transfer-Encoding values specified
by RFC 2045 are "7bit", "8bit", "quoted-printable", "base64", and "binary".
For example, a FileDataSource
could be created that forces all files to be base64 encoded:
public class Base64FileDataSource extends FileDataSource
implements EncodingAware {
public Base64FileDataSource(File file) {
super(file);
}
// implements EncodingAware.getEncoding()
public String getEncoding() {
return "base64";
}
}
Author: Bill Shannon Since: JavaMail 1.5
/**
* A {@link javax.activation.DataSource DataSource} that also implements
* <code>EncodingAware</code> may specify the Content-Transfer-Encoding
* to use for its data. Valid Content-Transfer-Encoding values specified
* by RFC 2045 are "7bit", "8bit", "quoted-printable", "base64", and "binary".
* <p>
* For example, a {@link javax.activation.FileDataSource FileDataSource}
* could be created that forces all files to be base64 encoded:
* <blockquote><pre>
* public class Base64FileDataSource extends FileDataSource
* implements EncodingAware {
* public Base64FileDataSource(File file) {
* super(file);
* }
*
* // implements EncodingAware.getEncoding()
* public String getEncoding() {
* return "base64";
* }
* }
* </pre></blockquote><p>
*
* @since JavaMail 1.5
* @author Bill Shannon
*/
public interface EncodingAware {
Return the MIME Content-Transfer-Encoding to use for this data,
or null to indicate that an appropriate value should be chosen
by the caller.
Returns: the Content-Transfer-Encoding value, or null
/**
* Return the MIME Content-Transfer-Encoding to use for this data,
* or null to indicate that an appropriate value should be chosen
* by the caller.
*
* @return the Content-Transfer-Encoding value, or null
*/
public String getEncoding();
}