Aspose::Email::Mapi::MapiRecipient Class Reference

Represents the recipient information in the Microsoft Outlook Message. More...

Inherits Aspose::Email::Mapi::MapiPropertyContainer.

Public Member Functions

System::String get_DisplayName ()
 Gets the display name of the message recipient or sender. More...
 
void set_DisplayName (System::String value)
 Sets the display name of the message recipient or sender. More...
 
System::String get_AddressType ()
 Gets the type of the address of the message recipient or sender. More...
 
System::String get_EmailAddress ()
 Gets the email address of the message recipient or sender. More...
 
void set_EmailAddress (System::String value)
 Sets the email address of the message recipient or sender. More...
 
System::String get_OrganizationEmailAddress ()
 Gets the organization email address. More...
 
MapiRecipientType get_RecipientType ()
 Gets the type of the recipient or sender. More...
 
MapiObjectType get_RecipientClass ()
 Gets the type of recipent. More...
 
System::SharedPtr< MapiPropertyStreamget_PropertyStream ()
 Gets the property stream. More...
 
System::SharedPtr< MapiPropertyCollectionget_SubStorages ()
 Gets the sub storages. More...
 
System::SharedPtr< System::Object > get_Content ()
 Gets the content. More...
 
MapiRecipientTrackStatus get_RecipientTrackStatus ()
 Status of recipient’s response to a meeting request. More...
 
void set_RecipientTrackStatus (MapiRecipientTrackStatus value)
 Status of recipient’s response to a meeting request. More...
 
System::SharedPtr< MapiPropertyCollectionget_NamedProperties ()
 Gets the named properties of message. More...
 
 MapiRecipient ()
 Initializes a new instance of the MapiRecipient class. More...
 
 MapiRecipient (System::String address, System::String displayName, MapiRecipientType recipientType, int32_t count, OutlookMessageFormat format, int32_t codePage)
 Initializes a new instance of the MapiRecipient class. More...
 
 MapiRecipient (System::String address, System::String addressType, System::String displayName, MapiRecipientType recipientType, int32_t count, OutlookMessageFormat format, int32_t codePage)
 Initializes a new instance of the MapiRecipient class. More...
 
int32_t GetSize ()
 Gets the total size of the recipient property values. More...
 
void SetOwner (System::SharedPtr< MapiMessageItemBase > owner)
 Sets the owner. More...
 
System::SharedPtr< Nodes::IMapiNode > CreateMapiNode (System::String key) override
 Creates the mapi node. More...
 
System::SharedPtr< Aspose::Email::Calendar::Model::CalendarProperty > ToIcalendarProperty (bool organizerAllow)
 Converts this instanse to the corresponding iCalendar property More...
 
bool TryGetNamedProperty (System::SharedPtr< MapiProperty > mapiProperty, System::SharedPtr< MapiNamedProperty > &mapiNamedProperty) override
 If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null. More...
 
System::SharedPtr< MapiRecipientClone ()
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual System::SharedPtr< MapiPropertyCollectionget_Properties ()
 Gets the collection of properties. More...
 
virtual int32_t get_CodePage ()
 Gets the code page. More...
 
