sirius.web.mails

Class Attachment

java.lang.Object

sirius.web.mails.Attachment

All Implemented Interfaces:

DataSource

Direct Known Subclasses:

BufferedAttachment, ResourceAttachment

public abstract class Attachment
extends Object
implements DataSource

Encapsulates all information required to add an attachment to a mail being sent.

Constructor Summary

Constructors

Constructor and Description
Attachment(String name, String mimeType, boolean asAlternative) Generates a new attachment with the given name, mime type and contents.

Method Summary

Modifier and Type	Method and Description
Attachment	addHeader(String name, String value) Adds a header to the attachment.
String	getContentType()
Set<Map.Entry<String,String>>	getHeaders() Returns all headers declared for this attachment.
String	getName()
OutputStream	getOutputStream()
boolean	isAlternative() Determines if this is an "alternative" to the text content of the mail or a "real" attachment
Attachment	withContentType(String contentType) Updates the content type of the attachment.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.activation.DataSource

getInputStream

Constructor Detail

Attachment

public Attachment(String name,
                  String mimeType,
                  boolean asAlternative)

Generates a new attachment with the given name, mime type and contents.

Parameters:

name - the name of the attached file

mimeType - the mime type of the file. Use MimeHelper to determine it at runtime if it is not know in advance

asAlternative - determines if this attachment is an alternative to the text content of the mail (true) or a real attachment (false)

Method Detail

addHeader

public Attachment addHeader(String name,
                            String value)

Adds a header to the attachment.

Parameters:

name - the name of the header

value - the value of the header

Returns:

the attachment itself to support fluent method calls

withContentType

public Attachment withContentType(String contentType)

Updates the content type of the attachment.

Parameters:

contentType - the new content type to use

Returns:

the attachment itself for fluent method calls

getContentType

public String getContentType()

Specified by:

getContentType in interface DataSource

getName

public String getName()

Specified by:

getName in interface DataSource

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Specified by:

getOutputStream in interface DataSource

Throws:

IOException

getHeaders

public Set<Map.Entry<String,String>> getHeaders()

Returns all headers declared for this attachment.

Returns:

all headers for this attachment

isAlternative

public boolean isAlternative()

Determines if this is an "alternative" to the text content of the mail or a "real" attachment

Returns:

true if this is an alternative, false if this is a real attachment