com.atlassian.mail

Interface MailThreader

public interface MailThreader

Used for maintaining thread information in sent emails.

Method Summary

Modifier and Type	Method and Description
String	getCustomMessageId(Email email) Allows this MailThreader to define a custom Message-ID to be set in the outgoing mail header.
void	storeSentEmail(Email email) Deprecated. Use getCustomMessageId(Email) instead to create a parsable custom Message ID. Since v2.5.0.
void	threadEmail(Email email) Set the In-Reply-To header for an email, so it will appear threaded.

Method Detail

threadEmail

void threadEmail(Email email)

Set the In-Reply-To header for an email, so it will appear threaded.

Parameters:

email - The unsent mail to alter

storeSentEmail

void storeSentEmail(Email email)

Deprecated. Use getCustomMessageId(Email) instead to create a parsable custom Message ID. Since v2.5.0.

Store the (MTA-allocated) Message-Id of a sent email, so later emails 'in reply to' this can be threaded.

This is considered a bad idea for scalability because it requires applications to store details of every single outgoing email. For example, see JRA-9979. If you need to recognise incoming "In-Reply-To" headers, then it is preferred to use getCustomMessageId(Email) to create a parsable custom Message ID.

Parameters:

email - The sent mail whose Message-ID we should record

getCustomMessageId

String getCustomMessageId(Email email)

Allows this MailThreader to define a custom Message-ID to be set in the outgoing mail header.

Returning null means let the library create one automatically.

Be aware that Message-IDs must be globally unique, and can only contain a limited subset of ASCII characters.

Do not include the angle-brackets in the returned ID - these will be added for you.

Parameters:

email - the unsent email

Returns:

the required custom Message-ID header, or null to let the library create one automatically.