Aspose::Email::PersonalInfo::VCard::VCardContact Class Referencefinal

Represents a vCard contact More...

Inherits Object.

Public Member Functions

System::SharedPtr< VCardIdentificationInfoget_IdentificationInfo () const
 Gets an identification properties More...
 
void set_IdentificationInfo (System::SharedPtr< VCardIdentificationInfo > value)
 Sets an identification properties More...
 
System::SharedPtr< VCardDeliveryAddressCollectionget_DeliveryAddresses () const
 Gets a delivery addresses More...
 
void set_DeliveryAddresses (System::SharedPtr< VCardDeliveryAddressCollection > value)
 Sets a delivery addresses More...
 
System::SharedPtr< VCardLabelCollectionget_Labels () const
 Gets a delivery addresses More...
 
void set_Labels (System::SharedPtr< VCardLabelCollection > value)
 Sets a delivery addresses More...
 
System::SharedPtr< VCardTelephoneNumberCollectionget_TelephoneNumbers () const
 Gets a contact's telephone numbers More...
 
void set_TelephoneNumbers (System::SharedPtr< VCardTelephoneNumberCollection > value)
 Sets a contact's telephone numbers More...
 
System::SharedPtr< VCardEmailCollectionget_Emails () const
 Gets a contact's email addresses More...
 
void set_Emails (System::SharedPtr< VCardEmailCollection > value)
 Sets a contact's email addresses More...
 
System::String get_Mailer () const
 Gets a mailer More...
 
void set_Mailer (System::String value)
 Sets a mailer More...
 
System::String get_TimeZone () const
 Gets a timeZone More...
 
void set_TimeZone (System::String value)
 Sets a timeZone More...
 
System::SharedPtr< VCardGeoget_Geo () const
 Gets a global positioning More...
 
void set_Geo (System::SharedPtr< VCardGeo > value)
 Sets a global positioning More...
 
System::SharedPtr< VCardOrganizationget_Organization () const
 Gets an organization information More...
 
void set_Organization (System::SharedPtr< VCardOrganization > value)
 Sets an organization information More...
 
System::SharedPtr< VCardExplanatoryInfoget_ExplanatoryInfo () const
 Gets a vCard explanatory information More...
 
void set_ExplanatoryInfo (System::SharedPtr< VCardExplanatoryInfo > value)
 Sets a vCard explanatory information More...
 
System::SharedPtr< VCardSecurityget_Security () const
 Gets a security properites More...
 
void set_Security (System::SharedPtr< VCardSecurity > value)
 Sets a security properites More...
 
System::SharedPtr< System::Collections::Specialized::StringCollection > get_ExtendedProperties () const
 Gets an extended properties More...
 
void set_ExtendedProperties (System::SharedPtr< System::Collections::Specialized::StringCollection > value)
 Sets an extended properties More...
 
 VCardContact ()
 Initializes a new instance of the VCardContact class More...
 
 VCardContact (System::SharedPtr< VCardHeaderList > properties)
 Initializes a new instance of the VCardContact class More...
 
void Save (System::String filePath)
 Saves this MapiContact to the vCard file with a default options. The supported vCard version is 2.1 More...
 
void Save (System::String filePath, Aspose::Email::Mapi::ContactSaveFormat saveFormat)
 Saves this MapiContact to the specified file with a format using the default options. The supported save format is vCard. More...
 
void Save (System::String filePath, System::SharedPtr< Aspose::Email::Mapi::ContactSaveOptions > saveOptions)
 Saves this MapiContact into file using specified save options. The supported save options is VCardSaveOptions More...
 
void Save (System::SharedPtr< System::IO::Stream > stream)
 Saves this MapiContact into the given stream with vCard format. The supported vCard version is 2.1 More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, Aspose::Email::Mapi::ContactSaveFormat saveFormat)
 Saves this MapiContact to the given stream with a format using the default options. The supported save format is vCard More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Email::Mapi::ContactSaveOptions > saveOptions)
 Saves this MapiContact to the given stream using specified save options. The supported save options is VCardSaveOptions More...
 

Static Public Member Functions

static System::SharedPtr< VCardContactLoad (System::String filePath)
 Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0 More...
 
static System::SharedPtr< VCardContactLoad (System::String filePath, System::SharedPtr< System::Text::Encoding > encoding)
 Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0 More...
 
static System::SharedPtr< VCardContactLoad (System::SharedPtr< System::IO::Stream > stream)
 Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0 More...
 
static System::SharedPtr< VCardContactLoad (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< System::Text::Encoding > encoding)
 Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0 More...
 
static bool IsMultiContacts (System::SharedPtr< System::IO::Stream > stream)
 Checks whether source stream contains multi contacts. More...
 
static System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< VCardContact > > > LoadAsMultiple (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< System::Text::Encoding > encoding)
 Loads list of contacts from multi contact stream. More...
 
