libgmail.GmailContactList

Module libgmail :: Class GmailContactList |
[hide private]
[frames] | no frames]

# Class GmailContactList

source code
Class for storing an entire Gmail contacts list and retrieving contacts by Id, Email address, and name

Instance Methods | [hide private]
__init__(self, contactList) | source code
__str__(self) | source code
getCount(self) Returns number of contacts | source code
getAllContacts(self) Returns an array of all the GmailContacts | source code
getContactByName(self, name) Gets the first contact in the address book whose name is 'name'. | source code
getContactByEmail(self, email) Gets the first contact in the address book whose name is 'email'. | source code
getContactById(self, myId) Gets the first contact in the address book whose id is 'myId'. | source code
getContactListByName(self, name) This function returns a LIST of GmailContacts whose name is 'name'. | source code
getContactListByEmail(self, email) This function returns a LIST of GmailContacts whose email is 'email'. | source code
getContactListById(self, myId) This function returns a LIST of GmailContacts whose id is 'myId'. | source code

Method Details | [hide private]

### getContactByName(self, name) | source code
Gets the first contact in the address book whose name is 'name'. Returns False if no contact could be found

### getContactByEmail(self, email) | source code
Gets the first contact in the address book whose name is 'email'. As of this writing, Gmail insists upon a unique email; i.e. two contacts cannot share an email address. Returns False if no contact could be found

### getContactById(self, myId) | source code
Gets the first contact in the address book whose id is 'myId'. REMEMBER: ID IS A STRING Returns False if no contact could be found

### getContactListByName(self, name) | source code
This function returns a LIST of GmailContacts whose name is 'name'. Returns an empty list if no contacts were found

### getContactListByEmail(self, email) | source code
This function returns a LIST of GmailContacts whose email is 'email'. As of this writing, two contacts cannot share an email address, so this should only return just one item. But it doesn't hurt to be prepared? Returns an empty list if no contacts were found

### getContactListById(self, myId) | source code
This function returns a LIST of GmailContacts whose id is 'myId'. We expect there only to be one, but just in case! Remember: ID IS A STRING Returns an empty list if no contacts were found