org.codemonkey.simplejavamail.AttachmentResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple-java-mail Show documentation

A light weight wrapper for the JavaMail SMTP API

The newest version!

package org.codemonkey.simplejavamail;

import javax.activation.DataSource;

/**
 * A named immutable email attachment information object. The name can be a simple name, a filename or a named embedded
 * image (eg. <cid:footer>). Contains a {@link DataSource} that is compatible with the javax.mail API.
 * 
 * @author Benny Bottema
 * @see DataSource
 */
final class AttachmentResource {

	/**
	 * @see #AttachmentResource(String, DataSource)
	 */
	private final String name;

	/**
	 * @see #AttachmentResource(String, DataSource)
	 */
	private final DataSource dataSource;

	/**
	 * Constructor; initializes the attachment resource with a name and data.
	 * 
	 * @param name The name of the attachment which can be a simple name, a filename or a named embedded image (eg.
	 *            <cid:footer>)
	 * @param dataSource The attachment data.
	 * @see DataSource
	 */
	public AttachmentResource(final String name, final DataSource dataSource) {
		this.name = name;
		this.dataSource = dataSource;
	}

	/**
	 * Bean getter for {@link #dataSource}.
	 */
	public DataSource getDataSource() {
		return dataSource;
	}

	/**
	 * Bean getter for {@link #name}.
	 */
	public String getName() {
		return name;
	}
}