static System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< VCardContact > > > LoadAsMultiple (System::String filePath, System::SharedPtr< System::Text::Encoding > encoding)
 Loads list of contacts from multi contact file. More...
 

Friends

class Aspose::Email::PersonalInfo::VCard::VCardAgent
 

Detailed Description

Represents a vCard contact

Constructor & Destructor Documentation

◆ VCardContact() [1/2]

Aspose::Email::PersonalInfo::VCard::VCardContact::VCardContact ( )

Initializes a new instance of the VCardContact class

◆ VCardContact() [2/2]

Aspose::Email::PersonalInfo::VCard::VCardContact::VCardContact ( System::SharedPtr< VCardHeaderList >  properties)

Initializes a new instance of the VCardContact class

Parameters
propertiesA vCard properties. Used properties are removed
Exceptions
ArgumentNullExceptionproperties is null

Member Function Documentation

◆ get_DeliveryAddresses()

System::SharedPtr<VCardDeliveryAddressCollection> Aspose::Email::PersonalInfo::VCard::VCardContact::get_DeliveryAddresses ( ) const

Gets a delivery addresses

◆ get_Emails()

System::SharedPtr<VCardEmailCollection> Aspose::Email::PersonalInfo::VCard::VCardContact::get_Emails ( ) const

Gets a contact's email addresses

◆ get_ExplanatoryInfo()

System::SharedPtr<VCardExplanatoryInfo> Aspose::Email::PersonalInfo::VCard::VCardContact::get_ExplanatoryInfo ( ) const

Gets a vCard explanatory information

◆ get_ExtendedProperties()

System::SharedPtr<System::Collections::Specialized::StringCollection> Aspose::Email::PersonalInfo::VCard::VCardContact::get_ExtendedProperties ( ) const

Gets an extended properties

◆ get_Geo()

System::SharedPtr<VCardGeo> Aspose::Email::PersonalInfo::VCard::VCardContact::get_Geo ( ) const

Gets a global positioning

◆ get_IdentificationInfo()

System::SharedPtr<VCardIdentificationInfo> Aspose::Email::PersonalInfo::VCard::VCardContact::get_IdentificationInfo ( ) const

Gets an identification properties

◆ get_Labels()

System::SharedPtr<VCardLabelCollection> Aspose::Email::PersonalInfo::VCard::VCardContact::get_Labels ( ) const

Gets a delivery addresses

◆ get_Mailer()

System::String Aspose::Email::PersonalInfo::VCard::VCardContact::get_Mailer ( ) const

Gets a mailer

◆ get_Organization()

System::SharedPtr<VCardOrganization> Aspose::Email::PersonalInfo::VCard::VCardContact::get_Organization ( ) const

Gets an organization information

◆ get_Security()

System::SharedPtr<VCardSecurity> Aspose::Email::PersonalInfo::VCard::VCardContact::get_Security ( ) const

Gets a security properites

◆ get_TelephoneNumbers()

System::SharedPtr<VCardTelephoneNumberCollection> Aspose::Email::PersonalInfo::VCard::VCardContact::get_TelephoneNumbers ( ) const

Gets a contact's telephone numbers

◆ get_TimeZone()

System::String Aspose::Email::PersonalInfo::VCard::VCardContact::get_TimeZone ( ) const

Gets a timeZone

◆ IsMultiContacts()

static bool Aspose::Email::PersonalInfo::VCard::VCardContact::IsMultiContacts ( System::SharedPtr< System::IO::Stream >  stream)
static

Checks whether source stream contains multi contacts.

Parameters
streamSource stream
Returns
True if multi contacts, otherwise false.

◆ Load() [1/4]

static System::SharedPtr<VCardContact> Aspose::Email::PersonalInfo::VCard::VCardContact::Load ( System::SharedPtr< System::IO::Stream >  stream)
static

Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters
streamA stream to read from
Returns
A read VCardContact
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support reading

◆ Load() [2/4]

static System::SharedPtr<VCardContact> Aspose::Email::PersonalInfo::VCard::VCardContact::Load ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< System::Text::Encoding >  encoding 
)
static

Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters
streamA stream to read from
encodingStream data encoding
Returns
A read VCardContact
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support reading

◆ Load() [3/4]

static System::SharedPtr<VCardContact> Aspose::Email::PersonalInfo::VCard::VCardContact::Load ( System::String  filePath)
static

Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters
filePathA file name to read from
Returns
A read VCardContact
Exceptions
ArgumentExceptionfilePath is null or empty

◆ Load() [4/4]

static System::SharedPtr<VCardContact> Aspose::Email::PersonalInfo::VCard::VCardContact::Load ( System::String  filePath,
System::SharedPtr< System::Text::Encoding >  encoding 
)
static

Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters
filePathA file name to read from
encodingFile encoding
Returns
A read VCardContact
Exceptions
ArgumentExceptionfilePath is null or empty

