Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmailAddressCollection

Represents a collection of e-mail addresses.

Hierarchy

Index

Constructors

constructor

  • internal

    Initializes a new instance of the EmailAddressCollection class.

    remarks

    Note that XmlElementNames.Mailbox is the collection element name for ArrayOfRecipientsType, not ArrayOfEmailAddressesType.

    Returns EmailAddressCollection

  • internal

    Initializes a new instance of the EmailAddressCollection class.

    Parameters

    • collectionItemXmlElementName: string

      Name of the collection item XML element.

    Returns EmailAddressCollection

Properties

Namespace

Namespace: XmlNamespace

OnChange

____implementsInterface

____implementsInterface: string[]

____typeGenerics

____typeGenerics: string[]

____typeName

____typeName: string

Private collectionItemXmlElementName

collectionItemXmlElementName: string

XML element name

Accessors

AddedItems

Count

  • get Count(): number
  • Gets the total number of properties in the collection.

    Returns number

Items

ModifiedItems

RemovedItems

Methods

Add

  • Adds an e-mail address to the collection.

    Parameters

    Returns void

  • Adds an e-mail address to the collection.

    Parameters

    • smtpAddress: string

      The SMTP address used to initialize the e-mail address.

    Returns EmailAddress

    An EmailAddress object initialized with the provided SMTP address.

  • Adds an e-mail address to the collection.

    Parameters

    • name: string

      The name used to initialize the e-mail address.

    • smtpAddress: string

      The SMTP address used to initialize the e-mail address.

    Returns EmailAddress

    An EmailAddress object initialized with the provided SMTP address.

AddRange

  • AddRange(emailAddresses: EmailAddress[]): void
  • AddRange(smtpAddresses: string[]): void
  • Adds multiple e-mail addresses to the collection.

    Parameters

    • emailAddresses: EmailAddress[]

      The e-mail addresses to add.

    Returns void

  • Adds multiple e-mail addresses to the collection.

    Parameters

    • smtpAddresses: string[]

      The SMTP addresses used to initialize the e-mail addresses.

    Returns void

Changed

  • Changed(): void

Clear

  • Clear(): void
  • Clears the collection.

    Returns void

ClearChangeLog

  • ClearChangeLog(): void

Contains

  • Determines whether a specific property is in the collection.

    Parameters

    • complexProperty: EmailAddress

      The property to locate in the collection.

    Returns boolean

    True if the property was found in the collection, false otherwise.

CreateComplexProperty

  • CreateComplexProperty(xmlElementName: string): EmailAddress
  • internal

    Creates an EmailAddress object from an XML element name.

    Parameters

    • xmlElementName: string

      The XML element name from which to create the e-mail address.

    Returns EmailAddress

    An EmailAddress object.

CreateDefaultComplexProperty

CreateFromXmlJsObjectCollection

  • CreateFromXmlJsObjectCollection(jsObjectCollection: any, service: ExchangeService): void
  • internal

    Loads from XMLJsObject collection to create a new collection item.

    interface

    IJsonCollectionDeserializer

    Parameters

    • jsObjectCollection: any

      The json collection.

    • service: ExchangeService

      The service.

    Returns void

GetCollectionItemXmlElementName

  • GetCollectionItemXmlElementName(emailAddress: EmailAddress): string
  • internal

    Retrieves the XML element name corresponding to the provided EmailAddress object.

    Parameters

    • emailAddress: EmailAddress

      The EmailAddress object from which to determine the XML element name.

    Returns string

    The XML element name corresponding to the provided EmailAddress object.

IndexOf

  • Searches for a specific property and return its zero-based index within the collection.

    Parameters

    • complexProperty: EmailAddress

      The property to locate in the collection.

    Returns number

    The zero-based index of the property within the collection.

Private InternalAdd

InternalClear

  • InternalClear(): void

InternalLoadFromXmlJsObject

  • InternalLoadFromXmlJsObject(jsObject: any, service: ExchangeService, readAction: function): void

InternalRemove

  • internal

    Remove specified complex property.

    Parameters

    Returns boolean

    True if the complex property was successfully removed from the collection, false otherwise.

InternalRemoveAt

  • InternalRemoveAt(index: number): void

InternalToJson

InternalValidate

  • InternalValidate(): void

ItemChanged

LoadFromXmlJsObject

ReadAttributesFromXmlJsObject

ReadElementsFromXmlJsObject

  • ReadElementsFromXmlJsObject(jsonProperty: any, service: ExchangeService): void

ReadElementsFromXmlJsObjectToPatch

  • ReadElementsFromXmlJsObjectToPatch(jsonProperty: any, service: ExchangeService): void

ReadTextValueFromXmlJsObject

Remove

  • Removes an e-mail address from the collection.

    Parameters

    Returns boolean

    True if the email address was successfully removed from the collection, false otherwise.

RemoveAt

  • RemoveAt(index: number): void
  • Removes an e-mail address from the collection.

    Parameters

    • index: number

      The index of the e-mail address to remove.

    Returns void

RemoveFromChangeLog

SetFieldValue

  • SetFieldValue<T>(field: IRefParam<T>, value: T): void

ShouldWriteToRequest

  • ShouldWriteToRequest(): boolean
  • internal

    Determine whether we should write collection to XML or not.

    Returns boolean

    Always true, even if the collection is empty.

UpdateFromXmlJsObject

UpdateFromXmlJsObjectCollection

  • UpdateFromXmlJsObjectCollection(jsObjectCollection: any, service: ExchangeService): void
  • internal

    Loads from XMLJsObject collection to update collection Items.

    interface

    IJsonCollectionDeserializer

    Parameters

    • jsObjectCollection: any

      The XMLJsObject collection.

    • service: ExchangeService

      The service.

    Returns void

Validate

  • Validate(): void

WriteAttributesToXml

WriteDeleteUpdateToXml

WriteElementsToXml

WriteSetUpdateToXml

WriteToXml

___thisIndexer

  • Gets the property at the specified index.

    Parameters

    • index: number

      The zero-based index of the property to get.

    Returns EmailAddress

    The property at the specified index.

Generated using TypeDoc