Package org.jclouds.glesys.features

Interface EmailAccountApi

public interface EmailAccountApi
Provides synchronous access to E-Mail requests.

See Also:

  • Method Details

    • getOverview

      @Named("email:overview") @POST @Path("/email/overview/format/json") @Consumes("application/json") EmailOverview getOverview()
      Get a summary of e-mail accounts associated with this Glesys account
      Returns:
      the relevant summary data

    • listDomain

      @Named("email:list:accounts") @POST @Path("/email/list/format/json") @Consumes("application/json") com.google.common.collect.FluentIterable<EmailAccount> listDomain(@FormParam("domainname") String domain)
      Get the set of detailed information about e-mail accounts
      Returns:
      the relevant set of details

    • listAliasesInDomain

      @Named("email:list:aliases") @POST @Path("/email/list/format/json") @Consumes("application/json") com.google.common.collect.FluentIterable<EmailAlias> listAliasesInDomain(@FormParam("domainname") String domain)
      Get the set of details about e-mail aliases
      Returns:
      the relevant set of details

    • createWithPassword

      @Named("email:createaccount") @POST @Consumes("application/json") @Path("/email/createaccount/format/json") EmailAccount createWithPassword(@FormParam("emailaccount") String accountAddress, @FormParam("password") String password, CreateAccountOptions... options)
      Create a new e-mail account
      Parameters:
      accountAddress - the e-mail address to use (the domain should already exist)
      password - the password to use for the mailbox
      options - optional parameters
      See Also:

    • createAlias

      @Named("email:createalias") @POST @Consumes("application/json") @Path("/email/createalias/format/json") EmailAlias createAlias(@FormParam("emailalias") String aliasAddress, @FormParam("goto") String toEmailAddress)
      Create an e-mail alias for an e-mail account
      Parameters:
      aliasAddress - the address to use for the alias (the domain should already exist)
      toEmailAddress - the existing e-mail account address the alias should forward to
      See Also:

    • update

      @Named("email:editaccount") @POST @Consumes("application/json") @Path("/email/editaccount/format/json") EmailAccount update(@FormParam("emailaccount") String accountAddress, UpdateAccountOptions... options)
      Adjust an e-mail account's settings
      Parameters:
      accountAddress - the existing e-mail account address
      options - optional parameters

    • updateAlias

      @Named("email:editalias") @POST @Consumes("application/json") @Path("/email/editalias/format/json") EmailAlias updateAlias(@FormParam("emailalias") String aliasAddress, @FormParam("goto") String toEmailAddress)
      Adjust (re-target) an e-mail alias
      Parameters:
      aliasAddress - the existing alias e-mail address
      toEmailAddress - the existing e-mail account address the alias should forward to

    • delete

      @Named("email:delete") @POST @Path("/email/delete/format/json") boolean delete(@FormParam("email") String accountAddress)
      Delete an e-mail account or alias
      Parameters:
      accountAddress - the existing alias e-mail account or alias address