org.jclouds.glesys.features

Interface EmailApi

public interface EmailApi

Provides synchronous access to E-Mail requests.

Author:

Adam Lowe

See Also:

EmailAsyncApi,

Method Summary

Methods

Modifier and Type	Method and Description
EmailAccount	createAccount(String accountAddress, String password, CreateAccountOptions... options) Create a new e-mail account
EmailAlias	createAlias(String aliasAddress, String toEmailAddress) Create an e-mail alias for an e-mail account
boolean	delete(String accountAddress) Delete an e-mail account or alias
EmailAccount	editAccount(String accountAddress, EditAccountOptions... options) Adjust an e-mail account's settings
EmailAlias	editAlias(String aliasAddress, String toEmailAddress) Adjust (re-target) an e-mail alias
EmailOverview	getEmailOverview() Get a summary of e-mail accounts associated with this Glesys account
Set<EmailAccount>	listAccounts(String domain) Get the set of detailed information about e-mail accounts
Set<EmailAlias>	listAliases(String domain) Get the set of details about e-mail aliases

Method Detail

getEmailOverview

EmailOverview getEmailOverview()

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

Returns:

the relevant summary data

listAccounts

Set<EmailAccount> listAccounts(String domain)

Get the set of detailed information about e-mail accounts

Returns:

the relevant set of details

listAliases

Set<EmailAlias> listAliases(String domain)

Get the set of details about e-mail aliases

Returns:

the relevant set of details

createAccount

EmailAccount createAccount(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.addDomain(java.lang.String, org.jclouds.glesys.options.AddDomainOptions...)

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.addDomain(java.lang.String, org.jclouds.glesys.options.AddDomainOptions...)

editAccount

EmailAccount editAccount(String accountAddress,
                       EditAccountOptions... options)

Adjust an e-mail account's settings

Parameters:

accountAddress - the existing e-mail account address

options - optional parameters

editAlias

EmailAlias editAlias(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

boolean delete(String accountAddress)

Delete an e-mail account or alias

Parameters:

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