com.aspose.email

Class MapiAttachmentCollection

java.lang.Object

List<MapiAttachment>

com.aspose.email.MapiAttachmentCollection

All Implemented Interfaces:

IGenericCollection<MapiAttachment>, IGenericEnumerable<MapiAttachment>, IGenericList<MapiAttachment>, IEnumerable<MapiAttachment>, Iterable<MapiAttachment>, Collection<MapiAttachment>, List<MapiAttachment>

public class MapiAttachmentCollection
extends List<MapiAttachment>

Represents a collection of MapiAttachment objects.

Nested Class Summary

Nested classes/interfaces inherited from class List

List.Enumerator<T>, List.EnumeratorJava<T>

Constructor Summary

Constructors

Constructor and Description
MapiAttachmentCollection() Initializes a new instance of the MapiAttachmentCollection class.
MapiAttachmentCollection(MapiMessageItemBase owner) Initializes a new instance of the MapiAttachmentCollection class.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String name, byte[] data) Adds the new attachment.
void	add(String name, InputStream data) Adds the new attachment.
void	add(String name, MapiMessage msg) Adds the new attachment as embedded message.
void	add(String name, ReferenceAttachmentOptions options) Adds a reference attachment to the collection using the specified name and configuration options.
void	add(String name, String sharedLink, String url, String providerName) Deprecated. Use Add(string name, ReferenceAttachmentOptions options) instead.
void	addMapiAttachment(MapiAttachment item) Adds an object to the end of the System.Collections.ObjectModel.Collection`1.
void	insert(int index, String name, MapiMessage msg) Inserts a message as attachment into the MapiAttachmentCollection at the specified index.
void	insertMapiAttachment(int index, MapiAttachment item) Inserts an element into the System.Collections.ObjectModel.Collection`1 at the specified index.
void	removeAt(int index) Removes the element at the specified index of the MapiAttachmentCollection.
boolean	removeMapiAttachment(MapiAttachment item) Removes the first occurrence of a specific object from the MapiAttachmentCollection.
void	replace(int index, String name, MapiMessage msg) Replaces an element at the specified index.

Methods inherited from class List

add, add, addAll, addAll, addItem, addRange, addRange, asReadOnly, binarySearch, binarySearch, binarySearch, clear, contains, containsAll, containsItem, convertAll, copyTo, copyTo, copyTo, copyToTArray, exists, find, findAll, findIndex, findIndex, findIndex, findLast, findLastIndex, findLastIndex, findLastIndex, forEach, fromJava, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, fromPrimitiveArray, get_Item, get, getCapacity, getRange, getSyncRoot, getVersion, indexOf, indexOf, indexOf, indexOfItem, insertItem, insertRange, isEmpty, isFixedSize, isReadOnly, isSynchronized, iterator, iteratorJava, lastIndexOf, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAll, removeItem, removeRange, retainAll, reverse, reverse, set_Item, set, setCapacity, size, sort, sort, sort, sort, subList, toArray, toArray, toJava, trimExcess, trueForAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

MapiAttachmentCollection

public MapiAttachmentCollection()

Initializes a new instance of the MapiAttachmentCollection class.

MapiAttachmentCollection

public MapiAttachmentCollection(MapiMessageItemBase owner)

Initializes a new instance of the MapiAttachmentCollection class.

Parameters:

owner - The owner message.

Method Detail

add

public final void add(String name,
       MapiMessage msg)

Adds the new attachment as embedded message.

Parameters:

name - The name of attachment.

msg - The MapiMessage that represents the attached message.

Throws:

ArgumentNullException - throws if message is null.

add

public final void add(String name,
       byte[] data)

Adds the new attachment.

Parameters:

name - The name of attachment.

data - The attachment data.

Throws:

ArgumentNullException - throws if attachment name is null or empty.

ArgumentNullException - throws if attachment data is null.

add

public final void add(String name,
       InputStream data)

Adds the new attachment.

Parameters:

name - The name of attachment.

data - The attachment data.

Throws:

ArgumentNullException - throws if attachment name is null or empty.

ArgumentNullException - throws if attachment data is null.

add

@Deprecated
public final void add(String name,
                  String sharedLink,
                  String url,
                  String providerName)

Deprecated. Use Add(string name, ReferenceAttachmentOptions options) instead.

Adds the reference attachment.

 <p>This example demonstrates how to add a reference attachment to a message.</p>
 
[C#]
 
 // Let's say you want to send an email message that includes a link to a Document.pdf file stored on a Google Drive.
 // Instead of attaching the document directly to the email message,
 // you can create a reference attachment that links to the file on the Google Drive.
 // Create a message
 var msg = new MapiMessage("from@domain.com", "to@domain.com", "Outlook message file",
     "This message is created by Aspose.Email", OutlookMessageFormat.Unicode);
 // Add reference attachment
 msg.Attachments.Add("Document.pdf",
     "https://drive.google.com/file/d/1HJ-M3F2qq1oRrTZ2GZhUdErJNy2CT3DF/",
     "https://drive.google.com/drive/my-drive",
     "GoogleDrive");
 //Also, you can set additional attachment properties
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentPermissionType, AttachmentPermissionType.AnyoneCanEdit);
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentOriginalPermissionType, 0);
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentIsFolder, false);
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentProviderEndpointUrl, "");
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentPreviewUrl, "");
 msg.Attachments[0].SetProperty(KnownPropertyList.AttachmentThumbnailUrl, "");
 // Finally save the message
 msg.Save(@"my.msg");
 
 
