Aspose::Email::PersonalInfo::EmailAddress Class Reference

Represents an email address More...

Inherits Aspose::Email::MailAddress, IComparable< System::SharedPtr< Aspose::Email::PersonalInfo::EmailAddress > >, and IEquatable< System::SharedPtr< Aspose::Email::PersonalInfo::EmailAddress > >.

Public Member Functions

ASPOSE_EMAIL_SHARED_API bool get_Prefered () const
 Gets a value which defines whether email address is preferred. More...
 
ASPOSE_EMAIL_SHARED_API void set_Prefered (bool value)
 Sets a value which defines whether email address is preferred. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< EmailAddressCategoryget_Category () const
 Gets an object category More...
 
ASPOSE_EMAIL_SHARED_API void set_Category (System::SharedPtr< EmailAddressCategory > value)
 Sets an object category More...
 
ASPOSE_EMAIL_SHARED_API System::String get_RoutingType () const
 Gets a routing type for an email More...
 
ASPOSE_EMAIL_SHARED_API void set_RoutingType (System::String value)
 Sets a routing type for an email More...
 
ASPOSE_EMAIL_SHARED_API EmailAddress ()
 Initializes a new instance of the EmailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API EmailAddress (System::String address)
 Initializes a new instance of the EmailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API EmailAddress (System::String address, System::String displayName)
 Initializes a new instance of the EmailAddress class. More...
 
virtual ASPOSE_EMAIL_SHARED_API System::String ToString ()
 Returns a string that represents the current object. More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t GetHashCode ()
 GetHashCode returns a hash function for this object. More...
 
ASPOSE_EMAIL_SHARED_API int32_t GetHashCode (System::SharedPtr< EmailAddress > obj)
 GetHashCode returns a hash function for specified object. More...
 
virtual ASPOSE_EMAIL_SHARED_API bool Equals (System::SharedPtr< System::Object > obj)
 Determines whether the specified Object is equal to the current Object. More...
 
ASPOSE_EMAIL_SHARED_API bool Equals (System::SharedPtr< EmailAddress > obj)
 Determines whether the specified Object is equal to the current Object. More...
 
ASPOSE_EMAIL_SHARED_API bool Equals (System::SharedPtr< EmailAddress > x, System::SharedPtr< EmailAddress > y)
 Determines whether the specified object instances are considered equal. More...
 
virtual ASPOSE_EMAIL_SHARED_API int32_t CompareTo (System::SharedPtr< EmailAddress > obj)
 Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. More...
 
ASPOSE_EMAIL_SHARED_API System::String ToString () const override
 
ASPOSE_EMAIL_SHARED_API int32_t GetHashCode () const override
 Returns a hash code for this instance. More...
 
- Public Member Functions inherited from Aspose::Email::MailAddress
ASPOSE_EMAIL_SHARED_API System::String get_DisplayName ()
 Gets a display name. More...
 
ASPOSE_EMAIL_SHARED_API void set_DisplayName (System::String value)
 Sets a display name. More...
 
ASPOSE_EMAIL_SHARED_API System::String get_User () const
 Gets the username. More...
 
ASPOSE_EMAIL_SHARED_API System::String get_Host () const
 Gets the host portion of the address. More...
 
ASPOSE_EMAIL_SHARED_API System::String get_Address ()
 Gets the e-mail address. More...
 
ASPOSE_EMAIL_SHARED_API void set_Address (System::String value)
 Sets the e-mail address. More...
 
ASPOSE_EMAIL_SHARED_API System::String get_OriginalAddressString ()
 Gets the original e-mail address string. More...
 
ASPOSE_EMAIL_SHARED_API void set_OriginalAddressString (System::String value)
 Sets the original e-mail address string. More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_Count ()
 Contains count of mail addresses. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Text::Encoding > get_DisplayNameEncoding () const
 Gets the display name encoding. More...
 
ASPOSE_EMAIL_SHARED_API System::String get_SmtpAddress ()
 
ASPOSE_EMAIL_SHARED_API Aspose::Email::ParticipationStatus get_ParticipationStatus ()
 Gets the participation status for the calendar user. More...
 
ASPOSE_EMAIL_SHARED_API void set_ParticipationStatus (Aspose::Email::ParticipationStatus value)
 Sets the participation status for the calendar user. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Calendar::Model::ParameterCollection > get_Parameters () const
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< ObjectIdentifierget_Id () const
 Gets object identification information More...
 
ASPOSE_EMAIL_SHARED_API bool get_DisplayedEmailInOutlook () const
 Defines whether need rendered Email address for particular message if it converted from MapiMessage. More...
 
ASPOSE_EMAIL_SHARED_API void set_DisplayedEmailInOutlook (bool value)
 Defines whether need rendered Email address for particular message if it converted from MapiMessage. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, bool ignoreSmtpCheck)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, System::String displayName, bool ignoreSmtpCheck)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding, bool ignoreSmtpCheck)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, System::String displayName)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress (System::String address, System::String encodedDisplayName, int32_t bogusParam)
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API MailAddress ()
 Initializes a new instance of the MailAddress class. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressidx_get (int32_t i)
 Gets the element at the specified index. More...
 
ASPOSE_EMAIL_SHARED_API System::String ToString (System::String displayNameQuote)
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressClone ()
 
ASPOSE_EMAIL_SHARED_API void CopyInplace (System::SharedPtr< MailAddress > address)
 
ASPOSE_EMAIL_SHARED_API void SetEncoding (System::SharedPtr< System::Text::Encoding > nameEncoding)
 Sets encoding for dysplay name More...
 
ASPOSE_EMAIL_SHARED_API System::String ToEncodedString ()
 
