// 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 following scopes:
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 following scopes:
// 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 following scopes:
// 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');
// 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();
// 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);
// 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');
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 following scopes:
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 following scopes:
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
Name
Type
Description
name
String
the 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 following scopes:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eEmailField is deprecated and the People API advanced service should be used instead.\u003c/p\u003e\n"],["\u003cp\u003eRepresents an email field within a Contact, offering methods to manage its address, label, and primary status.\u003c/p\u003e\n"],["\u003cp\u003eProvides methods like \u003ccode\u003egetAddress()\u003c/code\u003e, \u003ccode\u003esetLabel()\u003c/code\u003e, and \u003ccode\u003eisPrimary()\u003c/code\u003e to interact with email field properties.\u003c/p\u003e\n"],["\u003cp\u003eIncludes deprecated methods such as \u003ccode\u003edeleteEmailField()\u003c/code\u003e, \u003ccode\u003egetDisplayName()\u003c/code\u003e, and \u003ccode\u003esetDisplayName()\u003c/code\u003e which should be avoided in new scripts.\u003c/p\u003e\n"]]],[],null,["EmailField\n\n\n**Deprecated.** Instead, use the [People API advanced\nservice](/apps-script/advanced/people)\n\nAn email field in a Contact. \n\nMethods\n\n| Method | Return type | Brief description |\n|--------------------------------------------|-----------------|-----------------------------------------------|\n| [getAddress()](#getAddress()) | `String` | Get the address for this field. |\n| [getLabel()](#getLabel()) | `Object` | Gets the label for this field. |\n| [isPrimary()](#isPrimary()) | `Boolean` | Gets whether this is the primary field value. |\n| [setAddress(address)](#setAddress(String)) | [EmailField](#) | Sets the address of this field. |\n| [setAsPrimary()](#setAsPrimary()) | [EmailField](#) | Sets this field to primary. |\n| [setLabel(field)](#setLabel(Field)) | [EmailField](#) | Sets the label of this field. |\n| [setLabel(label)](#setLabel(String)) | [EmailField](#) | Sets the label of this field. |\n\nDeprecated methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|-----------------|--------------------------------------------------|\n| [deleteEmailField()](#deleteEmailField()) | `void` | Deletes this email address from the Contact. |\n| [getDisplayName()](#getDisplayName()) | `String` | Returns the display name for this email address. |\n| [setDisplayName(name)](#setDisplayName(String)) | [EmailField](#) | Sets the display name for this email address. |\n\nDetailed documentation \n\n`get``Address()` \nGet the address for this field.\n\n```javascript\n// Logs the address for the 'Home Address' field for contact 'John Doe'.\n// Can be used similarly for other fields that contain addresses.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);\nLogger.log(homeAddress[0].getAddress());\n```\n\nReturn\n\n\n`String` --- the address as a string\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`get``Label()` \nGets the label for this field. This may be a Field, ExtendedField, or a String.\n\n```javascript\n// Logs the label for all the address fields associated with contact\n// 'John Doe'. This method can be similarly called for any field that has\n// a label.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\nfor (let i = 0; i \u003c addressFields.length; i++) {\n Logger.log(addressFields[i].getLabel());\n}\n```\n\nReturn\n\n\n`Object` --- the label for this field\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`is``Primary()` \nGets whether this is the primary field value.\n\n```javascript\n// Logs whether or not the first address field associated with contact\n// 'John Doe' is labeled as primary. This method can be similarly called\n// for any field.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\nLogger.log(addressFields[0].isPrimary());\n```\n\nReturn\n\n\n`Boolean` --- whether this is primary\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`set``Address(address)` \nSets the address of this field.\n\n```javascript\n// Sets the address for the 'Home Address' field for contact 'John Doe'.\n// Can be used similarly for other fields that contain addresses.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);\nhomeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');\n```\n\nParameters\n\n| Name | Type | Description |\n|-----------|----------|-----------------|\n| `address` | `String` | the new address |\n\nReturn\n\n\n[EmailField](#) --- this field, useful for chaining\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`set``As``Primary()` \nSets this field to primary.\n\n```javascript\n// Sets the first address field associated with contact 'John Doe'\n// as primary. This method can be similarly called for any field.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\naddressFields[0].setAsPrimary();\n```\n\nReturn\n\n\n[EmailField](#) --- this FieldValue for chaining\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`set``Label(field)` \nSets the label of this field.\n\n```javascript\n// Sets the label to 'Work' for the first address field associated\n// with contact 'John Doe'. This method can be similarly called for any\n// field that has a label.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\naddressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);\n```\n\nParameters\n\n| Name | Type | Description |\n|---------|------------------------------------------------|------------------------|\n| `field` | [Field](/apps-script/reference/contacts/field) | the new standard label |\n\nReturn\n\n\n[EmailField](#) --- this FieldValue for chaining\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`set``Label(label)` \nSets the label of this field.\n\n```javascript\n// Sets the label to 'Apartment' for the first address field associated\n// with contact 'John Doe'. This method can be similarly called for any\n// field that has a label.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\naddressFields[0].setLabel('Apartment');\n```\n\nParameters\n\n| Name | Type | Description |\n|---------|----------|------------------------------|\n| `label` | `String` | the new label for this field |\n\nReturn\n\n\n[EmailField](#) --- this field, useful for chaining\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\nDeprecated methods \n\n`delete``Email``Field()` \n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes this email address from the Contact.\n\n```javascript\n// Retrieves and deletes the work email address for contact 'John Doe'\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);\nworkEmail[0].deleteEmailField();\n```\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`get``Display``Name()` \n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nReturns the display name for this email address.\n\n```javascript\n// Logs the display name for the work email address for contact 'John Doe'\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);\nLogger.log(workEmail[0].getDisplayName());\n```\n\nReturn\n\n\n`String` --- the display name for this email\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n`set``Display``Name(name)` \n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nSets the display name for this email address.\n\n```javascript\n// Sets the display name to 'Doe, John' for the work email address for contact\n// 'John Doe'\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL);\nworkEmail[0].setDisplayName('Doe, John');\n```\n\nParameters\n\n| Name | Type | Description |\n|--------|----------|---------------------------------------------|\n| `name` | `String` | the new display name for this email address |\n\nReturn\n\n\n[EmailField](#) --- this email field, useful for chaining\n\nAuthorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`"]]