com.aspose.email
Class MapiRecipientCollection

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.ArrayList<MapiRecipient>
              extended by com.aspose.email.MapiRecipientCollection
All Implemented Interfaces:
Serializable, Cloneable, Iterable<MapiRecipient>, Collection<MapiRecipient>, List<MapiRecipient>, RandomAccess

public class MapiRecipientCollection
extends ArrayList<MapiRecipient>

Represents a collection of MapiRecipient objects.

See Also:
Serialized Form

Constructor Summary
MapiRecipientCollection()
           Initializes a new instance of the MapiRecipientCollection class.
 
Method Summary
 void add(String address, String displayName, int recipientType)
           Adds the new recipient.
 void addMapiRecipient(MapiRecipient item)
           Adds an object to the end of the T:System.Collections.ObjectModel.Collection`1.
 void insertMapiRecipient(int index, MapiRecipient item)
           Inserts an element into the T:System.Collections.ObjectModel.Collection`1 at the specified index.
 
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Constructor Detail

MapiRecipientCollection

public MapiRecipientCollection()

Initializes a new instance of the MapiRecipientCollection class.

Method Detail

add

public void add(String address,
                String displayName,
                int recipientType)

Adds the new recipient.

Parameters:
address - The mail address of recipient.
displayName - The display name of recipient.
recipientType - Type of the recipient.


When adding a new recepient, the value of either MapiMessage.DisplayTo or MapiMessage.DisplayBcc or MapiMessage.DisplayCC is also updated depending on the type of recepient.

Throws:
com.aspose.email.ms.System.IllegalArgumentException - throws if recipient address is null or empty.
com.aspose.email.ms.System.IllegalArgumentException - throws if recipient address is not in a recognized format.

addMapiRecipient

public void addMapiRecipient(MapiRecipient item)

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

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

insertMapiRecipient

public void insertMapiRecipient(int index,
                                MapiRecipient item)

Inserts an element into the T: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:
T:System.ArgumentOutOfRangeException - index is less than zero.

-or-

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


Copyright (c) 2008-2013 Aspose Pty Ltd. All Rights Reserved.