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: 494012 $

Method Summary
 java.lang.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(java.lang.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(java.lang.String pass)
          Change password to pass.
 
Methods inherited from interface org.apache.james.services.User
getUserName, verifyPassword
 

Method Detail

setPassword

boolean setPassword(java.lang.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

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

boolean getForwarding()
Return true if mail for this user should be forwarded


setForwardingDestination

boolean setForwardingDestination(MailAddress address)

Set destination for forwading mail

TODO: Should we use a MailAddress?

Parameters:
address - the forwarding address for this user

getForwardingDestination

MailAddress getForwardingDestination()
Return the destination to which email should be forwarded


setAliasing

void setAliasing(boolean alias)
Indicate if mail received for this user should be delivered locally to a different address.


getAliasing

boolean getAliasing()
Return true if emails should be delivered locally to an alias.


setAlias

boolean setAlias(java.lang.String address)
Set local address to which email should be delivered.

Returns:
true if successful

getAlias

java.lang.String getAlias()
Get local address to which mail should be delivered.



Copyright © 2002-2007 The Apache Software Foundation. All Rights Reserved.