Aspose::Email::MailAddress Class Reference

Represents the address of a message. More...

Inherits Aspose::Email::IMailAddress.

Inherited by Aspose::Email::PersonalInfo::EmailAddress.

Public Member Functions
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< ObjectIdentifier >	get_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< MailAddress >	idx_get (int32_t i)
	Gets the element at the specified index. More...
ASPOSE_EMAIL_SHARED_API System::String	ToString (System::String displayNameQuote)
virtual ASPOSE_EMAIL_SHARED_API System::String	ToString ()
	Returns a System::String that represents this instance. More...
virtual ASPOSE_EMAIL_SHARED_API bool	Equals (System::SharedPtr< System::Object > obj)
	Determines whether the specified System::Object is equal to this instance. More...
virtual ASPOSE_EMAIL_SHARED_API int32_t	GetHashCode () const
	Returns a hash code for this instance. More...
ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	Clone ()
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

Static Public Member Functions
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	to_MailAddress (System::String address)
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	to_MailAddress (System::SharedPtr< MailAddressCollection > addresses)
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	SafeCreateMailAddress (System::String address, System::String displayName, bool ignoreSmtpCheck)
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address)
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address, System::String displayName)
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding)

Protected Member Functions
virtual ASPOSE_EMAIL_SHARED_API	~MailAddress ()

Friends
class	Aspose::Email::MailMessage
class	Aspose::Email::Common::CalendarConverter
class	Aspose::Email::Clients::Smtp::Commands::SendGrCommand
class	Aspose::Email::Mapi::MailMessageInterpretor
class	Aspose::Email::Mapi::DeliveryReportMailMessageInterpretor
class	Aspose::Email::Tools::ReplyMessageBuilder
class	Aspose::Email::Tools::ResponseMessageBuilder
class	Aspose::Email::Mapi::ActivityMailMessageInterpretor
class	Aspose::Email::Mapi::NDRReportMailMessageInterpretor
class	Aspose::Email::MhtMessageFormatter
class	Aspose::Email::Mime::HeaderValueFactory
class	Aspose::Email::Mapi::MapiMessage
class	Aspose::Email::Mapi::OutlookUtil
class	Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand
class	Aspose::Email::Mime::HeaderCollection
class	Aspose::Email::MailAddressCollection
class	Aspose::Email::Mime::MailBnfHelper
class	Aspose::Email::Message

Detailed Description

Represents the address of a message.

Constructor & Destructor Documentation

