com.basis.api.admin

Class BBjAdminEmailAttachment

java.lang.Object

com.basis.api.admin.BBjAdminEmailAttachment

All Implemented Interfaces:

java.io.Serializable

public class BBjAdminEmailAttachment
extends java.lang.Object
implements java.io.Serializable

A single email message that will be sent through a BBjAdminEmailService.

Find a complete code sample at: BBjAdminEmailService.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BBjAdminEmailAttachment()

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get the byte[] contents of the file.
java.lang.String	getFilename() Get the filename for the attachment.
void	setBytes(byte[] p_bytes) Set the byte array contents for the file.
void	setBytesFromFile(java.io.File p_file) Helper method to set the byte array for the file by specifying the java.io.File instead of a byte array.
void	setFilename(java.lang.String p_filename) Sets the filename for the attached file.

Methods inherited from class java.lang.Object

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

Constructor Detail

BBjAdminEmailAttachment

public BBjAdminEmailAttachment()

Method Detail

setFilename

public void setFilename(java.lang.String p_filename)

Sets the filename for the attached file.

Parameters:

p_filename - Name of file. Not the full path, just the filename.

getFilename

public java.lang.String getFilename()

Get the filename for the attachment.

Returns:

Name of the file.

getBytes

public byte[] getBytes()
                throws BBjAdminException

Get the byte[] contents of the file.

Returns:

File's byte contents.

Throws:

BBjAdminException

setBytes

public void setBytes(byte[] p_bytes)

Set the byte array contents for the file.

Parameters:

p_bytes - Contents of the file.

setBytesFromFile

public void setBytesFromFile(java.io.File p_file)
                      throws BBjAdminException

Helper method to set the byte array for the file by specifying the java.io.File instead of a byte array.

Parameters:

p_file - File to extract bytes from.

Throws:

BBjAdminException