Class EmailField

deleteEmailField()

Deletes this email address from the Contact.

 

 // Retrieves and deletes the work email address for contact 'John Doe'
 var contacts = ContactsApp.getContactsByName('John Doe');
 var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
 workEmail[0].deleteEmailField();
 

getAddress()

Get the address for this field.

 

 // Logs the address for the 'Home Address' field for contact 'John Doe'.
 // Can be used similarly for other fields that contain addresses.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
 Logger.log(homeAddress[0].getAddress());
 

Return

String — the address as a string

getDisplayName()

Returns the display name for this email address.

 

 // Logs the display name for the the work email address for contact 'John Doe'
 var contacts = ContactsApp.getContactsByName('John Doe');
 var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
 Logger.log(workEmail[0].getDisplayName());
 

Return

String — the display name for this email

getLabel()

Gets the label for this field. This may be a Field, ExtendedField, or a String.

 

 // Logs the label for all the address fields associated with contact
 // 'John Doe'. This method can be similarly called for any field that has
 // a label.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var addressFields = contacts[0].getAddresses();
 for (var i = 0; i < addressFields.length; i++) {
   Logger.log(addressFields[i].getLabel());
 }
 

Return

Object — the label for this field

isPrimary()

Gets whether this is the primary field value.

 

 // Logs whether or not the first address field associated with contact
 // 'John Doe' is labeled as primary. This method can be similarly called
 // for any field.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var addressFields = contacts[0].getAddresses();
 Logger.log(addressFields[0].isPrimary());
 

Return

Boolean — whether this is primary

setAddress(address)

Sets the address of this field.

 

 // Sets the address for the 'Home Address' field for contact 'John Doe'.
 // Can be used similarly for other fields that contain addresses.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
 homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');
 

Parameters

Return

EmailField — this field, useful for chaining

setAsPrimary()

Sets this field to primary.

 

 // Sets the the first address field associated with contact 'John Doe'
 // as primary. This method can be similarly called for any field.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var addressFields = contacts[0].getAddresses();
 addressFields[0].setAsPrimary();
 

Return

EmailField — this FieldValue for chaining

setDisplayName(name)

Sets the display name for this email address.

 

 // Sets the display name to 'Doe, John' for the the work email address for contact 'John Doe'
 var contacts = ContactsApp.getContactsByName('John Doe');
 var workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);
 workEmail[0].setDisplayName('Doe, John');
 

Parameters

Return

EmailField — this email field, useful for chaining

setLabel(field)

Sets the label of this field.

 

 // Sets the label to 'Work' for the first address field associated
 // with contact 'John Doe'. This method can be similarly called for any
 // field that has a label.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var addressFields = contacts[0].getAddresses();
 addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);
 

Parameters

Return

EmailField — this FieldValue for chaining

setLabel(label)

Sets the label of this field.

 

 // Sets the label to 'Apartment' for the first address field associated
 // with contact 'John Doe'. This method can be similarly called for any
 // field that has a label.
 var contacts = ContactsApp.getContactsByName('John Doe');
 var addressFields = contacts[0].getAddresses();
 addressFields[0].setLabel('Apartment');
 

Parameters

Return

EmailField — this field, useful for chaining