Opensocial.Email (v0.9)
- Mark Halvorson (Deactivated)
NeedsExamples
opensocial.Email
Base interface for all email objects.
Methods
opensocial.Email.getField
;String getField(key, opt_params)
Parameters
NameTypeDescription |
key |
String |
The key to get data for; keys are defined in Email.Field |
|
opt_params |
Map.<opensocial.DataRequest.DataRequestFields |
Object> |
Additional params to pass to the request. |
Returns
TypeDescription |
String |
The data |
Description
Gets data for this body type that is associated with the specified key.
opensocial.Email.Field
All of the fields that an email has. These are the supported keys for the Email.getField() method.
opensocial.Email.Field.ADDRESS
The email address, specified as a string. This field may be used interchangeably with the string 'address'.
opensocial.Email.Field.TYPE
The email type or label, specified as a string. Examples: work, my favorite store, my house, etc. This field may be used interchangeably with the string 'type'.
{{ JsApiAlphaList_(v0.9) }}