MailAddress() [1/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		bool	ignoreSmtpCheck
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The mail address.
ignoreSmtpCheck	if set to true then SMTP check will be omitted.

MailAddress() [2/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		System::String	displayName,
		bool	ignoreSmtpCheck
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The mail address.
displayName	The display name.
ignoreSmtpCheck	if set to true then SMTP check will be omitted.

MailAddress() [3/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		System::String	displayName,
		System::SharedPtr< System::Text::Encoding >	displayNameEncoding
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The mail address.
displayName	The display name.
displayNameEncoding	The display name encoding.

MailAddress() [4/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		System::String	displayName,
		System::SharedPtr< System::Text::Encoding >	displayNameEncoding,
		bool	ignoreSmtpCheck
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The mail address.
displayName	The display name.
displayNameEncoding	The display name encoding.
ignoreSmtpCheck	if set to true then SMTP check will be omitted.

MailAddress() [5/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress

(

System::String

address

)

Initializes a new instance of the MailAddress class.

Parameters

address

The mail address.

MailAddress() [6/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		System::String	displayName
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The mail address.
displayName	The display name.

MailAddress() [7/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress	(	System::String	address,
		System::String	encodedDisplayName,
		int32_t	bogusParam
	)

Initializes a new instance of the MailAddress class.

Parameters

address	The address.
encodedDisplayName	Display name of the encoded.
bogusParam	The bogus param.

MailAddress() [8/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::MailAddress

(

)

Initializes a new instance of the MailAddress class.

~MailAddress()

virtual ASPOSE_EMAIL_SHARED_API Aspose::Email::MailAddress::~MailAddress ( )

protectedvirtual

Member Function Documentation

Clone()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::Clone

(

)

CopyInplace()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::CopyInplace

(

System::SharedPtr< MailAddress >

address

)

Equals()

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

virtual

Determines whether the specified System::Object is equal to this instance.

Parameters

obj	The System::Object to compare with this instance.

Returns

true if the specified System::Object is equal to this instance; otherwise, false.

Reimplemented in Aspose::Email::PersonalInfo::EmailAddress.

get_Address()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_Address ( )

virtual

Gets the e-mail address.

A String that contains the e-mail address.

Implements Aspose::Email::IMailAddress.

get_Count()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::MailAddress::get_Count

(

)

Contains count of mail addresses.

get_DisplayedEmailInOutlook()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::MailAddress::get_DisplayedEmailInOutlook

(

)

const

Defines whether need rendered Email address for particular message if it converted from MapiMessage.

get_DisplayName()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_DisplayName ( )

virtual

Gets a display name.

A String that contains the display name.

Implements Aspose::Email::IMailAddress.

get_DisplayNameEncoding()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Text::Encoding> Aspose::Email::MailAddress::get_DisplayNameEncoding

(

)

const

Gets the display name encoding.

Encoding of the display name.

get_Host()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_Host

(

)

const

Gets the host portion of the address.

A String that contains the name of the host.

get_Id()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<ObjectIdentifier> Aspose::Email::MailAddress::get_Id

(

)

const

Gets object identification information

get_OriginalAddressString()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_OriginalAddressString

(

)

Gets the original e-mail address string.

A String that contains the original e-mail address.

get_Parameters()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<Calendar::Model::ParameterCollection> Aspose::Email::MailAddress::get_Parameters

(

)

const

get_ParticipationStatus()

ASPOSE_EMAIL_SHARED_API Aspose::Email::ParticipationStatus Aspose::Email::MailAddress::get_ParticipationStatus

(

)

Gets the participation status for the calendar user.

get_SmtpAddress()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_SmtpAddress

(

)

get_User()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::get_User

(

)

const

Gets the username.

A String that contains the user name.

GetHashCode()

virtual ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::MailAddress::GetHashCode ( ) const

virtual

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 in Aspose::Email::PersonalInfo::EmailAddress.

idx_get()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::idx_get

(

int32_t

i

)

Gets the element at the specified index.

Parameters

i	The zero-based index of the element to get or set.

Returns

Returns the element at the specified index.

SafeCreateMailAddress()

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::SafeCreateMailAddress ( System::String  address, System::String  displayName, bool  ignoreSmtpCheck  )

static

/this if for internal usage /try to parse the mailaddress, if failed, ignore the checking

SafeCreateMailAddressWithEncoding() [1/3]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::SafeCreateMailAddressWithEncoding ( System::String  address )

static

SafeCreateMailAddressWithEncoding() [2/3]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::SafeCreateMailAddressWithEncoding ( System::String  address, System::String  displayName  )

static

SafeCreateMailAddressWithEncoding() [3/3]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::SafeCreateMailAddressWithEncoding ( System::String  address, System::String  displayName, System::SharedPtr< System::Text::Encoding >  displayNameEncoding  )

static

set_Address()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::set_Address ( System::String  value )

virtual

Sets the e-mail address.

A String that contains the e-mail address.

Implements Aspose::Email::IMailAddress.

set_DisplayedEmailInOutlook()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::set_DisplayedEmailInOutlook

(

bool

value

)

Defines whether need rendered Email address for particular message if it converted from MapiMessage.

set_DisplayName()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::set_DisplayName ( System::String  value )

virtual

Sets a display name.

A String that contains the display name.

Implements Aspose::Email::IMailAddress.

set_OriginalAddressString()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::set_OriginalAddressString

(

System::String

value

)

Sets the original e-mail address string.

A String that contains the original e-mail address.

set_ParticipationStatus()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::set_ParticipationStatus

(

Aspose::Email::ParticipationStatus

value

)

Sets the participation status for the calendar user.

SetEncoding()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::MailAddress::SetEncoding

(

System::SharedPtr< System::Text::Encoding >

nameEncoding

)

Sets encoding for dysplay name

Parameters

nameEncoding

to_MailAddress() [1/2]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::to_MailAddress ( System::SharedPtr< MailAddressCollection >  addresses )

static

to_MailAddress() [2/2]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<MailAddress> Aspose::Email::MailAddress::to_MailAddress ( System::String  address )

static

ToEncodedString()

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::ToEncodedString

(

)

ToString() [1/3]

virtual ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::ToString ( )

virtual

Returns a System::String that represents this instance.

Returns

A System::String that represents this instance.

Reimplemented in Aspose::Email::PersonalInfo::EmailAddress.

ToString() [2/3]

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::ToString ( ) const

override

ToString() [3/3]

ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::MailAddress::ToString

(

System::String

displayNameQuote

)

Friends And Related Function Documentation

Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand

friend class Aspose::Email::Clients::Imap::Commands::FetchMessageInfoCollectionCommand

friend

Aspose::Email::Clients::Smtp::Commands::SendGrCommand

friend class Aspose::Email::Clients::Smtp::Commands::SendGrCommand

friend

Aspose::Email::Common::CalendarConverter

friend class Aspose::Email::Common::CalendarConverter

friend

Aspose::Email::MailAddressCollection

friend class Aspose::Email::MailAddressCollection

friend

Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage

friend

Aspose::Email::Mapi::ActivityMailMessageInterpretor

friend class Aspose::Email::Mapi::ActivityMailMessageInterpretor

friend

Aspose::Email::Mapi::DeliveryReportMailMessageInterpretor

friend class Aspose::Email::Mapi::DeliveryReportMailMessageInterpretor

friend

Aspose::Email::Mapi::MailMessageInterpretor

friend class Aspose::Email::Mapi::MailMessageInterpretor

friend

Aspose::Email::Mapi::MapiMessage

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

friend

Aspose::Email::Mapi::NDRReportMailMessageInterpretor

friend class Aspose::Email::Mapi::NDRReportMailMessageInterpretor

friend

Aspose::Email::Mapi::OutlookUtil

friend class Aspose::Email::Mapi::OutlookUtil

friend

Aspose::Email::Message

friend class Aspose::Email::Message

friend

Aspose::Email::MhtMessageFormatter

friend class Aspose::Email::MhtMessageFormatter

friend

Aspose::Email::Mime::HeaderCollection

friend class Aspose::Email::Mime::HeaderCollection

friend

Aspose::Email::Mime::HeaderValueFactory

friend class Aspose::Email::Mime::HeaderValueFactory

friend

Aspose::Email::Mime::MailBnfHelper

friend class Aspose::Email::Mime::MailBnfHelper

friend

Aspose::Email::Tools::ReplyMessageBuilder

friend class Aspose::Email::Tools::ReplyMessageBuilder

friend

Aspose::Email::Tools::ResponseMessageBuilder

friend class Aspose::Email::Tools::ResponseMessageBuilder

friend