fr.sii.ogham.email.attachment

Class Attachment

java.lang.Object

fr.sii.ogham.email.attachment.Attachment

public class Attachment
extends Object

Represents a content to attach to the email. Typically a file to join to the email. An attachment is represented with the following information:

• A content (the file to join to the email). See NamedResource for more information.
• A name (the name to display for the file). See NamedResource for more information.
• An optional description
• An optional disposition (ContentDisposition.ATTACHMENT by default)

Author:

Aurélien Baudet

Constructor Summary

Constructors

Constructor and Description
Attachment(File file) Initialize the attachment with the provided file.
Attachment(File file, String description) Initialize the attachment with the provided file and description of the attachment.
Attachment(File file, String description, String disposition) Initialize the attachment with the provided file, description of the attachment and disposition (how to include the attachment into the mail).
Attachment(NamedResource resource) Initialize the attachment with the provided resource (content and name).
Attachment(NamedResource resource, String description) Initialize the attachment with the provided resource (content and name), the description of the attachment.
Attachment(NamedResource resource, String description, String disposition) Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).
Attachment(NamedResource resource, String description, String disposition, String contentId) Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).
Attachment(String path) Initialize the attachment with the provided path.
Attachment(String name, byte[] content) Initialize the attachment with the provided content and name.
Attachment(String name, byte[] content, String description) Initialize the attachment with the provided content, name and description of the attachment.
Attachment(String name, byte[] content, String description, String disposition) Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).
Attachment(String name, InputStream stream) Initialize the attachment with the provided content and name.
Attachment(String name, InputStream stream, String description) Initialize the attachment with the provided content, name and description of the attachment.
Attachment(String name, InputStream stream, String description, String disposition) Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).
Attachment(String path, String description) Initialize the attachment with the provided path and description of the attachment.
Attachment(String path, String description, String disposition) Initialize the attachment with the provided path, description of the attachment and disposition (how to include the attachment into the mail).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContentId()
String	getDescription()
String	getDisposition()
NamedResource	getResource()
int	hashCode()
void	setContentId(String contentId)
void	setDescription(String description)
void	setDisposition(String disposition)
void	setResource(NamedResource resource)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Attachment

public Attachment(NamedResource resource,
                  String description,
                  String disposition,
                  String contentId)

Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).

Parameters:

resource - the resource of the attachment (with name)

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

contentId - the unique id of the content (may not null)

Attachment

public Attachment(NamedResource resource,
                  String description,
                  String disposition)

Initialize the attachment with the provided resource (content and name), the description of the attachment and the disposition (how to include the attachment into the mail).

Parameters:

resource - the resource of the attachment (with name)

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

Attachment

public Attachment(NamedResource resource,
                  String description)

Initialize the attachment with the provided resource (content and name), the description of the attachment.

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

resource - the resource of the attachment

description - the description of the attachment (may be null)

Attachment

public Attachment(NamedResource resource)

Initialize the attachment with the provided resource (content and name).

The description is not used (set to null)

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

resource - the resource of the attachment

Attachment

public Attachment(String path,
                  String description,
                  String disposition)

Initialize the attachment with the provided path, description of the attachment and disposition (how to include the attachment into the mail).

The path may contain a lookup. The lookup is case sensitive and must end with a ':'. It must not contain another ':' character.

For example, a path could be "classpath:/email/hello.pdf". The lookup is "classpath:".

Parameters:

path - the path to the attachment

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

Attachment

public Attachment(String path,
                  String description)

Initialize the attachment with the provided path and description of the attachment.

The path may contain a lookup. The lookup is case sensitive and must end with a ':'. It must not contain another ':' character.

For example, a path could be "classpath:/email/hello.pdf". The lookup is "classpath:".

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

path - the path to the attachment

description - the description of the attachment (may be null)

Attachment

public Attachment(String path)

Initialize the attachment with the provided path.

The path may contain a lookup. The lookup is case sensitive and must end with a ':'. It must not contain another ':' character.

For example, a path could be "classpath:/email/hello.pdf". The lookup is "classpath:".

The description is not used (set to null)

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

path - the path to the attachment

Attachment

public Attachment(String name,
                  InputStream stream,
                  String description,
                  String disposition)
           throws IOException

Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).

Parameters:

name - the name of the attachment

stream - the content of the attachment accessible trough the stream

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

Throws:

IOException - when the content of the stream can't be read

Attachment

public Attachment(String name,
                  InputStream stream,
                  String description)
           throws IOException

Initialize the attachment with the provided content, name and description of the attachment.

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

name - the name of the attachment

stream - the content of the attachment accessible trough the stream

description - the description of the attachment (may be null)

Throws:

IOException - when the content of the stream can't be read

Attachment

public Attachment(String name,
                  InputStream stream)
           throws IOException

Initialize the attachment with the provided content and name.

The description is not used (set to null)

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

name - the name of the attachment

stream - the content of the attachment accessible trough the stream

Throws:

IOException - when the content of the stream can't be read

Attachment

public Attachment(String name,
                  byte[] content,
                  String description,
                  String disposition)

Initialize the attachment with the provided content, name, description of the attachment and disposition (how to include the attachment into the mail).

Parameters:

name - the name of the attachment

content - the content of the attachment

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

Attachment

public Attachment(String name,
                  byte[] content,
                  String description)

Initialize the attachment with the provided content, name and description of the attachment.

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

name - the name of the attachment

content - the content of the attachment

description - the description of the attachment (may be null)

Attachment

public Attachment(String name,
                  byte[] content)

Initialize the attachment with the provided content and name.

The description is not used (set to null)

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

name - the name of the attachment

content - the content of the attachment

Attachment

public Attachment(File file,
                  String description,
                  String disposition)

Initialize the attachment with the provided file, description of the attachment and disposition (how to include the attachment into the mail).

The name of the attachment is the name of the file.

Parameters:

file - the file to attach

description - the description of the attachment (may be null)

disposition - the disposition of the attachment

Attachment

public Attachment(File file,
                  String description)

Initialize the attachment with the provided file and description of the attachment.

The name of the attachment is the name of the file.

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

file - the file to attach

description - the description of the attachment (may be null)

Attachment

public Attachment(File file)

Initialize the attachment with the provided file.

The name of the attachment is the name of the file.

The description is not used (set to null)

The disposition is set to ContentDisposition.ATTACHMENT

Parameters:

file - the file to attach

Method Detail

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getDisposition

public String getDisposition()

setDisposition

public void setDisposition(String disposition)

getResource

public NamedResource getResource()

setResource

public void setResource(NamedResource resource)

getContentId

public String getContentId()

setContentId

public void setContentId(String contentId)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object