Package ch.astorm.jotlmsg

Class OutlookMessageAttachment

java.lang.Object

ch.astorm.jotlmsg.OutlookMessageAttachment

public class OutlookMessageAttachment
extends Object

Represents a message attachment.

Author:

Cedric Tabin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OutlookMessageAttachment.InputStreamCreator	Represents an InputStream creator.
static class	OutlookMessageAttachment.MemoryInputStreamCreator	Wraps the creation of an InputStream from a given source InputStream.

Constructor Summary

Constructors

Constructor	Description
OutlookMessageAttachment(String name, String mimeType, OutlookMessageAttachment.InputStreamCreator creator)	Creates a new OutlookMessageAttachment with the specified parameters.
OutlookMessageAttachment(String name, String mimeType, InputStream input)	Creates a new OutlookMessageAttachment with the specified parameters.

Method Summary

Modifier and Type	Method	Description
String	getContentId()	Defines the Content-Id, by which this attachment is referenceable in an HTML body.
OutlookMessageAttachment.InputStreamCreator	getInputStreamCreator()	Defines the InputStreamCreator that handles the attachment content.
String	getMimeType()	Defines the MIME type of the attachment.
final String	getName()	Returns the name of the attachment, as seen by the user.
InputStream	getNewInputStream()	Returns a new InputStream to read the content of this attachment.
void	setContentId(String contentId)
void	setInputStreamCreator(OutlookMessageAttachment.InputStreamCreator is)
void	setMimeType(String mimeType)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OutlookMessageAttachment

public OutlookMessageAttachment(String name,
 String mimeType,
 OutlookMessageAttachment.InputStreamCreator creator)

Creates a new OutlookMessageAttachment with the specified parameters.

Parameters:

name - The attachment's name.

mimeType - The MIME type of the attachment.

creator - The InputStreamCreator or null.

OutlookMessageAttachment

public OutlookMessageAttachment(String name,
 String mimeType,
 InputStream input)

Creates a new OutlookMessageAttachment with the specified parameters. A new MemoryInputStreamCreator will be created with the specified input as source.

Parameters:

name - The attachment's name.

mimeType - The MIME type of the attachment.

input - The input or null.

See Also:

• OutlookMessageAttachment.MemoryInputStreamCreator

Method Details

getName

public final String getName()

Returns the name of the attachment, as seen by the user. This value cannot be null nor empty.

Returns:

The name of the attachment.

getMimeType

public String getMimeType()

Defines the MIME type of the attachment.

setMimeType

public void setMimeType(String mimeType)

getContentId

public String getContentId()

Defines the Content-Id, by which this attachment is referenceable in an HTML body. Setting this to anything other than null will make this an inline attachment.

setContentId

public void setContentId(String contentId)

getInputStreamCreator

public OutlookMessageAttachment.InputStreamCreator getInputStreamCreator()

Defines the InputStreamCreator that handles the attachment content. This value may be null.

setInputStreamCreator

public void setInputStreamCreator(OutlookMessageAttachment.InputStreamCreator is)

getNewInputStream

public InputStream getNewInputStream()
                              throws IOException

Returns a new InputStream to read the content of this attachment.

Returns:

A new InputStream.

Throws:

IOException - If an I/O error occurs.

See Also:

• OutlookMessageAttachment.InputStreamCreator.newInputStream(ch.astorm.jotlmsg.OutlookMessageAttachment)