public static class

EmailHeaderBuilders.MessageIdBuilder

extends Object
java.lang.Object
   ↳ com.atlassian.jira.mail.threading.EmailHeaderBuilders.MessageIdBuilder

Class Overview

Responsible for building the Message-Id string values to be included in JIRA's issue email notifications.

This has to be globally unique and can only contain certain ASCII characters. Used to distinguish between different emails. sequence and System.currentTimeMillis() are used to make the Message-ID unique.

JIRA.${issue-id.${created-date-millis}.${sequence-id}.${current-time-millis}@${host} }

These message-ids are parsed by getAssociatedIssueObject(javax.mail.Message)

Summary

Public Constructors
MessageIdBuilder(Issue issue)
Public Methods
String build()
sequence and hostname are required for this method to work, since they are needed for the returned String to be valid as a Message-ID for JIRA's purposes.
EmailHeaderBuilders.MessageIdBuilder setDropMillis(boolean dropMillis)
EmailHeaderBuilders.MessageIdBuilder setHostName(String hostName)
EmailHeaderBuilders.MessageIdBuilder setSequence(int sequence)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MessageIdBuilder (Issue issue)

Public Methods

public String build ()

sequence and hostname are required for this method to work, since they are needed for the returned String to be valid as a Message-ID for JIRA's purposes. It is important that the resulting String is NOT wrapped in angle brackets, even though email spec requires this, since this is the responsibility of the caller (in contrast to InReplyToHeaderBuilder).

Returns
  • a String representation of a Message-ID to be used as an email header value.

public EmailHeaderBuilders.MessageIdBuilder setDropMillis (boolean dropMillis)

public EmailHeaderBuilders.MessageIdBuilder setHostName (String hostName)

public EmailHeaderBuilders.MessageIdBuilder setSequence (int sequence)