Google Data APIs Client Library (1.41.1)



com.google.gdata.client.appsforyourdomain.adminsettings
Class EmailManagementService

java.lang.Object
  extended by com.google.gdata.client.Service
      extended by com.google.gdata.client.GoogleService
          extended by com.google.gdata.client.appsforyourdomain.AppsForYourDomainService
              extended by com.google.gdata.client.appsforyourdomain.AppsPropertyService
                  extended by com.google.gdata.client.appsforyourdomain.adminsettings.EmailManagementService
All Implemented Interfaces:
AuthTokenFactory.TokenListener

public class EmailManagementService
extends AppsPropertyService

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.ClientInputProperties, Service.ClientOutputProperties, Service.ClientStreamProperties, Service.GDataRequest, Service.GDataRequestFactory, Service.Versions
 
Field Summary
protected  java.lang.String domainUrlBase
           
protected  java.lang.String emailBaseUrl
           
 
Fields inherited from class com.google.gdata.client.appsforyourdomain.AppsForYourDomainService
APPS_SERVICE, DOMAIN_NAME, HTTPS_PROTOCOL
 
Fields inherited from class com.google.gdata.client.Service
connectTimeout, extProfile, metadataRegistry, requestFactory
 
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, createRequest, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setOAuthCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserCredentials, setUserToken, tokenChanged
 
Methods inherited from class com.google.gdata.client.Service
classOf, createBatchRequest, createDeleteRequest, createEntryRequest, createFeedRequest, createFeedRequest, createInsertRequest, createLinkQueryRequest, createPatchRequest, createUpdateRequest, delete, delete, endVersionScope, getAltRegistry, getContentType, getDefaultAltRegistry, getExtensionProfile, getFeed, getMetadataRegistry, getProtocolVersion, getRequestFactory, getSchema, getServiceVersion, getStreamFromLink, getVersion, initServiceVersion, introspect, parseResponseData, parseResponseData, patch, patch, query, query, setAcceptLanguage, setAltRegistry, setConnectTimeout, setContentType, setExtensionProfile, setHeader, setOAuthProxyHeaders, setPrivateHeader, setProtocolVersion, setReadTimeout, setRequestFactory, setTimeouts, startVersionScope, update, useSsl, writeRequestData, writeRequestData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

domainUrlBase

protected java.lang.String domainUrlBase

emailBaseUrl

protected java.lang.String emailBaseUrl
Constructor Detail

EmailManagementService

public 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. The user should explicitly authorize the service by calling either setUserCredentials or setUserToken when using this constructor.

Parameters:
domain - Domain being configured
applicationName - Application name consuming the API

EmailManagementService

public EmailManagementService(java.lang.String adminEmail,
                              java.lang.String password,
                              java.lang.String domain,
                              java.lang.String applicationName)
                       throws AuthenticationException
Parameterized constructor for service authentication.

Parameters:
adminEmail - the email id of the administrator.
password - the administrator password.
domain - the domain name to be configured.
Throws:
AuthenticationException - if an authentication related error occurs.
Method Detail

isUserMigrationEnabled

public boolean isUserMigrationEnabled()
                               throws AppsForYourDomainException,
                                      java.net.MalformedURLException,
                                      java.io.IOException,
                                      ServiceException
Retrieves the migration access settings

Returns:
true, if user migration access is enabled.
Throws:
AppsForYourDomainException
java.io.IOException
ServiceException
java.net.MalformedURLException

setUserMigrationAccess

public void setUserMigrationAccess(boolean enableUserMigration)
                            throws AppsForYourDomainException,
                                   java.io.IOException,
                                   ServiceException
Grants email migration access to users.

Parameters:
enableUserMigration - If true, user migration access is granted.
Throws:
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.

retrieveOutboundGatewaySettings

public GenericEntry retrieveOutboundGatewaySettings()
                                             throws AppsForYourDomainException,
                                                    java.net.MalformedURLException,
                                                    java.io.IOException,
                                                    ServiceException
Retrieves the outbound gateway settings for the domain.

Returns:
GenericEntry a updated GenericEntry instance with outbound gateway settings.
Throws:
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

updateOutboundGatewaySettings

public GenericEntry updateOutboundGatewaySettings(java.lang.String smartHost,
                                                  java.lang.String smtpMode)
                                           throws AppsForYourDomainException,
                                                  java.io.IOException,
                                                  ServiceException
Updates the outbound gateway settings for the domain.

Parameters:
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.
Returns:
GenericEntry a updated GenericEntry instance with outbound gateway settings.
Throws:
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.

retrieveEmailRoutingSettings

public GenericFeed retrieveEmailRoutingSettings()
                                         throws AppsForYourDomainException,
                                                java.io.IOException,
                                                ServiceException
Retrieves all configured email routing settings as a GenericFeed.

Returns:
GenericFeed a GenericFeed with email routing settings.
Throws:
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.