org.jclouds.glesys.features

Interface EmailAccountApi

public interface EmailAccountApi

Provides synchronous access to E-Mail requests.

See Also:

Method Summary

Modifier and Type	Method and Description
EmailAlias	createAlias(String aliasAddress, String toEmailAddress) Create an e-mail alias for an e-mail account
EmailAccount	createWithPassword(String accountAddress, String password, CreateAccountOptions... options) Create a new e-mail account
boolean	delete(String accountAddress) Delete an e-mail account or alias
EmailOverview	getOverview() Get a summary of e-mail accounts associated with this Glesys account
com.google.common.collect.FluentIterable<EmailAlias>	listAliasesInDomain(String domain) Get the set of details about e-mail aliases
com.google.common.collect.FluentIterable<EmailAccount>	listDomain(String domain) Get the set of detailed information about e-mail accounts
EmailAccount	update(String accountAddress, UpdateAccountOptions... options) Adjust an e-mail account's settings
EmailAlias	updateAlias(String aliasAddress, String toEmailAddress) Adjust (re-target) an e-mail alias

Method Detail

getOverview

@Named(value="email:overview")
 @POST
 @Path(value="/email/overview/format/json")
 @Consumes(value="application/json")
EmailOverview getOverview()

Get a summary of e-mail accounts associated with this Glesys account

Returns:

the relevant summary data

listDomain

@Named(value="email:list:accounts")
 @POST
 @Path(value="/email/list/format/json")
 @Consumes(value="application/json")
com.google.common.collect.FluentIterable<EmailAccount> listDomain(@FormParam(value="domainname")
                                                                                                                                                                                          String domain)

Get the set of detailed information about e-mail accounts

Returns:

the relevant set of details

listAliasesInDomain

@Named(value="email:list:aliases")
 @POST
 @Path(value="/email/list/format/json")
 @Consumes(value="application/json")
com.google.common.collect.FluentIterable<EmailAlias> listAliasesInDomain(@FormParam(value="domainname")
                                                                                                                                                                                                String domain)

Get the set of details about e-mail aliases

Returns:

the relevant set of details

createWithPassword

@Named(value="email:createaccount")
 @POST
 @Consumes(value="application/json")
 @Path(value="/email/createaccount/format/json")
EmailAccount createWithPassword(@FormParam(value="emailaccount")
                                                                                                                                                                 String accountAddress,
                                                                                                                                                                 @FormParam(value="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:

DomainApi.create(java.lang.String, org.jclouds.glesys.options.AddDomainOptions...)

createAlias

@Named(value="email:createalias")
 @POST
 @Consumes(value="application/json")
 @Path(value="/email/createalias/format/json")
EmailAlias createAlias(@FormParam(value="emailalias")
                                                                                                                                                    String aliasAddress,
                                                                                                                                                    @FormParam(value="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:

DomainApi.create(java.lang.String, org.jclouds.glesys.options.AddDomainOptions...)

update

@Named(value="email:editaccount")
 @POST
 @Consumes(value="application/json")
 @Path(value="/email/editaccount/format/json")
EmailAccount update(@FormParam(value="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(value="email:editalias")
 @POST
 @Consumes(value="application/json")
 @Path(value="/email/editalias/format/json")
EmailAlias updateAlias(@FormParam(value="emailalias")
                                                                                                                                                String aliasAddress,
                                                                                                                                                @FormParam(value="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(value="email:delete")
 @POST
 @Path(value="/email/delete/format/json")
boolean delete(@FormParam(value="email")
                                                                                             String accountAddress)

Delete an e-mail account or alias

Parameters:

accountAddress - the existing alias e-mail account or alias address