Esta página foi traduzida pela API Cloud Translation.

Class EmailField

Obsoleto. Em vez disso, use o serviço avançado da API People.

Um campo de e-mail em um contato.

Métodos

Método	Tipo de retorno	Breve descrição
`getAddress()`	`String`	Receba o endereço desse campo.
`getLabel()`	`Object`	Recebe o rótulo desse campo.
`isPrimary()`	`Boolean`	Verifica se esse é o valor do campo principal.
`setAddress(address)`	`EmailField`	Define o endereço desse campo.
`setAsPrimary()`	`EmailField`	Define esse campo como primário.
`setLabel(field)`	`EmailField`	Define o rótulo desse campo.
`setLabel(label)`	`EmailField`	Define o rótulo desse campo.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`deleteEmailField()`	`void`	Exclui esse endereço de e-mail do contato.
`getDisplayName()`	`String`	Retorna o nome de exibição desse endereço de e-mail.
`setDisplayName(name)`	`EmailField`	Define o nome de exibição para esse endereço de e-mail.

Documentação detalhada

`getAddress()`

Receba o endereço desse campo.

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

Retornar

String: o endereço como uma string

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`getLabel()`

Recebe o rótulo desse campo. Pode ser um campo, um ExtendedField ou uma 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
for (let i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Retornar

Object: o rótulo do campo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`isPrimary()`

Verifica se esse é o valor do campo principal.

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

Retornar

Boolean: se é a principal

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setAddress(address)`

Define o endereço desse campo.

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

Parâmetros

Nome	Tipo	Descrição
`address`	`String`	o novo endereço

Retornar

EmailField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setAsPrimary()`

Define esse campo como primário.

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

Retornar

EmailField: FieldValue para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setLabel(field)`

Define o rótulo desse campo.

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

Parâmetros

Nome	Tipo	Descrição
`field`	`Field`	o novo rótulo padrão

Retornar

EmailField: FieldValue para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setLabel(label)`

Define o rótulo desse campo.

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

Parâmetros

Nome	Tipo	Descrição
`label`	`String`	o novo rótulo para esse campo

Retornar

EmailField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos

`deleteEmailField()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui esse endereço de e-mail do contato.

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`getDisplayName()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Retorna o nome de exibição desse endereço de e-mail.

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

Retornar

String: o nome de exibição desse e-mail

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setDisplayName(name)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o nome de exibição para esse endereço de e-mail.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o novo nome de exibição para esse endereço de e-mail

Retornar

EmailField: campo de e-mail, útil para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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