[Visual Basic]
 
 ' Let's say you want to send an email message that includes a link to a Document.pdf file stored on a Google Drive.
 ' Instead of attaching the document directly to the email message,
 ' you can create a reference attachment that links to the file on the Google Drive.
 ' Create a message
 Dim msg As New MapiMessage("from@domain.com", "to@domain.com", "Outlook message file", "This message is created by Aspose.Email", OutlookMessageFormat.Unicode)
 ' Add reference attachment
 msg.Attachments.Add("Document.pdf", "https://drive.google.com/file/d/1HJ-M3F2qq1oRrTZ2GZhUdErJNy2CT3DF/", "https://drive.google.com/drive/my-drive", "GoogleDrive")
 ' Also, you can set additional attachment properties
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentPermissionType, AttachmentPermissionType.AnyoneCanEdit)
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentOriginalPermissionType, AttachmentPermissionType.None)
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentIsFolder, False)
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentProviderEndpointUrl, "")
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentPreviewUrl, "")
 msg.Attachments(0).SetProperty(KnownPropertyList.AttachmentThumbnailUrl, "")
 ' Finally save the message
 msg.Save("my.msg")
 
 

Parameters:

name - The name of attachment.

sharedLink - A fully qualified shared link to the attachment provided by web service manipulating the attachment.

url - A file location.

providerName - A name of reference attachment provider.

A reference attachment is a type of attachment that includes a link or a reference to a file or item, rather than including the file or item itself in the email message. When the recipients of the email click on the reference attachment, they will be able to access the linked file if they have the appropriate permissions to do so. By using a reference attachment, you can send a smaller email message and ensure that everyone has access to the most up-to-date version of the file or item.

This method is <b>obsolete</b>. Use add(String,ReferenceAttachmentOptions) instead for better configurability and ease of use.

Throws:

ArgumentNullException - throws if attachment name is null or empty.

ArgumentNullException - throws if attachment shared link is null or empty.

add

public final void add(String name,
       ReferenceAttachmentOptions options)

Adds a reference attachment to the collection using the specified name and configuration options.

  The following example demonstrates how to use this method in C#:
  
[C#]
  
  var options = new ReferenceAttachmentOptions(
      "https://drive.google.com/file/d/1HJ-M3F2qq1oRrTZ2GZhUdErJNy2CT3DF/",
      "https://drive.google.com/drive/my-drive",
      "GoogleDrive"
  )
  {
      PermissionType = AttachmentPermissionType.AnyoneCanEdit,
      OriginalPermissionType = 0,
      IsFolder = false
  };
  msg.Attachments.Add("Document.pdf", options);
  
  The following example demonstrates how to use this method in Visual Basic:
  
[Visual Basic]
  
  Dim options As New ReferenceAttachmentOptions(
      "https://drive.google.com/file/d/1HJ-M3F2qq1oRrTZ2GZhUdErJNy2CT3DF/",
      "https://drive.google.com/drive/my-drive",
      "GoogleDrive"
  )
  options.PermissionType = AttachmentPermissionType.AnyoneCanEdit
  options.OriginalPermissionType = 0
  options.IsFolder = False
  msg.Attachments.Add("Document.pdf", options)
  
  

Parameters:

name - The name of the attachment to display in the message.

options - An instance of ReferenceAttachmentOptions containing the configuration details for the reference attachment, such as the shared link, URL, and provider name.

This method adds a reference attachment to the message and applies additional properties based on the provided ReferenceAttachmentOptions object. The additional properties include permission type, original permission type, folder indicator, provider endpoint URL, preview URL, and thumbnail URL.

Throws:

ArgumentNullException - Thrown if options is null.

addMapiAttachment

public final void addMapiAttachment(MapiAttachment item)

Adds an object to the end of the System.Collections.ObjectModel.Collection`1.

Parameters:

item - The object to be added to the end of the System.Collections.ObjectModel.Collection`1. The value can be null for reference types.

insertMapiAttachment

public final void insertMapiAttachment(int index,
                        MapiAttachment item)

Inserts an element into the System.Collections.ObjectModel.Collection`1 at the specified index.

Parameters:

index - The zero-based index at which item should be inserted.

item - The object to insert. The value can be null for reference types.

Throws:

ArgumentOutOfRangeException - index is less than zero.

-or-

index is greater than P:System.Collections.ObjectModel.Collection`1.Count.

insert

public final void insert(int index,
          String name,
          MapiMessage msg)

Inserts a message as attachment into the MapiAttachmentCollection at the specified index.

Parameters:

index - The zero-based index at which should be inserted.

name - The name of attachment.

msg - The MapiMessage that represents the attached message.

Throws:

ArgumentNullException - throws if message is null.

replace

public final void replace(int index,
           String name,
           MapiMessage msg)

Replaces an element at the specified index.

Parameters:

index - The zero-based index at which should be replaced.

name - The name of attachment.

msg - The MapiMessage that represents the attached message.

Throws:

ArgumentNullException - throws if message is null.

removeAt

public final void removeAt(int index)

Removes the element at the specified index of the MapiAttachmentCollection.

Specified by:

removeAt in interface IGenericList<MapiAttachment>

Overrides:

removeAt in class List<MapiAttachment>

Parameters:

index - he zero-based index of the element to remove.

removeMapiAttachment

public final boolean removeMapiAttachment(MapiAttachment item)

Removes the first occurrence of a specific object from the MapiAttachmentCollection.

Parameters:

item - The object to remove from the MapiAttachmentCollection.

Returns:

true if item is successfully removed; otherwise, false.