System::SharedPtr< System::Text::Encoding > get_CurrentEncoding ()
 
 MapiPropertyContainer ()
 Initializes a new instance of the MapiPropertyContainer class. More...
 
 MapiPropertyContainer (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiPropertyContainer class. More...
 
virtual System::SharedPtr< MapiPropertyGetProperty (System::SharedPtr< PropertyDescriptor > pd)
 Gets MAPI property by property descriptor. More...
 
virtual void SetProperty (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value)
 Sets MAPI property. More...
 
System::SharedPtr< MapiPropertyCollectionGetSubStorages ()
 
System::String TryGetPropertyString (int64_t tag, int32_t codepage)
 Try to get a property data as string with specified tag and code page. More...
 
System::ArrayPtr< uint8_t > TryGetPropertyData (int64_t tag)
 Try to get the property data with specified tag key. More...
 
System::String TryGetPropertyString (int64_t tag)
 Try to get a property data as string with specified tag. More...
 
System::String GetPropertyString (int64_t tag, int32_t codepage)
 Gets the string value of the property specified by tag. More...
 
System::String GetPropertyString (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
System::ArrayPtr< uint8_t > GetPropertyBytes (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
virtual void SetProperty (System::SharedPtr< MapiProperty > value)
 Sets the property. More...
 
System::Nullable< int32_t > GetPropertyInt32 (int64_t tag)
 Gets the int32 value of the property specified by tag. More...
 
System::Nullable< int64_t > GetPropertyLong (int64_t tag)
 Gets the value of the property specified by tag as Long (int64) type. More...
 
System::Nullable< int16_t > GetPropertyShort (int64_t tag)
 Gets the value of the property specified by tag as Short type. More...
 
System::Nullable< bool > GetPropertyBoolean (int64_t tag)
 Gets the value of the property specified by tag as Boolean type. More...
 
System::Nullable< System::DateTime > GetPropertyDateTime (int64_t key)
 Gets the value of the property specified by tag as DateTime type. More...
 
bool IsStoreUnicodeOk ()
 Determines if string properties are Unicode encoded or not. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value, int32_t codepage)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyDateTime (int64_t tag, System::DateTime &value)
 Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyLong (int64_t tag, int64_t &value)
 Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyInt32 (int64_t tag, int32_t &value)
 Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded. More...
 
void SetProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
 Set the property. More...
 
void SetProperty (int64_t tag, System::String value, OutlookMessageFormat format)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, bool isUnicode)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, System::SharedPtr< System::Text::Encoding > nonUnicodeEncoding)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value)
 Set the string property with CurrentEncoding More...
 
void SetProperty (int64_t tag, System::DateTime dateTime)
 Set the datetime property. More...
 
void SetPropertyLong (int64_t tag, int64_t value)
 Set the long property. More...
 

Static Public Member Functions

static System::SharedPtr< MapiRecipientFromIcalendarProperty (System::SharedPtr< Aspose::Email::Calendar::Model::CalendarProperty > attendee, OutlookMessageFormat format, int32_t count, int32_t codePage)
 

Friends

class Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter
 
class Aspose::Email::Tools::CalendarConverter
 
class Aspose::Email::Clients::Exchange::WebService::MessageEwsConverter
 
class Aspose::Email::Mapi::MapiCalendarAttendees
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Mapi::MapiRecipientCollection
 
class Aspose::Email::Mapi::MapiRecipientCollectionFactory
 
class Aspose::Email::Mapi::Nodes::RecipientDirectory
 
class Aspose::Email::Storage::Pst::FolderInfo
 
class Aspose::Email::Storage::Pst::Ltp::LtpDoer
 
class Aspose::Email::Storage::Pst::PstDoer
 
class Aspose::Email::Tools::MessageConverter
 

Additional Inherited Members

- Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t codePage
 The code page. More...
 
System::SharedPtr< MapiPropertyCollectionpropertyDictionary
 The property dictionary. More...
 
- Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t DefaultCodePage
 

Detailed Description

Represents the recipient information in the Microsoft Outlook Message.

Constructor & Destructor Documentation

◆ MapiRecipient() [1/3]

Aspose::Email::Mapi::MapiRecipient::MapiRecipient ( )

Initializes a new instance of the MapiRecipient class.

◆ MapiRecipient() [2/3]

Aspose::Email::Mapi::MapiRecipient::MapiRecipient ( System::String  address,
System::String  displayName,
MapiRecipientType  recipientType,
int32_t  count,
OutlookMessageFormat  format,
int32_t  codePage 
)

Initializes a new instance of the MapiRecipient class.

Parameters
addressThe address of recipient.
displayNameThe display name of recipient.
recipientTypeType of the recipient.
countThe count of recipients.
formatThe outlook message format.
codePageThe code page.

◆ MapiRecipient() [3/3]

