net.rim.blackberry.api.mail
Class FileSupportedAttachmentPart

java.lang.Object
  net.rim.blackberry.api.mail.BodyPart
      net.rim.blackberry.api.mail.SupportedAttachmentPart
          net.rim.blackberry.api.mail.FileSupportedAttachmentPart

All Implemented Interfaces:

Part

public class FileSupportedAttachmentPart
extends SupportedAttachmentPart

Represents an attachment part for a file that is present on the device. A fully-qualified, absolute path file name should be used as described by the file URL format in IETF RFCs 1738 & 2396.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.5.0

Nested Class Summary

Nested classes/interfaces inherited from class net.rim.blackberry.api.mail.BodyPart

BodyPart.ContentType

Field Summary

Fields inherited from class net.rim.blackberry.api.mail.BodyPart

CONTENT_TYPE, CRLF, EMPTY, SEPARATOR

Fields inherited from interface net.rim.blackberry.api.mail.Part

ATTACHMENT, INLINE

Constructor Summary
	FileSupportedAttachmentPart(Multipart parent, String contentType, String filename) Creates a new FileSupportedAttachmentPart instance with provided parent, content-type, and the file persent on the device.

Method Summary
	Object	getContent() Retrieves the raw data contained in this attachment part.
	InputStream	getInputStream() Retrieves an input stream for this attachment part.
	int	getSize() Retrieves the size of this attachment part's data.

Methods inherited from class net.rim.blackberry.api.mail.SupportedAttachmentPart

getContentType, getFilename, getName, setContent, setContentType, setFilename, writeTo

Methods inherited from class net.rim.blackberry.api.mail.BodyPart

addHeader, getAllHeaders, getHeader, getParent, hasMore, isMimeType, moreRequestSent, removeHeader, setHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSupportedAttachmentPart

public FileSupportedAttachmentPart(Multipart parent,
                                   String contentType,
                                   String filename)

Creates a new FileSupportedAttachmentPart instance with provided parent, content-type, and the file persent on the device. A fully-qualified, absolute path file name should be used as described by the file URL format in IETF RFCs 1738 & 2396.

Parameters:

parent - Existing multipart object to contain this attachment part.

contentType - MIME content-type of this attachment part.

filename - File name

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.5.0

Method Detail

getContent

public Object getContent()

Retrieves the raw data contained in this attachment part.

Specified by:

getContent in interface Part

Overrides:

getContent in class SupportedAttachmentPart

Returns:

Raw bytes that make up the attachment part.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.5.0

getInputStream

public InputStream getInputStream()

Retrieves an input stream for this attachment part.

Specified by:

getInputStream in interface Part

Overrides:

getInputStream in class SupportedAttachmentPart

Returns:

An open input stream.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.5.0

getSize

public int getSize()

Retrieves the size of this attachment part's data.

Specified by:

getSize in interface Part

Overrides:

getSize in class SupportedAttachmentPart

Returns:

Length of this attachment part's contained data in bytes.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.5.0