me.adaptive.arp.api

Class EmailAttachmentData

java.lang.Object

me.adaptive.arp.api.APIBean

me.adaptive.arp.api.EmailAttachmentData

public class EmailAttachmentData
extends APIBean

Structure representing the binary attachment data.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
EmailAttachmentData() Default Constructor
EmailAttachmentData(byte[] data, long size, java.lang.String fileName, java.lang.String mimeType, java.lang.String referenceUrl) Constructor with fields

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Returns the raw data in byte[]
java.lang.String	getFileName() Returns the filename of the attachment
java.lang.String	getMimeType() Returns the mime type of the attachment
java.lang.String	getReferenceUrl() Returns the absolute url of the file attachment
long	getSize() Returns the size of the attachment as a long
void	setData(byte[] data) Set the data of the attachment as a byte[]
void	setFileName(java.lang.String fileName) Set the name of the file attachment
void	setMimeType(java.lang.String mimeType) Set the mime type of the attachment
void	setReferenceUrl(java.lang.String referenceUrl) Set the absolute url of the attachment
void	setSize(long size) Set the size of the attachment as a long

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailAttachmentData

public EmailAttachmentData()

Default Constructor

Since:

v2.0

EmailAttachmentData

public EmailAttachmentData(byte[] data,
                           long size,
                           java.lang.String fileName,
                           java.lang.String mimeType,
                           java.lang.String referenceUrl)

Constructor with fields

Parameters:

data - raw data of the file attachment

size - size of the file attachment

fileName - name of the file attachment

mimeType - mime type of the file attachment

referenceUrl - relative url of the file attachment

Since:

v2.0

Method Detail

getData

public byte[] getData()

Returns the raw data in byte[]

Returns:

data Octet-binary content of the attachment payload.

Since:

v2.0

setData

public void setData(byte[] data)

Set the data of the attachment as a byte[]

Parameters:

data - Sets the octet-binary content of the attachment.

Since:

v2.0

getFileName

public java.lang.String getFileName()

Returns the filename of the attachment

Returns:

fileName Name of the attachment.

Since:

v2.0

setFileName

public void setFileName(java.lang.String fileName)

Set the name of the file attachment

Parameters:

fileName - Name of the attachment.

Since:

v2.0

getMimeType

public java.lang.String getMimeType()

Returns the mime type of the attachment

Returns:

mimeType

Since:

v2.0

setMimeType

public void setMimeType(java.lang.String mimeType)

Set the mime type of the attachment

Parameters:

mimeType - Mime-type of the attachment.

Since:

v2.0

getReferenceUrl

public java.lang.String getReferenceUrl()

Returns the absolute url of the file attachment

Returns:

referenceUrl Absolute URL of the file attachment for either file:// or http:// access.

Since:

v2.0

setReferenceUrl

public void setReferenceUrl(java.lang.String referenceUrl)

Set the absolute url of the attachment

Parameters:

referenceUrl - Absolute URL of the file attachment for either file:// or http:// access.

Since:

v2.0

getSize

public long getSize()

Returns the size of the attachment as a long

Returns:

size Length in bytes of the octet-binary content.

Since:

v2.0

setSize

public void setSize(long size)

Set the size of the attachment as a long

Parameters:

size - Length in bytes of the octet-binary content ( should be same as data array length.)

Since:

v2.0