Aspose::Email::Mapi::MapiRecipient::MapiRecipient ( System::String  address,
System::String  addressType,
System::String  displayName,
MapiRecipientType  recipientType,
int32_t  count,
OutlookMessageFormat  format,
int32_t  codePage 
)

Initializes a new instance of the MapiRecipient class.

Parameters
addressThe address of recipient.
addressTypeAddress type.
displayNameThe display name of recipient.
recipientTypeType of the recipient.
countThe count of recipients.
formatThe outlook message format.
codePageThe code page.

Member Function Documentation

◆ Clone()

System::SharedPtr<MapiRecipient> Aspose::Email::Mapi::MapiRecipient::Clone ( )

◆ CreateMapiNode()

System::SharedPtr<Nodes::IMapiNode> Aspose::Email::Mapi::MapiRecipient::CreateMapiNode ( System::String  key)
overridevirtual

Creates the mapi node.

Parameters
keyThe node key.
Returns
The IMapiNode interface.

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

◆ FromIcalendarProperty()

static System::SharedPtr<MapiRecipient> Aspose::Email::Mapi::MapiRecipient::FromIcalendarProperty ( System::SharedPtr< Aspose::Email::Calendar::Model::CalendarProperty >  attendee,
OutlookMessageFormat  format,
int32_t  count,
int32_t  codePage 
)
static

◆ get_AddressType()

System::String Aspose::Email::Mapi::MapiRecipient::get_AddressType ( )

Gets the type of the address of the message recipient or sender.

This property indicates the type for PR_EMAIL_ADDRESS mapi property.

The address type.

◆ get_Content()

System::SharedPtr<System::Object> Aspose::Email::Mapi::MapiRecipient::get_Content ( )

Gets the content.

The content.

◆ get_DisplayName()

System::String Aspose::Email::Mapi::MapiRecipient::get_DisplayName ( )

Gets the display name of the message recipient or sender.

When setting a value, the values of either MapiMessage.DisplayTo or MapiMessage.DisplayBcc or MapiMessage.DisplayCC are also updated depending on the type of recepient.

The display name.

◆ get_EmailAddress()

System::String Aspose::Email::Mapi::MapiRecipient::get_EmailAddress ( )

Gets the email address of the message recipient or sender.

Note, this property displays an address in SMTP format. It means that if MapiRecipient.AddressType == "EX" and MapiPropertyTag.PR_EMAIL_ADDRESS contain an address in Exchange-style, the value for mapiRecipient.EmailAddress property filling is picked from PR_SMTP_ADDRESS. When setting a value, the values of PR_SEARCH_KEY and PR_ENTRYID properties are updated as well.

The email address.

Exceptions
ArgumentNullExceptionthrows if recipient address is null or empty.
ArgumentExceptionthrows if recipient address is not in a recognized format.

◆ get_NamedProperties()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiRecipient::get_NamedProperties ( )

Gets the named properties of message.

The collection of named properties.

◆ get_OrganizationEmailAddress()

System::String Aspose::Email::Mapi::MapiRecipient::get_OrganizationEmailAddress ( )

Gets the organization email address.

The organization email address.

◆ get_PropertyStream()

System::SharedPtr<MapiPropertyStream> Aspose::Email::Mapi::MapiRecipient::get_PropertyStream ( )

Gets the property stream.

The property stream.

◆ get_RecipientClass()

MapiObjectType Aspose::Email::Mapi::MapiRecipient::get_RecipientClass ( )

Gets the type of recipent.

The recipient class.

◆ get_RecipientTrackStatus()

MapiRecipientTrackStatus Aspose::Email::Mapi::MapiRecipient::get_RecipientTrackStatus ( )

Status of recipient’s response to a meeting request.

◆ get_RecipientType()

MapiRecipientType Aspose::Email::Mapi::MapiRecipient::get_RecipientType ( )

Gets the type of the recipient or sender.

The recipient type.

◆ get_SubStorages()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiRecipient::get_SubStorages ( )

