Class EmailField

  • The EmailField is deprecated and users should use the People API advanced service instead.

  • EmailField represents an email field within a Contact.

  • EmailField provides methods to get and set the email address and its label, and to check or set if it is the primary email field.

  • Some methods for EmailField, such asdeleteEmailField(),getDisplayName(), andsetDisplayName(), are also deprecated.

EmailField

Deprecated. Instead, use thePeople API advanced service

An email field in a Contact.

Methods

MethodReturn typeBrief description
getAddress()StringGet the address for this field.
getLabel()ObjectGets the label for this field.
isPrimary()BooleanGets whether this is the primary field value.
setAddress(address)EmailFieldSets the address of this field.
setAsPrimary()EmailFieldSets this field to primary.
setLabel(field)EmailFieldSets the label of this field.
setLabel(label)EmailFieldSets the label of this field.

Deprecated methods

MethodReturn typeBrief description
deleteEmailField()voidDeletes this email address from the Contact.
getDisplayName()StringReturns the display name for this email address.
setDisplayName(name)EmailFieldSets the display name for this email address.

Detailed documentation

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.constcontacts=ContactsApp.getContactsByName('John Doe');consthomeAddress=contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);Logger.log(homeAddress[0].getAddress());

Return

String — the address as a string

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();for(leti=0;i <addressFields.length;i++){Logger.log(addressFields[i].getLabel());}

Return

Object — the label for this field

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();Logger.log(addressFields[0].isPrimary());

Return

Boolean — whether this is primary

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

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.constcontacts=ContactsApp.getContactsByName('John Doe');consthomeAddress=contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');

Parameters

NameTypeDescription
addressStringthe new address

Return

EmailField — this field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

setAsPrimary()

Sets this field to primary.

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

Return

EmailField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);

Parameters

NameTypeDescription
fieldFieldthe new standard label

Return

EmailField — this FieldValue for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

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.constcontacts=ContactsApp.getContactsByName('John Doe');constaddressFields=contacts[0].getAddresses();addressFields[0].setLabel('Apartment');

Parameters

NameTypeDescription
labelStringthe new label for this field

Return

EmailField — this field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

Deprecated methods

deleteEmailField()

Deprecated. This function is deprecated and should not be used in new scripts.

Deletes this email address from the Contact.

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

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

getDisplayName()

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the display name for this email address.

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

Return

String — the display name for this email

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

setDisplayName(name)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the display name for this email address.

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

Parameters

NameTypeDescription
nameStringthe new display name for this email address

Return

EmailField — this email field, useful for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes:

  • https://www.google.com/m8/feeds

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.