EmailProfile (BlackBerry Web Services for Enterprise Administration 12.0.0 API Reference)

Object
- EmailProfile

public class EmailProfile
extends Object

Contains data about an email profile. Email profiles specify how devices connect to your organization's messaging server and synchronize email messages and organizer data using Microsoft ActiveSync.

Java class for EmailProfile complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="EmailProfile">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="uid" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="localeNameAndDescription" type="{http://ws.rim.com/enterprise/admin}LocaleNameAndDescription" maxOccurs="unbounded" minOccurs="0"/>
         <element name="organizationUid" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="type" type="{http://ws.rim.com/enterprise/admin}EmailProfileType" minOccurs="0"/>
         <element name="serverName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="useSSL" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="pushEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="previousDurationToSync" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="syncInterval" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="manualSyncWhenRoaming" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="syncEmail" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="syncCalendar" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="syncContacts" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Object>`	`any`
`protected List<LocaleNameAndDescription>`	`localeNameAndDescription`
`protected boolean`	`manualSyncWhenRoaming`
`protected String`	`name`
`protected String`	`organizationUid`
`protected String`	`previousDurationToSync`
`protected boolean`	`pushEnabled`
`protected String`	`serverName`
`protected boolean`	`syncCalendar`
`protected boolean`	`syncContacts`
`protected boolean`	`syncEmail`
`protected String`	`syncInterval`
`protected EmailProfileType`	`type`
`protected String`	`uid`
`protected boolean`	`useSSL`

Constructor Summary

Constructors
Constructor and Description

EmailProfile()

Constructors
Constructor and Description
`EmailProfile()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Object>`	`getAny()` Gets the value of the any property.
`List<LocaleNameAndDescription>`	`getLocaleNameAndDescription()` Gets the value of the localeNameAndDescription property.
`String`	`getName()` Gets the value of the name property.
`String`	`getOrganizationUid()` Gets the value of the organizationUid property.
`String`	`getPreviousDurationToSync()` Gets the value of the previousDurationToSync property.
`String`	`getServerName()` Gets the value of the serverName property.
`String`	`getSyncInterval()` Gets the value of the syncInterval property.
`EmailProfileType`	`getType()` Gets the value of the type property.
`String`	`getUid()` Gets the value of the uid property.
`boolean`	`isManualSyncWhenRoaming()` Gets the value of the manualSyncWhenRoaming property.
`boolean`	`isPushEnabled()` Gets the value of the pushEnabled property.
`boolean`	`isSyncCalendar()` Gets the value of the syncCalendar property.
`boolean`	`isSyncContacts()` Gets the value of the syncContacts property.
`boolean`	`isSyncEmail()` Gets the value of the syncEmail property.
`boolean`	`isUseSSL()` Gets the value of the useSSL property.
`void`	`setManualSyncWhenRoaming(boolean value)` Sets the value of the manualSyncWhenRoaming property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOrganizationUid(String value)` Sets the value of the organizationUid property.
`void`	`setPreviousDurationToSync(String value)` Sets the value of the previousDurationToSync property.
`void`	`setPushEnabled(boolean value)` Sets the value of the pushEnabled property.
`void`	`setServerName(String value)` Sets the value of the serverName property.
`void`	`setSyncCalendar(boolean value)` Sets the value of the syncCalendar property.
`void`	`setSyncContacts(boolean value)` Sets the value of the syncContacts property.
`void`	`setSyncEmail(boolean value)` Sets the value of the syncEmail property.
`void`	`setSyncInterval(String value)` Sets the value of the syncInterval property.
`void`	`setType(EmailProfileType value)` Sets the value of the type property.
`void`	`setUid(String value)` Sets the value of the uid property.
`void`	`setUseSSL(boolean value)` Sets the value of the useSSL property.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - uid
```
protected String uid
```
  - name
```
protected String name
```
  - localeNameAndDescription
```
protected List<LocaleNameAndDescription> localeNameAndDescription
```
  - organizationUid
```
protected String organizationUid
```
  - type
```
protected EmailProfileType type
```
  - serverName
```
protected String serverName
```
  - useSSL
```
protected boolean useSSL
```
  - pushEnabled
```
protected boolean pushEnabled
```
  - previousDurationToSync
```
protected String previousDurationToSync
```
  - syncInterval
```
protected String syncInterval
```
  - manualSyncWhenRoaming
```
protected boolean manualSyncWhenRoaming
```
  - syncEmail
```
protected boolean syncEmail
```
  - syncCalendar
```
protected boolean syncCalendar
```
  - syncContacts
```
protected boolean syncContacts
```
  - any