Gets the sub storages.

The sub storages.

◆ GetSize()

int32_t Aspose::Email::Mapi::MapiRecipient::GetSize ( )

Gets the total size of the recipient property values.

Returns

◆ set_DisplayName()

void Aspose::Email::Mapi::MapiRecipient::set_DisplayName ( System::String  value)

Sets the display name of the message recipient or sender.

When setting a value, the values of either MapiMessage.DisplayTo or MapiMessage.DisplayBcc or MapiMessage.DisplayCC are also updated depending on the type of recepient.

The display name.

◆ set_EmailAddress()

void Aspose::Email::Mapi::MapiRecipient::set_EmailAddress ( System::String  value)

Sets the email address of the message recipient or sender.

Note, this property displays an address in SMTP format. It means that if MapiRecipient.AddressType == "EX" and MapiPropertyTag.PR_EMAIL_ADDRESS contain an address in Exchange-style, the value for mapiRecipient.EmailAddress property filling is picked from PR_SMTP_ADDRESS. When setting a value, the values of PR_SEARCH_KEY and PR_ENTRYID properties are updated as well.

The email address.

Exceptions
ArgumentNullExceptionthrows if recipient address is null or empty.
ArgumentExceptionthrows if recipient address is not in a recognized format.

◆ set_RecipientTrackStatus()

void Aspose::Email::Mapi::MapiRecipient::set_RecipientTrackStatus ( MapiRecipientTrackStatus  value)

Status of recipient’s response to a meeting request.

◆ SetOwner()

void Aspose::Email::Mapi::MapiRecipient::SetOwner ( System::SharedPtr< MapiMessageItemBase owner)

Sets the owner.

Parameters
ownerThe owner message.

◆ ToIcalendarProperty()

System::SharedPtr<Aspose::Email::Calendar::Model::CalendarProperty> Aspose::Email::Mapi::MapiRecipient::ToIcalendarProperty ( bool  organizerAllow)

Converts this instanse to the corresponding iCalendar property

Parameters
organizerAllowIndicates whether the ORGANIZER property should be created
Returns
A OrganizerProperty or AttendeeProperty depending on organizerAllow properties of this recipient

◆ TryGetNamedProperty()

bool Aspose::Email::Mapi::MapiRecipient::TryGetNamedProperty ( System::SharedPtr< MapiProperty mapiProperty,
System::SharedPtr< MapiNamedProperty > &  mapiNamedProperty 
)
overridevirtual

If MapiNamedPropertyMappingStorage is available, initializes and returns MapiNamedProperty, otherwise null.

Parameters
mapiProperty
mapiNamedProperty
Returns

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::CalendarEwsConverter
friend

◆ Aspose::Email::Clients::Exchange::WebService::MessageEwsConverter

friend class Aspose::Email::Clients::Exchange::WebService::MessageEwsConverter
friend

◆ Aspose::Email::Mapi::MapiCalendarAttendees

◆ Aspose::Email::Mapi::MapiMessage

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

◆ Aspose::Email::Mapi::MapiRecipientCollection

◆ Aspose::Email::Mapi::MapiRecipientCollectionFactory

friend class Aspose::Email::Mapi::MapiRecipientCollectionFactory
friend

◆ Aspose::Email::Mapi::Nodes::RecipientDirectory

friend class Aspose::Email::Mapi::Nodes::RecipientDirectory
friend

◆ Aspose::Email::Storage::Pst::FolderInfo

◆ Aspose::Email::Storage::Pst::Ltp::LtpDoer

friend class Aspose::Email::Storage::Pst::Ltp::LtpDoer
friend

◆ Aspose::Email::Storage::Pst::PstDoer

friend class Aspose::Email::Storage::Pst::PstDoer
friend

◆ Aspose::Email::Tools::CalendarConverter

friend class Aspose::Email::Tools::CalendarConverter
friend

◆ Aspose::Email::Tools::MessageConverter

friend class Aspose::Email::Tools::MessageConverter
friend