Android APIs
public static final class

ContactsContract.CommonDataKinds.Email

extends Object
implements ContactsContract.DataColumnsWithJoins ContactsContract.CommonDataKinds.CommonColumns
java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.Email

Class Overview

A data kind representing an email address.

You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

Type AliasData column
String ADDRESS DATA1 Email address itself.
int TYPE DATA2 Allowed values are:

String LABEL DATA3

Summary

Constants
String ADDRESS The email address.
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
String CONTENT_TYPE The MIME type of CONTENT_URI providing a directory of email addresses.
String DISPLAY_NAME The display name for the email address

Type: TEXT

String EXTRA_ADDRESS_BOOK_INDEX Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras.
String EXTRA_ADDRESS_BOOK_INDEX_COUNTS The array of group counts for the corresponding group.
String EXTRA_ADDRESS_BOOK_INDEX_TITLES The array of address book index titles, which are returned in the same order as the data in the cursor.
int TYPE_HOME
int TYPE_MOBILE
int TYPE_OTHER
int TYPE_WORK
[Expand]
Inherited Constants
From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns
From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.DataColumns
From interface android.provider.ContactsContract.StatusColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.ContactsColumns
From interface android.provider.ContactsContract.ContactNameColumns
From interface android.provider.ContactsContract.ContactOptionsColumns
From interface android.provider.ContactsContract.ContactStatusColumns
From interface android.provider.ContactsContract.DataUsageStatColumns
From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes
Fields
public static final Uri CONTENT_FILTER_URI

The content:// style URL for email lookup using a filter.

public static final Uri CONTENT_LOOKUP_URI

The content:// style URL for looking up data rows by email address.

public static final Uri CONTENT_URI The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type, combined with the associated raw contact and aggregate contact data.
public static final Uri ENTERPRISE_CONTENT_LOOKUP_URI

URI used for enterprise email lookup.

Public Methods
final static CharSequence getTypeLabel(Resources res, int type, CharSequence label)
Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.
final static int getTypeLabelResource(int type)
Return the string resource that best describes the given TYPE.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ADDRESS

Added in API level 11

The email address.

Type: TEXT

Constant Value: "data1"

public static final String CONTENT_ITEM_TYPE

Added in API level 5

MIME type used when storing this in data table.

Constant Value: "vnd.android.cursor.item/email_v2"

public static final String CONTENT_TYPE

Added in API level 5

The MIME type of CONTENT_URI providing a directory of email addresses.

Constant Value: "vnd.android.cursor.dir/email_v2"

public static final String DISPLAY_NAME

Added in API level 5

The display name for the email address

Type: TEXT

Constant Value: "data4"

public static final String EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras. For most languages it is the first letter of the sort key. This parameter does not affect the main content of the cursor.

 Example:

 import android.provider.ContactsContract.Contacts;

 Uri uri = Contacts.CONTENT_URI.buildUpon()
          .appendQueryParameter(Contacts.EXTRA_ADDRESS_BOOK_INDEX, "true")
          .build();
 Cursor cursor = getContentResolver().query(uri,
          new String[] {Contacts.DISPLAY_NAME},
          null, null, null);
 Bundle bundle = cursor.getExtras();
 if (bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES) &&
         bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS)) {
     String sections[] =
             bundle.getStringArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES);
     int counts[] = bundle.getIntArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS);
 }
 

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

Added in API level 21

The array of group counts for the corresponding group. Contains the same number of elements as the EXTRA_ADDRESS_BOOK_INDEX_TITLES array.

TYPE: int[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

Added in API level 21

The array of address book index titles, which are returned in the same order as the data in the cursor.

TYPE: String[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

public static final int TYPE_HOME

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_MOBILE

Added in API level 5

Constant Value: 4 (0x00000004)

public static final int TYPE_OTHER

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int TYPE_WORK

Added in API level 5

Constant Value: 2 (0x00000002)

Fields

public static final Uri CONTENT_FILTER_URI

Added in API level 5

The content:// style URL for email lookup using a filter. The filter returns records of MIME type CONTENT_ITEM_TYPE. The filter is applied to display names as well as email addresses. The filter argument should be passed as an additional path segment after this URI.

The query in the following example will return "Robert Parr (bob@incredibles.com)" as well as "Bob Parr (incredible@android.com)".

 Uri uri = Uri.withAppendedPath(Email.CONTENT_LOOKUP_URI, Uri.encode("bob"));
 Cursor c = getContentResolver().query(uri,
          new String[]{Email.DISPLAY_NAME, Email.DATA},
          null, null, null);
 

public static final Uri CONTENT_LOOKUP_URI

Added in API level 5

The content:// style URL for looking up data rows by email address. The lookup argument, an email address, should be passed as an additional path segment after this URI.

Example:

 Uri uri = Uri.withAppendedPath(Email.CONTENT_LOOKUP_URI, Uri.encode(email));
 Cursor c = getContentResolver().query(uri,
          new String[]{Email.CONTACT_ID, Email.DISPLAY_NAME, Email.DATA},
          null, null, null);
 

public static final Uri CONTENT_URI

Added in API level 5

The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type, combined with the associated raw contact and aggregate contact data.

public static final Uri ENTERPRISE_CONTENT_LOOKUP_URI

Added in API level 23

URI used for enterprise email lookup.

It supports the same semantics as CONTENT_LOOKUP_URI and returns the same columns. If the device has no corp profile that is linked to the current profile, it behaves in the exact same way as CONTENT_LOOKUP_URI. If there is a corp profile linked to the current profile, it first queries against the personal contact database, and if no matching contacts are found there, then queries against the corp contacts database.

If a result is from the corp profile, it makes the following changes to the data:

A contact lookup URL built by getLookupUri(long, String) with an _ID and a LOOKUP_KEY returned by this API can be passed to showQuickContact(Context, Rect, Uri, int, String[]) even if a contact is from the corp profile.

 Uri lookupUri = Uri.withAppendedPath(Email.ENTERPRISE_CONTENT_LOOKUP_URI,
         Uri.encode(email));
 

Public Methods

public static final CharSequence getTypeLabel (Resources res, int type, CharSequence label)

Added in API level 5

Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.

public static final int getTypeLabelResource (int type)

Added in API level 5

Return the string resource that best describes the given TYPE. Will always return a valid resource.