com.atlassian.jira.mail.util

Interface MailAttachmentsManager

All Known Implementing Classes:

MailAttachmentsManagerImpl

@NonInjectableComponent
public interface MailAttachmentsManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	CID_PREFIX Content-ID for generated attachments.

Method Summary

Modifier and Type	Method and Description
String	addAttachmentAndReturnCid(MailAttachment mailAttachment) Adds an attachment to the mail attachments manager's collection of attachments.
Iterable<javax.mail.BodyPart>	buildAttachmentsBodyParts() Builds bodyPart for each image (including avatars) added to this manager
int	getAttachmentsCount() Returns the number of attachments added to this manager
String	getAvatarUrl(ApplicationUser user) Returns a link to access user avatar in email message.
String	getAvatarUrl(Avatar avatar, Avatar.Size size, String avatarOwnerDescription) Returns a link to access Avatar (icon for project or some other entity in Jira) in email message.
String	getAvatarUrl(String username) Returns a link to access user avatar in email message.
String	getAvatarUrl(TemplateUser templateUser) Returns a link to access user avatar in email message.
String	getExternalImageUrl(String path) If the path is a relative url tries to add the image specified as an attachment.
String	getImageUrl(String path) Tries to inline image specified by path and add it to email attachments or add JWT token
boolean	hasSecuredImage() Needed to attach/or not Use only after inlineImages(String) as it will count found images in rendered html.
String	inlineImages(String html) Deprecated. use processImages(String) instead. Will be removed in Jira 9.0 because name of this method no longer relevant. Removing this method will affect mail templates
String	processImages(String html) - Looks for tags and tries to inline image if it's an internal resource.
String	removeBaseUrl(String url) Tries to remove the baseUrl (eg: http://example.com/jira) or the basePath (/jira) from an URL, and return the result.

Field Detail

CID_PREFIX

static final String CID_PREFIX

Content-ID for generated attachments.

See Also:

Constant Field Values

Method Detail

getAvatarUrl

String getAvatarUrl(String username)

Returns a link to access user avatar in email message. If avatar can be attached to email, the cid link is returned, otherwise avatar URL is returned and no image is attached. (E.g. If Gravatar is enabled)

Parameters:

username -

Returns:

cid link or Avatar URL

getAvatarUrl

String getAvatarUrl(TemplateUser templateUser)

Returns a link to access user avatar in email message. If avatar can be attached to email, the cid link is returned, otherwise avatar URL is returned and no image is attached. (E.g. If Gravatar is enabled)

Parameters:

templateUser -

Returns:

cid link or Avatar URL

getAvatarUrl

String getAvatarUrl(ApplicationUser user)

Returns a link to access user avatar in email message. If avatar can be attached to email, the cid link is returned, otherwise avatar URL is returned and no image is attached. (E.g. If Gravatar is enabled)

Parameters:

user -

Returns:

cid link or Avatar URL

getAvatarUrl

String getAvatarUrl(@Nonnull
                    Avatar avatar,
                    @Nonnull
                    Avatar.Size size,
                    String avatarOwnerDescription)

Returns a link to access Avatar (icon for project or some other entity in Jira) in email message.

Parameters:

avatar - Avatar to display in email

size - avatar size

avatarOwnerDescription - Description of avatar

Returns:

cid link

addAttachmentAndReturnCid

String addAttachmentAndReturnCid(MailAttachment mailAttachment)

Adds an attachment to the mail attachments manager's collection of attachments. This collection will eventually be attached to the email. This method will return a CID that can be used to reference the attachment in the body of an email. Given the same mail attachment multiple times, this method will return the same CID.

Parameters:

mailAttachment -

Returns:

The CID for an attachment

getImageUrl

String getImageUrl(String path)

Tries to inline image specified by path and add it to email attachments or add JWT token

Parameters:

path -

Returns:

• image cid link if it's an internal resource
• image link appended with JWT token if it's /secure/thumbnail/* or /secure/attachment/*
• unchanged otherwise

removeBaseUrl

String removeBaseUrl(String url)

Tries to remove the baseUrl (eg: http://example.com/jira) or the basePath (/jira) from an URL, and return the result. Some quick examples (let's assume baseUrl = http://example.com/jira)

• http://example.com/jira/images/icon.png --> /images/icon.png
• /jira/images/icon.png --> /images/icon.png
• /images/icon.png --> /images/icon.png
• http://example.com/test/images/icon.png --> http://example.com/test/images/icon.png
• http://google.com/jira/images/icon.png --> http://google.com/jira/images/icon.png

Parameters:

url - the url to remove the baseUrl from

Returns:

the url without the baseUrl nor the basePath

inlineImages

@Deprecated
String inlineImages(String html)

Deprecated. use processImages(String) instead. Will be removed in Jira 9.0 because name of this method no longer relevant. Removing this method will affect mail templates

processImages

String processImages(String html)

- Looks for tags and tries to inline image if it's an internal resource. Otherwise adds JWT token for every /secure/* image or leaves unchanged for other paths.

- Counts how many images there are that start with /secure/* so hasSecuredImage() can calculate the result needed to construct email footer

- Adds default 'alt' attribute which is an attachment file name in case img has none

Parameters:

html - HTML to change.

Returns:

The same HTML with the images inlined or JWT tokens parameter added to images' src attribute.

getExternalImageUrl

String getExternalImageUrl(String path)

If the path is a relative url tries to add the image specified as an attachment. Returns a cid link if successful, or unchanged path if not

Since:

JIRA 6.3

getAttachmentsCount

int getAttachmentsCount()

Returns the number of attachments added to this manager

Returns:

number of attachments

hasSecuredImage

boolean hasSecuredImage()

Needed to attach/or not Use only after inlineImages(String) as it will count found images in rendered html.

Returns:

true when there is at least one image with contains /secure/* as src found in html

buildAttachmentsBodyParts

Iterable<javax.mail.BodyPart> buildAttachmentsBodyParts()

Builds bodyPart for each image (including avatars) added to this manager

Returns:

Added attachments as list of BodyParts