org.jclouds.glesys.features
Interface EmailAccountApi

public interface EmailAccountApi

Provides synchronous access to E-Mail requests.

Author:

Adam Lowe

See Also:

Method Summary

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")
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")
com.google.common.collect.FluentIterable<EmailAccount> listDomain(String domain)

Get the set of detailed information about e-mail accounts

Returns:

the relevant set of details

listAliasesInDomain

@Named(value="email:list:aliases")
com.google.common.collect.FluentIterable<EmailAlias> listAliasesInDomain(String domain)

Get the set of details about e-mail aliases

Returns:

the relevant set of details

createWithPassword

@Named(value="email:createaccount")
EmailAccount createWithPassword(String accountAddress,
                                      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")
EmailAlias createAlias(String aliasAddress,
                             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")
EmailAccount update(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")
EmailAlias updateAlias(String aliasAddress,
                             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")
boolean delete(String accountAddress)

Delete an e-mail account or alias

Parameters:

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