◆ LoadAsMultiple() [1/2]

static System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<VCardContact> > > Aspose::Email::PersonalInfo::VCard::VCardContact::LoadAsMultiple ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< System::Text::Encoding >  encoding 
)
static

Loads list of contacts from multi contact stream.

Parameters
streamSource stream
encodingStream data encoding,if null then UTF8 will be used.
Returns
List of contacs

◆ LoadAsMultiple() [2/2]

static System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<VCardContact> > > Aspose::Email::PersonalInfo::VCard::VCardContact::LoadAsMultiple ( System::String  filePath,
System::SharedPtr< System::Text::Encoding >  encoding 
)
static

Loads list of contacts from multi contact file.

Parameters
filePathSource file
encodingFile data encoding,if null then UTF8 will be used.
Returns

◆ Save() [1/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::SharedPtr< System::IO::Stream >  stream)

Saves this MapiContact into the given stream with vCard format. The supported vCard version is 2.1

Parameters
streamA stream to save to
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support writing

◆ Save() [2/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::SharedPtr< System::IO::Stream >  stream,
Aspose::Email::Mapi::ContactSaveFormat  saveFormat 
)

Saves this MapiContact to the given stream with a format using the default options. The supported save format is vCard

Parameters
streamA stream to save to
saveFormatA save format
Exceptions
ArgumentNullExceptionstream is null
NotSupportedExceptionstream does not support writing
NotSupportedExceptionThe specified format is not supported

◆ Save() [3/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< Aspose::Email::Mapi::ContactSaveOptions saveOptions 
)

Saves this MapiContact to the given stream using specified save options. The supported save options is VCardSaveOptions

Parameters
streamA stream to save to
saveOptionsA save options
Exceptions
ArgumentNullExceptionstream or saveOptions is null
NotSupportedExceptionstream does not support writing
ArgumentExceptionincorrect saveOptions
NotSupportedExceptionsome save option is not supported

◆ Save() [4/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::String  filePath)

Saves this MapiContact to the vCard file with a default options. The supported vCard version is 2.1

Parameters
filePathA vCard file name
Exceptions
ArgumentExceptionfilePath is null or empty

◆ Save() [5/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::String  filePath,
Aspose::Email::Mapi::ContactSaveFormat  saveFormat 
)

Saves this MapiContact to the specified file with a format using the default options. The supported save format is vCard.

Parameters
filePathA vCard file name
saveFormatA save format
Exceptions
ArgumentExceptionfilePath is null or empty
NotSupportedExceptionthe specified format is not supported

◆ Save() [6/6]

void Aspose::Email::PersonalInfo::VCard::VCardContact::Save ( System::String  filePath,
System::SharedPtr< Aspose::Email::Mapi::ContactSaveOptions saveOptions 
)

Saves this MapiContact into file using specified save options. The supported save options is VCardSaveOptions

Parameters
filePathA vCard file name
saveOptionsA save options
Exceptions
ArgumentExceptionfilePath is null or empty
ArgumentNullExceptionsaveOptions is null
NotSupportedExceptionsome save option is not supported

◆ set_DeliveryAddresses()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_DeliveryAddresses ( System::SharedPtr< VCardDeliveryAddressCollection value)

Sets a delivery addresses

◆ set_Emails()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Emails ( System::SharedPtr< VCardEmailCollection value)

Sets a contact's email addresses

◆ set_ExplanatoryInfo()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_ExplanatoryInfo ( System::SharedPtr< VCardExplanatoryInfo value)

Sets a vCard explanatory information

◆ set_ExtendedProperties()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_ExtendedProperties ( System::SharedPtr< System::Collections::Specialized::StringCollection >  value)

Sets an extended properties

◆ set_Geo()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Geo ( System::SharedPtr< VCardGeo value)

Sets a global positioning

◆ set_IdentificationInfo()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_IdentificationInfo ( System::SharedPtr< VCardIdentificationInfo value)

Sets an identification properties

◆ set_Labels()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Labels ( System::SharedPtr< VCardLabelCollection value)

Sets a delivery addresses

◆ set_Mailer()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Mailer ( System::String  value)

Sets a mailer

◆ set_Organization()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Organization ( System::SharedPtr< VCardOrganization value)

Sets an organization information

◆ set_Security()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_Security ( System::SharedPtr< VCardSecurity value)

Sets a security properites

◆ set_TelephoneNumbers()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_TelephoneNumbers ( System::SharedPtr< VCardTelephoneNumberCollection value)

Sets a contact's telephone numbers

◆ set_TimeZone()

void Aspose::Email::PersonalInfo::VCard::VCardContact::set_TimeZone ( System::String  value)

Sets a timeZone

Friends And Related Function Documentation

◆ Aspose::Email::PersonalInfo::VCard::VCardAgent