Aspose::Email::Mapi::MapiAttachmentCollection Class Reference

Represents a collection of MapiAttachment objects. More...

Inherits System::Collections::Generic::ListExt< System::SharedPtr< Aspose::Email::Mapi::MapiAttachment > >.

Public Member Functions

 MapiAttachmentCollection ()
 Initializes a new instance of the MapiAttachmentCollection class. More...
 
 MapiAttachmentCollection (System::SharedPtr< MapiMessageItemBase > owner)
 Initializes a new instance of the MapiAttachmentCollection class. More...
 
void Add (System::String name, System::SharedPtr< MapiMessage > msg)
 Adds the new attachment as embedded message. More...
 
void Add (System::String name, System::ArrayPtr< uint8_t > data)
 Adds the new attachment. More...
 
void Add (System::SharedPtr< MapiAttachment > const &item) override
 Adds an object to the end of the T:System::Collections::ObjectModel::Collection`1. More...
 
void Insert (int32_t index, System::SharedPtr< MapiAttachment > const &item) override
 Inserts an element into the T:System::Collections::ObjectModel::Collection`1 at the specified index. More...
 
void Insert (int32_t index, System::String name, System::SharedPtr< MapiMessage > msg)
 Inserts a message as attachment into the MapiAttachmentCollection at the specified index. More...
 
void Replace (int32_t index, System::String name, System::SharedPtr< MapiMessage > msg)
 Replaces an element at the specified index. More...
 
void RemoveAt (int32_t index) override
 Removes the element at the specified index of the MapiAttachmentCollection. More...
 
bool Remove (System::SharedPtr< MapiAttachment > const &item) override
 Removes the first occurrence of a specific object from the MapiAttachmentCollection. More...
 
System::String GetNames ()
 Gets the attachment names separated with comma. More...
 
bool ContainsFileName (System::String fileName)
 Determines whether an element with defined name is in the collection. More...
 
System::SharedPtr< MapiAttachmentCreateMapiAttachment (System::String name, System::SharedPtr< MapiMessage > msg, int32_t attachNum)
 
void DeepCopyTo (System::SharedPtr< MapiAttachmentCollection > dest)
 
void SetTemplateWeakPtr (uint32_t argument) override
 

Protected Member Functions

virtual ~MapiAttachmentCollection ()
 

Friends

class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Tnef::TnefAttachment
 
class Aspose::Email::Tools::ForwardMessageBuilder
 

Detailed Description

Represents a collection of MapiAttachment objects.

Constructor & Destructor Documentation

◆ MapiAttachmentCollection() [1/2]

Aspose::Email::Mapi::MapiAttachmentCollection::MapiAttachmentCollection ( )

Initializes a new instance of the MapiAttachmentCollection class.

◆ MapiAttachmentCollection() [2/2]

Aspose::Email::Mapi::MapiAttachmentCollection::MapiAttachmentCollection ( System::SharedPtr< MapiMessageItemBase owner)

Initializes a new instance of the MapiAttachmentCollection class.

Parameters
ownerThe owner message.

◆ ~MapiAttachmentCollection()

virtual Aspose::Email::Mapi::MapiAttachmentCollection::~MapiAttachmentCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/3]

void Aspose::Email::Mapi::MapiAttachmentCollection::Add ( System::SharedPtr< MapiAttachment > const &  item)
override

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

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

◆ Add() [2/3]

void Aspose::Email::Mapi::MapiAttachmentCollection::Add ( System::String  name,
System::ArrayPtr< uint8_t >  data 
)

Adds the new attachment.

Parameters
nameThe name of attachment.
dataThe attachment data.
Exceptions
ArgumentNullExceptionthrows if attachment name is null or empty.
ArgumentNullExceptionthrows if attachment data is null.

◆ Add() [3/3]

void Aspose::Email::Mapi::MapiAttachmentCollection::Add ( System::String  name,
System::SharedPtr< MapiMessage msg 
)

Adds the new attachment as embedded message.

Parameters
nameThe name of attachment.
msgThe MapiMessage that represents the attached message.
Exceptions
ArgumentNullExceptionthrows if message is null.

◆ ContainsFileName()

bool Aspose::Email::Mapi::MapiAttachmentCollection::ContainsFileName ( System::String  fileName)

Determines whether an element with defined name is in the collection.

Parameters
fileName
Returns
true if item is found in the collections otherwise, false.

◆ CreateMapiAttachment()

System::SharedPtr<MapiAttachment> Aspose::Email::Mapi::MapiAttachmentCollection::CreateMapiAttachment ( System::String  name,
System::SharedPtr< MapiMessage msg,
int32_t  attachNum 
)

◆ DeepCopyTo()

void Aspose::Email::Mapi::MapiAttachmentCollection::DeepCopyTo ( System::SharedPtr< MapiAttachmentCollection dest)

◆ GetNames()

System::String Aspose::Email::Mapi::MapiAttachmentCollection::GetNames ( )

Gets the attachment names separated with comma.

Returns

◆ Insert() [1/2]

void Aspose::Email::Mapi::MapiAttachmentCollection::Insert ( int32_t  index,
System::SharedPtr< MapiAttachment > const &  item 
)
override

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

Parameters
indexThe zero-based index at which item should be inserted.
itemThe object to insert. The value can be null for reference types.
Exceptions
T:System::ArgumentOutOfRangeExceptionindex is less than zero.

-or-

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

◆ Insert() [2/2]

void Aspose::Email::Mapi::MapiAttachmentCollection::Insert ( int32_t  index,
System::String  name,
System::SharedPtr< MapiMessage msg 
)

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

Parameters
indexThe zero-based index at which should be inserted.
nameThe name of attachment.
msgThe MapiMessage that represents the attached message.
Exceptions
ArgumentNullExceptionthrows if message is null.

◆ Remove()

bool Aspose::Email::Mapi::MapiAttachmentCollection::Remove ( System::SharedPtr< MapiAttachment > const &  item)
override

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

Parameters
itemThe object to remove from the MapiAttachmentCollection.
Returns
true if item is successfully removed; otherwise, false.

◆ RemoveAt()

void Aspose::Email::Mapi::MapiAttachmentCollection::RemoveAt ( int32_t  index)
override

Removes the element at the specified index of the MapiAttachmentCollection.

Parameters
indexhe zero-based index of the element to remove.

◆ Replace()

void Aspose::Email::Mapi::MapiAttachmentCollection::Replace ( int32_t  index,
System::String  name,
System::SharedPtr< MapiMessage msg 
)

Replaces an element at the specified index.

Parameters
indexThe zero-based index at which should be replaced.
nameThe name of attachment.
msgThe MapiMessage that represents the attached message.
Exceptions
ArgumentNullExceptionthrows if message is null.

◆ SetTemplateWeakPtr()

void Aspose::Email::Mapi::MapiAttachmentCollection::SetTemplateWeakPtr ( uint32_t  argument)
override

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend

◆ Aspose::Email::Tnef::TnefAttachment

friend class Aspose::Email::Tnef::TnefAttachment
friend

◆ Aspose::Email::Tools::ForwardMessageBuilder