com.atlassian.jira.mail.util

Interface MailAttachmentsManager

All Known Implementing Classes:

MailAttachmentsManagerImpl

public interface MailAttachmentsManager

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
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(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 add image specified by path to email attachments.
String	inlineImages(String html) Tries to inline all the images specified by an IMG tag.

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

getImageUrl

String getImageUrl(String path)

Tries to add image specified by path to email attachments. Returns image cid link if succeeds or unchanged path if specified path cannot be added as attachment

Parameters:

path -

Returns:

inlineImages

String inlineImages(String html)

Tries to inline all the images specified by an IMG tag. Replaces the image url with the cid link or unchanged path if specified path cannot be added as attachment

Parameters:

html - HTML to change.

Returns:

The same HTML with the images inlined.

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

buildAttachmentsBodyParts

Iterable<javax.mail.BodyPart> buildAttachmentsBodyParts()

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

Returns:

Added attachments as list of BodyParts