com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class VCardContact



  • public final class VCardContact
    extends Object

    Represents a vCard contact

    • Constructor Detail

      • VCardContact

        public VCardContact()

        Initializes a new instance of the VCardContact class

    • Method Detail

      • getIdentificationInfo

        public final VCardIdentificationInfo getIdentificationInfo()

        Gets or sets an identification properties

      • setIdentificationInfo

        public final void setIdentificationInfo(VCardIdentificationInfo value)

        Gets or sets an identification properties

      • getEmails

        public final VCardEmailCollection getEmails()

        Gets or sets a contact's email addresses

      • setEmails

        public final void setEmails(VCardEmailCollection value)

        Gets or sets a contact's email addresses

      • getMailer

        public final String getMailer()

        Gets or sets a mailer

      • setMailer

        public final void setMailer(String value)

        Gets or sets a mailer

      • getTimeZone

        public final String getTimeZone()

        Gets or sets a timeZone

      • setTimeZone

        public final void setTimeZone(String value)

        Gets or sets a timeZone

      • getGeo

        public final VCardGeo getGeo()

        Gets or sets a global positioning

      • setGeo

        public final void setGeo(VCardGeo value)

        Gets or sets a global positioning

      • getOrganization

        public final VCardOrganization getOrganization()

        Gets or sets an organization information

      • setOrganization

        public final void setOrganization(VCardOrganization value)

        Gets or sets an organization information

      • getExplanatoryInfo

        public final VCardExplanatoryInfo getExplanatoryInfo()

        Gets or sets a vCard explanatory information

      • setExplanatoryInfo

        public final void setExplanatoryInfo(VCardExplanatoryInfo value)

        Gets or sets a vCard explanatory information

      • getSecurity

        public final VCardSecurity getSecurity()

        Gets or sets a security properites

      • setSecurity

        public final void setSecurity(VCardSecurity value)

        Gets or sets a security properites

      • getExtendedProperties

        public final com.aspose.ms.System.Collections.Specialized.StringCollection getExtendedProperties()

        Gets or sets an extended properties

      • setExtendedProperties

        public final void setExtendedProperties(com.aspose.ms.System.Collections.Specialized.StringCollection value)

        Gets or sets an extended properties

      • load

        public static VCardContact load(String filePath)

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

        Parameters:
        filePath - A file name to read from
        Returns:
        A read VCardContact
        Throws:
        com.aspose.ms.System.ArgumentException - filePath is null or empty
      • load

        public static VCardContact load(String filePath,
                        Charset encoding)

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

        Parameters:
        filePath - A file name to read from
        encoding - File encoding
        Returns:
        A read VCardContact
        Throws:
        com.aspose.ms.System.ArgumentException - filePath is null or empty
      • load

        public static VCardContact load(InputStream stream)

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

        Parameters:
        stream - A stream to read from
        Returns:
        A read VCardContact
        Throws:
        com.aspose.ms.System.ArgumentNullException - stream is null
        com.aspose.ms.System.NotSupportedException - stream does not support reading
      • load

        public static VCardContact load(InputStream stream,
                        Charset encoding)

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

        Parameters:
        stream - A stream to read from
        encoding - Stream data encoding
        Returns:
        A read VCardContact
        Throws:
        com.aspose.ms.System.ArgumentNullException - stream is null
        com.aspose.ms.System.NotSupportedException - stream does not support reading
      • isMultiContacts

        public static boolean isMultiContacts(InputStream stream)

        Checks whether source stream contains multi contacts.

        Parameters:
        stream - Source stream
        Returns:
        True if multi contacts, otherwise false.
      • loadAsMultiple

        public static List<VCardContact> loadAsMultiple(InputStream stream,
                                        Charset encoding)

        Loads list of contacts from multi contact stream.

        Parameters:
        stream - Source stream
        encoding - Stream data encoding,if null then UTF8 will be used.
        Returns:
        List of contacs
      • loadAsMultiple

        public static List<VCardContact> loadAsMultiple(String filePath,
                                        Charset encoding)

        Loads list of contacts from multi contact file.

        Parameters:
        filePath - Source file
        encoding - File data encoding,if null then UTF8 will be used.
        Returns:
      • save

        public final void save(String filePath)

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

        Parameters:
        filePath - A vCard file name
        Throws:
        com.aspose.ms.System.ArgumentException - filePath is null or empty
      • save

        public final void save(String filePath,
                int saveFormat)

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

        Parameters:
        filePath - A vCard file name
        saveFormat - A save format
        Throws:
        com.aspose.ms.System.ArgumentException - filePath is null or empty
        com.aspose.ms.System.NotSupportedException - the specified format is not supported
      • save

        public final void save(String filePath,
                ContactSaveOptions saveOptions)

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

        Parameters:
        filePath - A vCard file name
        saveOptions - A save options
        Throws:
        com.aspose.ms.System.ArgumentException - filePath is null or empty
        com.aspose.ms.System.ArgumentNullException - saveOptions is null
        com.aspose.ms.System.NotSupportedException - some save option is not supported
      • save

        public final void save(OutputStream stream)

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

        Parameters:
        stream - A stream to save to
        Throws:
        com.aspose.ms.System.ArgumentNullException - stream is null
        com.aspose.ms.System.NotSupportedException - stream does not support writing
      • save

        public final void save(OutputStream stream,
                int saveFormat)

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

        Parameters:
        stream - A stream to save to
        saveFormat - A save format
        Throws:
        com.aspose.ms.System.ArgumentNullException - stream is null
        com.aspose.ms.System.NotSupportedException - stream does not support writing
        com.aspose.ms.System.NotSupportedException - The specified format is not supported
      • save

        public final void save(OutputStream stream,
                ContactSaveOptions saveOptions)

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

        Parameters:
        stream - A stream to save to
        saveOptions - A save options
        Throws:
        com.aspose.ms.System.ArgumentNullException - stream or saveOptions is null
        com.aspose.ms.System.NotSupportedException - stream does not support writing
        com.aspose.ms.System.ArgumentException - incorrect saveOptions
        com.aspose.ms.System.NotSupportedException - some save option is not supported