@PublicApi
public interface EmailFormatter
Modifier and Type | Method and Description |
---|---|
boolean |
emailVisible(ApplicationUser currentUser)
Returns whether or not email addresses are visible to this user, as determined by the
APKeys.JIRA_OPTION_EMAIL_VISIBLE setting. |
String |
formatEmail(ApplicationUser user,
ApplicationUser currentUser)
Formats
user 's email address for the purpose of displaying it to currentUser ,
as determined by the
APKeys.JIRA_OPTION_EMAIL_VISIBLE setting. |
String |
formatEmail(String email,
ApplicationUser currentUser)
Formats an email address for the purpose of displaying it to a user
as determined by the
APKeys.JIRA_OPTION_EMAIL_VISIBLE setting. |
String |
formatEmail(String email,
boolean isCurrentUserLoggedIn)
Formats an email address for the purpose of displaying it to a user
as determined by the
APKeys.JIRA_OPTION_EMAIL_VISIBLE setting. |
String |
formatEmailAsLink(String email,
ApplicationUser currentUser)
Returns email address as HTML links, if appropriate.
|
boolean emailVisible(@Nullable ApplicationUser currentUser)
APKeys.JIRA_OPTION_EMAIL_VISIBLE
setting.currentUser
- the user to which email addresses will be shown, or null
if
no user is logged in (browsing anonymously)true
if email addresses should be visible (even if they will be masked);
false
otherwise@Nullable String formatEmail(@Nullable ApplicationUser user, @Nullable ApplicationUser currentUser)
user
's email address for the purpose of displaying it to currentUser
,
as determined by the
APKeys.JIRA_OPTION_EMAIL_VISIBLE
setting.
This convenience method is exactly equivalent to
formatEmail(user.getEmailAddress(), currentUser != null)
,
except that it is null
-safe.
user
- owner of the email address to format and display (null
is permitted)currentUser
- the user to which email addresses will be shown, or null
if
no user is logged in (browsing anonymously)null
if either user
is null
or currentUser
is not permitted to see email addresses@Nullable String formatEmail(@Nullable String email, boolean isCurrentUserLoggedIn)
APKeys.JIRA_OPTION_EMAIL_VISIBLE
setting.
Setting | Behaviour |
---|---|
"show" | The email is shown as-is to everyone. |
"user" | The email is shown as-is to users that are logged in, but not shown to anonymous users. |
"mask" | The email is shown to all users with the
e-mail address slightly obscured, such that "user@example.com" appears
as "user at example dot com" , instead |
email
- The email address to show/mask/hide.isCurrentUserLoggedIn
- true
if a user is currently logged in; false
if the user is browsing anonymouslynull
if either email
is null
or the user is not permitted to see email addresses@Nullable String formatEmail(@Nullable String email, @Nullable ApplicationUser currentUser)
APKeys.JIRA_OPTION_EMAIL_VISIBLE
setting.
This convenience method is exactly equivalent to
formatEmail(email, currentUser != null)
.
email
- The email address to show/mask/hide.currentUser
- The user viewing the email address.null
if either email
is null
or the user is not permitted to see email addresses@Nonnull String formatEmailAsLink(String email, @Nullable ApplicationUser currentUser)
<a href="foo@bar.com">foo@bar.com</a>
(public),
foo at bar.com
(masked), or
an empty string (""
) if either email
is null
or the user is not permitted to see email addressesCopyright © 2002-2021 Atlassian. All Rights Reserved.