org.simplejavamail.email

Class AttachmentResource

java.lang.Object

org.simplejavamail.email.AttachmentResource

public class AttachmentResource
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
DataSource	getDataSource()
String	getName()
int	hashCode()
String	readAllData()
String	readAllData(Charset charset)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachmentResource

public AttachmentResource(@Nullable
                          String name,
                          @Nonnull
                          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

@Nonnull
public String readAllData()
                             throws IOException

Returns:

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

Throws:

IOException - See readAllData(Charset)

readAllData

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

Returns:

The content of the datasource as String, using IOUtils#toByteArray.

Throws:

IOException - See readAllData(Charset)

getDataSource

public DataSource getDataSource()

Returns:

dataSource

getName

@Nullable
public String getName()

Returns:

name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object