com.atlassian.jira.util
Interface EmailFormatter

All Known Implementing Classes:
EmailFormatterImpl

public interface EmailFormatter

Returned email address appropriately masked/hidden for the current user.


Method Summary
 boolean emailVisible(com.opensymphony.user.User user)
           
 java.lang.String formatEmail(java.lang.String email, boolean isCurrentUserLoggedIn)
          Potentially hide/mask an email address.
 java.lang.String formatEmail(java.lang.String email, com.opensymphony.user.User currentUser)
          Potentially hide/mask an email address.
 java.lang.String formatEmail(com.opensymphony.user.User user, com.opensymphony.user.User currentUser)
          Formats how the user's Email address is to be displayed to the currentUser determined by the user email visibility value
 java.lang.String formatEmailAsLink(java.lang.String email, com.opensymphony.user.User currentUser)
          Returns email address as HTML.
 

Method Detail

emailVisible

boolean emailVisible(com.opensymphony.user.User user)

formatEmail

java.lang.String formatEmail(com.opensymphony.user.User user,
                             com.opensymphony.user.User currentUser)
Formats how the user's Email address is to be displayed to the currentUser determined by the user email visibility value

Parameters:
user - owner of the email address to format and display
currentUser - the current logged in user viewing the email address of the above user
Returns:
String - formatted email address, or null if currentUser is not allowed to view it

formatEmail

java.lang.String formatEmail(java.lang.String email,
                             boolean isCurrentUserLoggedIn)
Potentially hide/mask an email address.

Parameters:
email - The email address to show/mask/hide.
isCurrentUserLoggedIn - is the current user logged in or anonymous
Returns:
String - formatted email address, or null if currentUser is not allowed to view it

formatEmail

java.lang.String formatEmail(java.lang.String email,
                             com.opensymphony.user.User currentUser)
Potentially hide/mask an email address.

Parameters:
email - The email address to show/mask/hide.
currentUser - The user viewing the email address.
Returns:
The email address, possibly masked, or null if the user is not allowed to view it.

formatEmailAsLink

java.lang.String formatEmailAsLink(java.lang.String email,
                                   com.opensymphony.user.User currentUser)
Returns email address as HTML.

Returns:
<a href="foo@bar.com">foo@bar.com</a> (public), <a href="foo at bar.com">foo at bar.com</a> (masked), or "" (hidden).


Copyright © 2002-2010 Atlassian. All Rights Reserved.