org.simplejavamail.api.email

Class AttachmentResource

java.lang.Object

org.simplejavamail.api.email.AttachmentResource

All Implemented Interfaces:

Serializable

public class AttachmentResource
extends Object
implements Serializable

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 DataSource that is compatible with the javax.mail API.

See Also:

DataSource, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttachmentResource(@Nullable String name, @NotNull DataSource dataSource) Constructor; initializes the attachment resource with a name and data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object o)
@NotNull DataSource	getDataSource()
@NotNull InputStream	getDataSourceInputStream() Delegates to DataSource.getInputStream()
@Nullable String	getName()
int	hashCode()
@NotNull byte[]	readAllBytes() Delegates to MiscUtil.readInputStreamToBytes(InputStream) with data source input stream.
@NotNull String	readAllData()
@NotNull String	readAllData(@NotNull Charset charset) Delegates to MiscUtil.readInputStreamToString(InputStream, Charset) with data source input stream.
@NotNull String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachmentResource

public AttachmentResource(@Nullable
                          @Nullable String name,
                          @NotNull
                          @NotNull DataSource dataSource)

Constructor; initializes the attachment resource with a name and data.

Parameters:

name - The name of the attachment which can be a simple name, a filename or a named embedded image (eg. <cid:footer>). Leave null to fall back on DataSource.getName().

dataSource - The attachment data. If no name was provided, the name of this datasource is used if provided.

See Also:

DataSource

Method Detail

readAllData

@NotNull
public @NotNull String readAllData()
                                     throws IOException

Returns:

The content of the datasource as UTF-8 encoded String.

Throws:

IOException - See readAllData(Charset)

readAllBytes

@NotNull
public @NotNull byte[] readAllBytes()
                                      throws IOException

Delegates to MiscUtil.readInputStreamToBytes(InputStream) with data source input stream.

Throws:

IOException

readAllData

@NotNull
public @NotNull String readAllData(@NotNull
                                            @NotNull Charset charset)
                                     throws IOException

Delegates to MiscUtil.readInputStreamToString(InputStream, Charset) with data source input stream.

Throws:

IOException

getDataSource

@NotNull
public @NotNull DataSource getDataSource()

Returns:

dataSource

getDataSourceInputStream

@NotNull
public @NotNull InputStream getDataSourceInputStream()

Delegates to DataSource.getInputStream()

getName

@Nullable
public @Nullable String getName()

Returns:

name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      @Nullable Object o)

Overrides:

equals in class Object

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object