org.apache.james.services
Interface JamesUser

All Superinterfaces:

User

All Known Implementing Classes:

DefaultJamesUser

public interface JamesUser

extends User

Interface for objects representing users of an email/ messaging system.

Version:

$Revision: 1.9 $

Author:

Charles Benett

Method Summary

String	getAlias() Get local address to which mail should be delivered.
boolean	getAliasing() Return true if emails should be delivered locally to an alias.
boolean	getForwarding() Return true if mail for this user should be forwarded
MailAddress	getForwardingDestination() Return the destination to which email should be forwarded
boolean	setAlias(String address) Set local address to which email should be delivered.
void	setAliasing(boolean alias) Indicate if mail received for this user should be delivered locally to a different address.
void	setForwarding(boolean forward) Indicate if mail for this user should be forwarded to some other mail server.
boolean	setForwardingDestination(MailAddress address) Set destination for forwading mail TODO: Should we use a MailAddress?
boolean	setPassword(String pass) Change password to pass.

Methods inherited from interface org.apache.james.services.User

getUserName, verifyPassword

Method Detail

setPassword

public boolean setPassword(String pass)

Change password to pass. Return true if successful.

Specified by:

setPassword in interface User

Parameters:

pass - the new password

Returns:

true if successful, false otherwise

setForwarding

public void setForwarding(boolean forward)

Indicate if mail for this user should be forwarded to some other mail server.

Parameters:

forward - whether email for this user should be forwarded

getForwarding

public boolean getForwarding()

Return true if mail for this user should be forwarded

setForwardingDestination

public boolean setForwardingDestination(MailAddress address)

Set destination for forwading mail

TODO: Should we use a MailAddress?

Parameters:

address - the forwarding address for this user

getForwardingDestination

public MailAddress getForwardingDestination()

Return the destination to which email should be forwarded

setAliasing

public void setAliasing(boolean alias)

Indicate if mail received for this user should be delivered locally to a different address.

getAliasing

public boolean getAliasing()

Return true if emails should be delivered locally to an alias.

setAlias

public boolean setAlias(String address)

Set local address to which email should be delivered.

Returns:

true if successful

getAlias

public String getAlias()

Get local address to which mail should be delivered.