Email type

Overview #

This field type is designed to store email addresses, such as "user@test.com." The field will be displayed as a mailto link.

Available features #

REST API #

Read format #

The format is a straightforward string containing the email:

"contactInformation": {
  "email": "user@test.com"
}

Write format #

You should provide a string containing the email:

"contactInformation": {
"email": "user@test.com"
}

JavaScript API #

Read format #

The val() method within the wrapper will return a plain string with the email address:

// this will print something like "email: user@test.com"
log('email: '+record.field('contactInformation.email').val());

Write format #

To set the value, you should provide a plain string containing the email:

record.field('contactInformation.email').val('user@test.com');

Export/Import #

Export format #

The export format is a simple string with the email:

"emailField1","emailField2"
"user1@test.com","user2@test.com"

Import format #

The import format is a simple string with the email:

"emailField1","emailField2"
"user1@test.com","user2@test.com"

Queries #

For more information, please refer to the Query Language Documentation.

Available operators #

Query formats #

You should provide the email as a plain string. For example:

// finds companies with contact email like 'test' 
var records_sample = sys.data.find('companies', {'contactInformation.email': 'like(test)'});
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}

// finds companies with contact email like 'test' 
var query_sample = sys.data.createQuery('companies')
    .field('contactInformation.email').like('test')
var records_sample = sys.data.find(query_sample);
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}

// finds companies with contact email like 'test' 
GET /data/contacts?contactInformation.email=like(test)

Aggregate queries #

Please refer to the Aggregate Queries Documentation for more detailed information.

Available operators #

UI queries #

Please refer to the UI Queries Documentation for more detailed information.

Matching of values #

Available operators #