```
protected List<Object> any
```
- Constructor Detail
  - EmailProfile
```
public EmailProfile()
```
- Method Detail
  - getUid
```
public String getUid()
```
    Gets the value of the uid property.
    
    Returns:
    possible object is String
  - setUid
```
public void setUid(String value)
```
    Sets the value of the uid property.
    
    Parameters:
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getLocaleNameAndDescription
```
public List<LocaleNameAndDescription> getLocaleNameAndDescription()
```
    Gets the value of the localeNameAndDescription property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the localeNameAndDescription property.
    For example, to add a new item, do as follows:
```
 getLocaleNameAndDescription().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LocaleNameAndDescription
  - getOrganizationUid
```
public String getOrganizationUid()
```
    Gets the value of the organizationUid property.
    
    Returns:
    possible object is String
  - setOrganizationUid
```
public void setOrganizationUid(String value)
```
    Sets the value of the organizationUid property.
    
    Parameters:
    value - allowed object is String
  - getType
```
public EmailProfileType getType()
```
    Gets the value of the type property.
    
    Returns:
    possible object is EmailProfileType
  - setType
```
public void setType(EmailProfileType value)
```
    Sets the value of the type property.
    
    Parameters:
    value - allowed object is EmailProfileType
  - getServerName
```
public String getServerName()
```
    Gets the value of the serverName property.
    
    Returns:
    possible object is String
  - setServerName
```
public void setServerName(String value)
```
    Sets the value of the serverName property.
    
    Parameters:
    value - allowed object is String
  - isUseSSL
```
public boolean isUseSSL()
```
    Gets the value of the useSSL property.
  - setUseSSL
```
public void setUseSSL(boolean value)
```
    Sets the value of the useSSL property.
  - isPushEnabled
```
public boolean isPushEnabled()
```
    Gets the value of the pushEnabled property.
  - setPushEnabled
```
public void setPushEnabled(boolean value)
```
    Sets the value of the pushEnabled property.
  - getPreviousDurationToSync
```
public String getPreviousDurationToSync()
```
    Gets the value of the previousDurationToSync property.
    
    Returns:
    possible object is String
  - setPreviousDurationToSync
```
public void setPreviousDurationToSync(String value)
```
    Sets the value of the previousDurationToSync property.
    
    Parameters:
    value - allowed object is String
  - getSyncInterval
```
public String getSyncInterval()
```
    Gets the value of the syncInterval property.
    
    Returns:
    possible object is String
  - setSyncInterval
```
public void setSyncInterval(String value)
```
    Sets the value of the syncInterval property.
    
    Parameters:
    value - allowed object is String
  - isManualSyncWhenRoaming
```
public boolean isManualSyncWhenRoaming()
```
    Gets the value of the manualSyncWhenRoaming property.
  - setManualSyncWhenRoaming
```
public void setManualSyncWhenRoaming(boolean value)
```
    Sets the value of the manualSyncWhenRoaming property.
  - isSyncEmail
```
public boolean isSyncEmail()
```
    Gets the value of the syncEmail property.
  - setSyncEmail
```
public void setSyncEmail(boolean value)
```
    Sets the value of the syncEmail property.
  - isSyncCalendar
```
public boolean isSyncCalendar()
```
    Gets the value of the syncCalendar property.
  - setSyncCalendar
```
public void setSyncCalendar(boolean value)
```
    Sets the value of the syncCalendar property.
  - isSyncContacts
```
public boolean isSyncContacts()
```
    Gets the value of the syncContacts property.
  - setSyncContacts
```
public void setSyncContacts(boolean value)
```
    Sets the value of the syncContacts property.
  - getAny
```
public List<Object> getAny()
```
    Gets the value of the any property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.
    For example, to add a new item, do as follows:
```
 getAny().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object

Class EmailProfile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

uid

name

localeNameAndDescription

organizationUid

type

serverName

useSSL

pushEnabled

previousDurationToSync

syncInterval

manualSyncWhenRoaming

syncEmail

syncCalendar

syncContacts

any

Constructor Detail

EmailProfile

Method Detail

getUid

setUid

getName

setName

getLocaleNameAndDescription

getOrganizationUid

setOrganizationUid

getType

setType

getServerName

setServerName

isUseSSL

setUseSSL

isPushEnabled

setPushEnabled

getPreviousDurationToSync

setPreviousDurationToSync

getSyncInterval

setSyncInterval

isManualSyncWhenRoaming

setManualSyncWhenRoaming

isSyncEmail

setSyncEmail

isSyncCalendar

setSyncCalendar

isSyncContacts

setSyncContacts

getAny