ASPOSE_EMAIL_SHARED_API System::String ToString () const override
 

Friends

class Aspose::Email::Common::ContactConverter
 
class Aspose::Email::Clients::Exchange::WebService::ContactEwsConverter
 
ASPOSE_EMAIL_SHARED_API bool operator== (System::SharedPtr< EmailAddress > a, System::SharedPtr< EmailAddress > b)
 
ASPOSE_EMAIL_SHARED_API bool operator!= (System::SharedPtr< EmailAddress > a, System::SharedPtr< EmailAddress > b)
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::MailAddress
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressto_MailAddress (System::String address)
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressto_MailAddress (System::SharedPtr< MailAddressCollection > addresses)
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressSafeCreateMailAddress (System::String address, System::String displayName, bool ignoreSmtpCheck)
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressSafeCreateMailAddressWithEncoding (System::String address)
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressSafeCreateMailAddressWithEncoding (System::String address, System::String displayName)
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddressSafeCreateMailAddressWithEncoding (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding)
 
- Protected Member Functions inherited from Aspose::Email::MailAddress
virtual ASPOSE_EMAIL_SHARED_API ~MailAddress ()
 

Detailed Description

Represents an email address

Constructor & Destructor Documentation

◆ EmailAddress() [1/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::PersonalInfo::EmailAddress::EmailAddress ( )

Initializes a new instance of the EmailAddress class.

◆ EmailAddress() [2/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::PersonalInfo::EmailAddress::EmailAddress ( System::String  address)

Initializes a new instance of the EmailAddress class.

Parameters
addressThe mail address.

◆ EmailAddress() [3/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::PersonalInfo::EmailAddress::EmailAddress ( System::String  address,
System::String  displayName 
)

Initializes a new instance of the EmailAddress class.

Parameters
addressThe mail address.
displayNameThe display name.

Member Function Documentation

◆ CompareTo()

virtual ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::PersonalInfo::EmailAddress::CompareTo ( System::SharedPtr< EmailAddress obj)
virtual

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters
objAn object to compare with this instance, or null.
Returns
This method returns: a value less than 0 if this is less than value 0 if this is equal to value a value greater than 0 if this is greater than value

◆ Equals() [1/3]

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::PersonalInfo::EmailAddress::Equals ( System::SharedPtr< EmailAddress obj)

Determines whether the specified Object is equal to the current Object.

Parameters
objThe Object to compare with the current Object.
Returns
Returns a boolean indicating if the passed in object obj is Equal to this.

◆ Equals() [2/3]

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::PersonalInfo::EmailAddress::Equals ( System::SharedPtr< EmailAddress x,
System::SharedPtr< EmailAddress y 
)

Determines whether the specified object instances are considered equal.

Parameters
xThe first object to compare.
yThe second object to compare.
Returns
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

◆ Equals() [3/3]

virtual ASPOSE_EMAIL_SHARED_API bool Aspose::Email::PersonalInfo::EmailAddress::Equals ( System::SharedPtr< System::Object >  obj)
virtual

Determines whether the specified Object is equal to the current Object.

Parameters
objThe Object to compare with the current Object.
Returns
Returns a boolean indicating if the passed in object obj is Equal to this.

Reimplemented from Aspose::Email::MailAddress.

◆ get_Category()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<EmailAddressCategory> Aspose::Email::PersonalInfo::EmailAddress::get_Category ( ) const

Gets an object category

◆ get_Prefered()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::PersonalInfo::EmailAddress::get_Prefered ( ) const

Gets a value which defines whether email address is preferred.

◆ get_RoutingType()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::PersonalInfo::EmailAddress::get_RoutingType ( ) const

Gets a routing type for an email

◆ GetHashCode() [1/3]

virtual ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::PersonalInfo::EmailAddress::GetHashCode ( )
virtual

GetHashCode returns a hash function for this object.

Returns
Returns a hash function for this object.

◆ GetHashCode() [2/3]

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::PersonalInfo::EmailAddress::GetHashCode ( ) const
overridevirtual

Returns a hash code for this instance.

Returns
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Reimplemented from Aspose::Email::MailAddress.

◆ GetHashCode() [3/3]

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::PersonalInfo::EmailAddress::GetHashCode ( System::SharedPtr< EmailAddress obj)

GetHashCode returns a hash function for specified object.

Parameters
objThe Object for which a hash code is to be returned.
Returns
Returns a hash function for specified object.

◆ set_Category()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::PersonalInfo::EmailAddress::set_Category ( System::SharedPtr< EmailAddressCategory value)

Sets an object category

◆ set_Prefered()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::PersonalInfo::EmailAddress::set_Prefered ( bool  value)

Sets a value which defines whether email address is preferred.

◆ set_RoutingType()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::PersonalInfo::EmailAddress::set_RoutingType ( System::String  value)

Sets a routing type for an email

◆ ToString() [1/2]

virtual ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::PersonalInfo::EmailAddress::ToString ( )
virtual

Returns a string that represents the current object.

Returns
Returns a string that represents the current object.

Reimplemented from Aspose::Email::MailAddress.

◆ ToString() [2/2]

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::PersonalInfo::EmailAddress::ToString ( ) const
override

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::ContactEwsConverter

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

◆ Aspose::Email::Common::ContactConverter

friend class Aspose::Email::Common::ContactConverter
friend

◆ operator!=

ASPOSE_EMAIL_SHARED_API bool operator!= ( System::SharedPtr< EmailAddress a,
System::SharedPtr< EmailAddress b 
)
friend

◆ operator==

ASPOSE_EMAIL_SHARED_API bool operator== ( System::SharedPtr< EmailAddress a,
System::SharedPtr< EmailAddress b 
)
friend