|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.client.Service
com.google.gdata.client.GoogleService
com.google.gdata.client.appsforyourdomain.AppsForYourDomainService
com.google.gdata.client.appsforyourdomain.AppsPropertyService
com.google.gdata.client.appsforyourdomain.adminsettings.EmailManagementService
public class EmailManagementService
Specialization of AppsPropertyService
for managing Email migration,
routing and outbound gateway settings of a domain.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gdata.client.GoogleService |
---|
GoogleService.AccountDeletedException, GoogleService.AccountDisabledException, GoogleService.CaptchaRequiredException, GoogleService.InvalidCredentialsException, GoogleService.NotVerifiedException, GoogleService.ServiceUnavailableException, GoogleService.SessionExpiredException, GoogleService.TermsNotAgreedException |
Nested classes/interfaces inherited from class com.google.gdata.client.Service |
---|
Service.ClientOutputProperties, Service.GDataRequest, Service.GDataRequestFactory, Service.Versions |
Field Summary |
---|
Fields inherited from class com.google.gdata.client.appsforyourdomain.AppsForYourDomainService |
---|
APPS_SERVICE, DOMAIN_NAME, HTTPS_PROTOCOL |
Constructor Summary | |
---|---|
EmailManagementService(java.lang.String domain,
java.lang.String applicationName)
Parameterized constructor to setup a Service object which can be used to initialize the service without obtaining a token. |
|
EmailManagementService(java.lang.String adminEmail,
java.lang.String password,
java.lang.String domain,
java.lang.String applicationName)
Parameterized constructor for service authentication. |
Method Summary | |
---|---|
boolean |
isUserMigrationEnabled()
Retrieves the migration access settings |
GenericFeed |
retrieveEmailRoutingSettings()
Retrieves all configured email routing settings as a GenericFeed. |
GenericEntry |
retrieveOutboundGatewaySettings()
Retrieves the outbound gateway settings for the domain. |
void |
setUserMigrationAccess(boolean enableUserMigration)
Grants email migration access to users. |
GenericEntry |
updateOutboundGatewaySettings(java.lang.String smartHost,
java.lang.String smtpMode)
Updates the outbound gateway settings for the domain. |
Methods inherited from class com.google.gdata.client.appsforyourdomain.AppsForYourDomainService |
---|
delete, getEntry, getEntry, getFeed, getFeed, insert, query, update |
Methods inherited from class com.google.gdata.client.GoogleService |
---|
addCookie, batch, createRequest, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getFeed, getFeed, getFeed, handlesCookies, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChanged |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmailManagementService(java.lang.String domain, java.lang.String applicationName)
setUserCredentials
or setUserToken
when using this constructor.
domain
- Domain being configuredapplicationName
- Application name consuming the APIpublic EmailManagementService(java.lang.String adminEmail, java.lang.String password, java.lang.String domain, java.lang.String applicationName) throws AuthenticationException
adminEmail
- the email id of the administrator.password
- the administrator password.domain
- the domain name to be configured.
AuthenticationException
- if an authentication related error occurs.Method Detail |
---|
public boolean isUserMigrationEnabled() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
AppsForYourDomainException
java.io.IOException
ServiceException
java.net.MalformedURLException
public void setUserMigrationAccess(boolean enableUserMigration) throws AppsForYourDomainException, java.io.IOException, ServiceException
enableUserMigration
- If true, user migration access is granted.
AppsForYourDomainException
- if an Apps for your domain API error
occurred.
java.io.IOException
- if an error occurs while communicating with the GData
service.
ServiceException
- if the fetch request failed due to system error.public GenericEntry retrieveOutboundGatewaySettings() throws AppsForYourDomainException, java.net.MalformedURLException, java.io.IOException, ServiceException
AppsForYourDomainException
- if an Apps for your domain API error
occurred.
java.io.IOException
- if an error occurs while communicating with the GData
service.
ServiceException
- if the fetch request failed due to system error.
java.net.MalformedURLException
public GenericEntry updateOutboundGatewaySettings(java.lang.String smartHost, java.lang.String smtpMode) throws AppsForYourDomainException, java.io.IOException, ServiceException
smartHost
- either the IP address or hostname of your SMTP server.
Google Apps routes outgoing mail to this server.smtpMode
- the default value is SMTP. Another value, SMTP_TLS, secures
a TLS connection with TLS when delivering the message.
AppsForYourDomainException
- if an Apps for your domain API error
occurred.
java.io.IOException
- if an error occurs while communicating with the GData
service.
ServiceException
- if the fetch request failed due to system error.public GenericFeed retrieveEmailRoutingSettings() throws AppsForYourDomainException, java.io.IOException, ServiceException
AppsForYourDomainException
- if an Apps for your domain API error
occurred.
java.io.IOException
- if an error occurs while communicating with the GData
service.
ServiceException
- if the fetch request failed due to system error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |