com.groupdocs.viewer.results

Interface Attachment

public interface Attachment

Represents an attachment file contained by an email message, archive, PDF document, or Outlook data file.

The Attachment interface defines the contract for accessing and manipulating attachment files in the GroupDocs.Viewer component. It provides methods to retrieve information such as file name, size, and content type of the attachment.

Example usage:

 try (Viewer viewer = new Viewer("document.eml")) {
     List<Attachment> attachments = viewer.getAttachments();

     // Use the attachments object for further operations
 }
 

Note: The default implementation of this interface is AttachmentImpl.

See Also:

Viewer

Method Summary

Modifier and Type	Method and Description
String	getFileName() Retrieves the file name of the attachment.
String	getFilePath() Retrieves the relative path of the attachment.
FileType	getFileType() Retrieves the file type of the attachment.
String	getId() Retrieves the unique identifier of the attachment within the context of a single file that contains this attachment.
long	getSize() Retrieves the file size of the attachment in bytes.
void	setFileName(String fileName) Sets the file name of the attachment.
void	setFilePath(String filePath) Sets the relative path of the attachment.
void	setFileType(FileType fileType) Sets the file type of the attachment.
void	setId(String id) Sets the unique identifier of the attachment.
void	setSize(long size) Sets the file size of the attachment in bytes.

Method Detail

getFileName

String getFileName()

Retrieves the file name of the attachment.

Returns:

the file name of the attachment.

getFilePath

String getFilePath()

Retrieves the relative path of the attachment. The path can be in the format "folder/file.docx" when the file is located within a folder, or it can be the filename when the file is located in the root of an archive, an e-mail message, or a data file.

Returns:

the relative path of the attachment.

getFileType

FileType getFileType()

Retrieves the file type of the attachment.

Returns:

the file type of the attachment.

See Also:

FileType

getId

String getId()

Retrieves the unique identifier of the attachment within the context of a single file that contains this attachment.

Returns:

the unique identifier of the attachment.

getSize

long getSize()

Retrieves the file size of the attachment in bytes.

Returns:

the file size of the attachment.

setFileName

void setFileName(String fileName)

Sets the file name of the attachment.

Parameters:

fileName - the file name to set.

setFilePath

void setFilePath(String filePath)

Sets the relative path of the attachment.

Parameters:

filePath - the relative path to set.

setFileType

void setFileType(FileType fileType)

Sets the file type of the attachment.

Parameters:

fileType - the file type to set.

See Also:

FileType

setId

void setId(String id)

Sets the unique identifier of the attachment.

Parameters:

id - the unique identifier to set.

setSize

void setSize(long size)

Sets the file size of the attachment in bytes.

Parameters:

size - the file size to set.