Class com.gContactSync.MailList

Defined in: MailList.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	com.gContactSync.MailList(aList, aParentDirectory, aNew) MailList is an abstraction of a mailing list that facilitates getting the cards contained within the actual list as well as accessing and modifying the list and its properties.

Field Summary
Field Attributes	Field Name and Description
	mContacts The contacts in this mailing list (cached)
	mContactsUpdate This is true whenever the contacts have to be fetched again

Method Summary
Method Attributes	Method Name and Description
	addContact(aContact) Adds a contact to this mailing list without checking if it already exists.
	deleteContacts(aContacts) Deletes all of the cards in the array of cards from this list.
	getAllContacts() Returns an array of all of the cards in this mailing list.
	getDescription() Returns the description of this mailing list.
	getName() Returns the name of this list.
	getNickName() Returns the nick name of this mailing list.
	getURI() Returns the uniform resource identifier (URI) for this mailing list.
	hasContact(aContact, aAttrs) Returns the card in this mail list, if any, with the same (not-null) value for the GoogleID attribute, or, if the GoogleID is null, if the display name, primary, and second emails are the same.
	remove() Deletes this mailing list from its parent address book.
	setDescription(aDescription) Sets the description for this mailing list.
	setIgnoreIfBroken(aIgnore) Tells this mailing list whether it should avoid asking the user to confirm a reset if broken.
	setName(aName) Sets the name of this list.
	setNickName(aNickName) Sets the nick name for this mailing list.
	update() Updates this mail list (commits changes like renaming or changing the nickname)

Class Detail

com.gContactSync.MailList(aList, aParentDirectory, aNew)

MailList is an abstraction of a mailing list that facilitates getting the cards contained within the actual list as well as accessing and modifying the list and its properties.

Parameters:
aList: {Components.interfaces.nsIAbDirectory} The actual nsIAbDirectory representation of a mailing list.
aParentDirectory: {AddressBook} The parent directory (as an AddressBook object) containing this mailing list.
aNew: {boolean} Set as true for new mailing lists where no attempt should be made to fetch the contacts contained in the list.

Field Detail

mContacts

The contacts in this mailing list (cached)

mContactsUpdate

This is true whenever the contacts have to be fetched again

Method Detail

{TBContact} addContact(aContact)

Adds a contact to this mailing list without checking if it already exists. NOTE: If the contact does not have a primary e-mail address then this method will add a fake one.

Parameters:
aContact: {TBContact} The contact to add to this mailing list.

Returns:: {TBContact} The contact.

deleteContacts(aContacts)

Deletes all of the cards in the array of cards from this list.

Parameters:
aContacts: {array} The array of TBContacts to delete from this mailing list.

{array} getAllContacts()

Returns an array of all of the cards in this mailing list.

Returns:: {array} An array containing all of the cards in this mailing list.

{string} getDescription()

Returns the description of this mailing list.

Returns:: {string} The description of this mailing list.

{string} getName()

Returns the name of this list.

Returns:: {string} The name of this list.

{string} getNickName()

Returns the nick name of this mailing list.

Returns:: {string} The nick name of this mailing list.

{string} getURI()

Returns the uniform resource identifier (URI) for this mailing list.

Returns:: {string} The URI of this list.

{TBContact} hasContact(aContact, aAttrs)

Returns the card in this mail list, if any, with the same (not-null) value for the GoogleID attribute, or, if the GoogleID is null, if the display name, primary, and second emails are the same.

Parameters:
aContact: {TBContact} The contact being searched for.
aAttrs: {Array} The attributes whose values must be identical in order for the contact to match. The defaults are DisplayName, PrimaryEmail, and SecondEmail. This is only used if the contact doesn't have a GoogleID

Returns:: {TBContact} The card in this list, if any, with the same, and non-null value for its GoogleID attribute, or, if the GoogleID is null, if the display name, primary, and second emails are the same.

remove()

Deletes this mailing list from its parent address book.

setDescription(aDescription)

Sets the description for this mailing list. The update method must be called in order for the change to become permanent.

Parameters:
aDescription: {string} The new description for this mailing list.

setIgnoreIfBroken(aIgnore)

Tells this mailing list whether it should avoid asking the user to confirm a reset if broken.

Parameters:
aIgnore: {boolean} Set this to true to avoid notifying the user of a problem if this list is broken.

setName(aName)

Sets the name of this list. The update method must be called in order for the change to become permanent.

Parameters:
aName: {string} The new name for the list.

setNickName(aNickName)

Sets the nick name for this mailing list. The update method must be called in order for the change to become permanent.

Parameters:
aNickName: {string} The new nick name for this mailing list.

update()

Updates this mail list (commits changes like renaming or changing the nickname)

Classes

Class com.gContactSync.MailList