com.aspose.email

Class MapiAttachment

java.lang.Object

com.aspose.email.MapiPropertyContainer

com.aspose.email.MapiAttachment

public class MapiAttachment
extends MapiPropertyContainer

Represents a message attachment.

This class encapsulates an attachment, providing methods to access and manipulate its properties.

Example:

 // This code example loads a message from a file and iterates over each attachment.
 // If an attachment is inline, it prints its display name.
 // If not, it checks if the attachment is an embedded message.
 // If so, it saves the attachment to a memory stream.
 // If not, it saves to a specified path.

 // Load the MAPI message from the specified file
 MapiMessage msg = MapiMessage.load("source.msg");

 // Iterate over each attachment in the MAPI message
 for (MapiAttachment mapiAttachment : msg.getAttachments()) {
     // Check if the attachment is inline
     if (mapiAttachment.isInline()) {
         // If inline, print its display name
         System.out.println("Inline: " + mapiAttachment.getDisplayName());
     } else {
         // If not inline
         // Check if the attachment contains an embedded message
         if (mapiAttachment.getObjectData() != null && mapiAttachment.getObjectData().isOutlookMessage()) {
             // If it's an embedded message
             // Save the attachment to a memory stream
             try (ByteArrayOutputStream ms = new ByteArrayOutputStream()) {
                 mapiAttachment.save(ms);
                 byte[] bytes = ms.toByteArray();
                 try (ByteArrayInputStream msInput = new ByteArrayInputStream(bytes)) {
                     // Load the embedded message from the memory stream
                     MapiMessage embeddedMessage = MapiMessage.load(msInput);
                 }
             } catch (IOException e) {
                 e.printStackTrace();
             }
         } else {
             // If it's not an embedded message
             // Save the attachment to the specified path
             mapiAttachment.save(Paths.get(path, mapiAttachment.getLongFileName()).toString());
         }
     }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected MapiNamedPropertyMappingStorage	namedPropertyMappingStorage The named property mapping storage.

Method Summary

Methods

Modifier and Type	Method and Description
com.aspose.email.IMapiNode	createMapiNode(String key) Creates the mapi node.
byte[]	getBinaryData() Gets or sets binary attachment data.
Object	getContent() Gets the content.
String	getDisplayName() Gets the display name of the ole object in an attachment.
String	getExtension() Gets a filename extension that indicates the document type of an attachment.
String	getFileName() Gets an attachment's base filename and extension, excluding path.
String	getItemId() The item id, uses with a server
String	getLongFileName() Gets an attachment's long filename and extension, excluding path.
String	getMimeTag() Gets formatting information about a Multipurpose Internet Mail Extensions (MIME) attachment.
MapiPropertyCollection	getNamedProperties() Gets the named properties of message.
MapiObjectProperty	getObjectData() Gets an attachment object typically accessed through the OLE IStorage interface.
MapiProperty	getProperty(PropertyDescriptor pd) Gets MAPI property by property descriptor.
MapiPropertyStream	getPropertyStream() Gets the property stream.
MapiPropertyCollection	getSubStorages() Gets the sub storages.
boolean	isInline() Gets a value indicating whether the attachment is inline or regular.
void	removeProperty(long tag) Provides correctly removing property from all collections.
void	save(OutputStream stream) Save attachment content.
void	save(String filename) Save attachment content.
void	setBinaryData(byte[] value) Gets or sets binary attachment data.
void	setDisplayName(String value) Gets the display name of the ole object in an attachment.
void	setProperty(MapiProperty value) Sets the property.
void	setProperty(PropertyDescriptor pd, Object value) Sets MAPI property.

Methods inherited from class com.aspose.email.MapiPropertyContainer

getCodePage, getProperties, getPropertyBoolean, getPropertyBytes, getPropertyDateTime, getPropertyInt32, getPropertyLong, getPropertyShort, getPropertyString, getPropertyString, isStoreUnicodeOk, tryGetPropertyData, tryGetPropertyDateTime, tryGetPropertyInt32, tryGetPropertyLong, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString

Methods inherited from class java.lang.Object

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

Field Detail

namedPropertyMappingStorage

protected MapiNamedPropertyMappingStorage namedPropertyMappingStorage

The named property mapping storage.

Method Detail

getItemId

public String getItemId()

The item id, uses with a server

isInline

public boolean isInline()

Gets a value indicating whether the attachment is inline or regular. If inline returns true, otherwise false.

getExtension

public final String getExtension()

Gets a filename extension that indicates the document type of an attachment.

Value: The extension.

getPropertyStream

public final MapiPropertyStream getPropertyStream()

Gets the property stream.

Value: The property stream.

getSubStorages

public final MapiPropertyCollection getSubStorages()

Gets the sub storages.

Value: The sub storages.

getFileName

public final String getFileName()

Gets an attachment's base filename and extension, excluding path.

Value: The file name.

getLongFileName

public final String getLongFileName()

Gets an attachment's long filename and extension, excluding path.

Value: The long file name.

getDisplayName

public final String getDisplayName()

Gets the display name of the ole object in an attachment.

Value: The display name.

setDisplayName

public final void setDisplayName(String value)

Gets the display name of the ole object in an attachment.

Value: The display name.

getMimeTag

public final String getMimeTag()

Gets formatting information about a Multipurpose Internet Mail Extensions (MIME) attachment.

Value: The mime tag.

getBinaryData

public final byte[] getBinaryData()

Gets or sets binary attachment data.

Value: The binary data.

setBinaryData

public final void setBinaryData(byte[] value)

Gets or sets binary attachment data.

Value: The binary data.

getContent

public final Object getContent()

Gets the content.

Value: The content.

getObjectData

public final MapiObjectProperty getObjectData()

Gets an attachment object typically accessed through the OLE IStorage interface.

Value: The object data.

getNamedProperties

public final MapiPropertyCollection getNamedProperties()

Gets the named properties of message.

Value: The collection of named properties.

save

public final void save(String filename)

Save attachment content.

Parameters:

filename - The file name to save.

save

public final void save(OutputStream stream)

Save attachment content.

Parameters:

stream - The stream to save.

setProperty

public void setProperty(MapiProperty value)

Sets the property.

Overrides:

setProperty in class MapiPropertyContainer

Parameters:

value - The property.

Throws:

ArgumentNullException - If value is null.

ArgumentException - If property data is null.

InvalidOperationException - If data type is not supported.

removeProperty

public final void removeProperty(long tag)

Provides correctly removing property from all collections.

Parameters:

tag - The tag of MapiProperty.

createMapiNode

public com.aspose.email.IMapiNode createMapiNode(String key)

Creates the mapi node.

Overrides:

createMapiNode in class MapiPropertyContainer

Parameters:

key - The node key.

Returns:

The IMapiNode interface.

getProperty

public MapiProperty getProperty(PropertyDescriptor pd)

Gets MAPI property by property descriptor.

Overrides:

getProperty in class MapiPropertyContainer

Parameters:

pd - Property descriptor for looked property

Returns:

Mapi property if it is found, otherwise null.

setProperty

public void setProperty(PropertyDescriptor pd,
               Object value)

Sets MAPI property.

Overrides:

setProperty in class MapiPropertyContainer

Parameters:

pd - The property descriptor.

value - The property data.