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
System::String	get_DisplayName () override
	Gets a display name. More...
void	set_DisplayName (System::String value) override
	Sets a display name. More...
System::String	get_User () const
	Gets the username. More...
System::String	get_Host () const
	Gets the host portion of the address. More...
System::String	get_Address () override
	Gets the e-mail address. More...
void	set_Address (System::String value) override
	Sets the e-mail address. More...
System::String	get_OriginalAddressString ()
	Gets the original e-mail address string. More...
void	set_OriginalAddressString (System::String value)
	Sets the original e-mail address string. More...
System::String	get_X500Address () const
	Gets the email address in Exchange format, if it exists. More...
void	set_X500Address (System::String value)
	Gets the email address in Exchange format, if it exists. More...
int32_t	get_Count ()
	Contains count of mail addresses. More...
System::SharedPtr< System::Text::Encoding >	get_DisplayNameEncoding () const
	Gets the display name encoding. More...
System::String	get_SmtpAddress ()
Aspose::Email::ParticipationStatus	get_ParticipationStatus ()
	Gets the participation status for the calendar user. More...
void	set_ParticipationStatus (Aspose::Email::ParticipationStatus value)
	Sets the participation status for the calendar user. More...
System::SharedPtr< Calendar::Model::ParameterCollection >	get_Parameters () const
System::SharedPtr< ObjectIdentifier >	get_Id () const
	Gets object identification information More...
bool	get_DisplayedEmailInOutlook () const
	Defines whether need rendered Email address for particular message if it converted from MapiMessage. More...
void	set_DisplayedEmailInOutlook (bool value)
	Defines whether need rendered Email address for particular message if it converted from MapiMessage. More...
	MailAddress (System::String address, bool ignoreSmtpCheck)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address, System::String displayName, bool ignoreSmtpCheck)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding, bool ignoreSmtpCheck)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address, System::String displayName)
	Initializes a new instance of the MailAddress class. More...
	MailAddress (System::String address, System::String encodedDisplayName, int32_t bogusParam)
	Initializes a new instance of the MailAddress class. More...
	MailAddress ()
	Initializes a new instance of the MailAddress class. More...
System::SharedPtr< MailAddress >	idx_get (int32_t i)
	Gets the element at the specified index. More...
System::String	ToString (System::String displayNameQuote)
bool	Equals (System::SharedPtr< System::Object > obj) override
	Determines whether the specified System::Object is equal to this instance. More...
int32_t	GetHashCode () const override
	Returns a hash code for this instance. More...
System::SharedPtr< MailAddress >	Clone ()
void	CopyInplace (System::SharedPtr< MailAddress > address)
void	SetEncoding (System::SharedPtr< System::Text::Encoding > nameEncoding)
	Sets encoding for dysplay name More...
System::String	ToEncodedString ()
System::String	ToString () const override
	Returns a System::String that represents this instance. More...

Static Public Member Functions
static System::SharedPtr< MailAddress >	to_MailAddress (System::String address)
	Performs an implicit conversion from System::String to MailAddress. More...
static System::SharedPtr< MailAddress >	to_MailAddress (System::SharedPtr< MailAddressCollection > addresses)
	Performs an implicit conversion from MailAddressCollection to MailAddress. More...
static System::SharedPtr< MailAddress >	SafeCreateMailAddress (System::String address, System::String displayName, bool ignoreSmtpCheck)
static System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address)
static System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address, System::String displayName)
static System::SharedPtr< MailAddress >	SafeCreateMailAddressWithEncoding (System::String address, System::String displayName, System::SharedPtr< System::Text::Encoding > displayNameEncoding)

Protected Member Functions
virtual	~MailAddress ()

Friends
class	Aspose::Email::Mapi::MailMessageInterpretor
class	Aspose::Email::Mapi::MapiMessage
class	Aspose::Email::Mapi::OutlookUtil
class	Aspose::Email::Mime::MailBnfHelper

Detailed Description

Represents the address of a message.

Constructor & Destructor Documentation

MailAddress() [1/8]

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::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::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::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::MailAddress::MailAddress

(

System::String

address

)

Initializes a new instance of the MailAddress class.

Parameters

address

The mail address.

MailAddress() [6/8]

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::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::MailAddress::MailAddress

(

)

Initializes a new instance of the MailAddress class.

~MailAddress()

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

protectedvirtual

Member Function Documentation

Clone()

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

(

)

CopyInplace()

void Aspose::Email::MailAddress::CopyInplace

(

System::SharedPtr< MailAddress >

address

)

Equals()

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

override

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.

get_Address()

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

overridevirtual

Gets the e-mail address.

A String that contains the e-mail address.

Implements Aspose::Email::IMailAddress.

get_Count()

int32_t Aspose::Email::MailAddress::get_Count

(

)

Contains count of mail addresses.

get_DisplayedEmailInOutlook()

bool Aspose::Email::MailAddress::get_DisplayedEmailInOutlook

(

)

const

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

get_DisplayName()

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

overridevirtual

Gets a display name.

A String that contains the display name.

Implements Aspose::Email::IMailAddress.

get_DisplayNameEncoding()

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

(

)

const

Gets the display name encoding.

Encoding of the display name.

get_Host()

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()

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

(

)

const

Gets object identification information

get_OriginalAddressString()

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()

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

(

)

const

get_ParticipationStatus()

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

(

)

Gets the participation status for the calendar user.

get_SmtpAddress()

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

(

)

get_User()

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

(

)

const

Gets the username.

A String that contains the user name.

get_X500Address()

System::String Aspose::Email::MailAddress::get_X500Address

(

)

const

Gets the email address in Exchange format, if it exists.

GetHashCode()

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

override

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.

idx_get()

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 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 System::SharedPtr<MailAddress> Aspose::Email::MailAddress::SafeCreateMailAddressWithEncoding ( System::String  address )

static

SafeCreateMailAddressWithEncoding() [2/3]

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

static

SafeCreateMailAddressWithEncoding() [3/3]

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

static

set_Address()

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

overridevirtual

Sets the e-mail address.

A String that contains the e-mail address.

Implements Aspose::Email::IMailAddress.

set_DisplayedEmailInOutlook()

void Aspose::Email::MailAddress::set_DisplayedEmailInOutlook

(

bool

value

)

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

set_DisplayName()

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

overridevirtual

Sets a display name.

A String that contains the display name.

Implements Aspose::Email::IMailAddress.

set_OriginalAddressString()

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()

void Aspose::Email::MailAddress::set_ParticipationStatus

(

Aspose::Email::ParticipationStatus

value

)

Sets the participation status for the calendar user.

set_X500Address()

void Aspose::Email::MailAddress::set_X500Address

(

System::String

value

)

Gets the email address in Exchange format, if it exists.

SetEncoding()

void Aspose::Email::MailAddress::SetEncoding

(

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

nameEncoding

)

Sets encoding for dysplay name

Parameters

nameEncoding

to_MailAddress() [1/2]

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

static

Performs an implicit conversion from MailAddressCollection to MailAddress.

Parameters

addresses

The address collection.

Returns

The result of the conversion.

to_MailAddress() [2/2]

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

static

Performs an implicit conversion from System::String to MailAddress.

Parameters

address

The address.

Returns

The result of the conversion.

ToEncodedString()

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

(

)

ToString() [1/2]

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

override

Returns a System::String that represents this instance.

Returns

A System::String that represents this instance.

ToString() [2/2]

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

(

System::String

displayNameQuote

)

Friends And Related Function Documentation

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::OutlookUtil

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

friend

Aspose::Email::Mime::MailBnfHelper

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

friend