com.atlassian.confluence.mail.template

Class ConfluenceMailQueueItem

java.lang.Object

com.atlassian.confluence.mail.template.ConfluenceMailQueueItem

All Implemented Interfaces:

com.atlassian.core.task.Task, com.atlassian.mail.queue.MailQueueItem, Serializable, Comparable<com.atlassian.mail.queue.MailQueueItem>

public class ConfluenceMailQueueItem
extends Object
implements com.atlassian.mail.queue.MailQueueItem

Simplified class to replace the somewhat confusing MailNotificationQueueItem hierarchy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIME_TYPE_HTML
static String	MIME_TYPE_TEXT

Constructor Summary

Constructors

Constructor and Description
ConfluenceMailQueueItem(String toAddress, String subject, String body, String mimeType)
ConfluenceMailQueueItem(String toAddress, String ccAddress, String subject, String body, String mimeType)
ConfluenceMailQueueItem(String toAddress, String ccAddress, String subject, String body, String mimeType, Collection<DataSource> attachedImages)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(com.atlassian.mail.queue.MailQueueItem o)
void	execute()
String	getBody()
Date	getDateQueued()
String	getFromAddress()
String	getFromName()
String	getLastError()
int	getSendCount()
String	getSubject()
boolean	hasError()
void	send()
void	setFromAddress(String fromAddress)
void	setFromName(String fromName)
void	setLogsLocation(String logsLocation)
void	setSendLogs(boolean sendLogs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIME_TYPE_HTML

public static final String MIME_TYPE_HTML

See Also:

Constant Field Values

MIME_TYPE_TEXT

public static final String MIME_TYPE_TEXT

See Also:

Constant Field Values

Constructor Detail

ConfluenceMailQueueItem

public ConfluenceMailQueueItem(String toAddress,
                       String subject,
                       String body,
                       String mimeType)

ConfluenceMailQueueItem

public ConfluenceMailQueueItem(String toAddress,
                       String ccAddress,
                       String subject,
                       String body,
                       String mimeType)

ConfluenceMailQueueItem

public ConfluenceMailQueueItem(String toAddress,
                       String ccAddress,
                       String subject,
                       String body,
                       String mimeType,
                       Collection<DataSource> attachedImages)

Method Detail

setSendLogs

public void setSendLogs(boolean sendLogs)

setLogsLocation

public void setLogsLocation(String logsLocation)

compareTo

public int compareTo(com.atlassian.mail.queue.MailQueueItem o)

Specified by:

compareTo in interface Comparable<com.atlassian.mail.queue.MailQueueItem>

send

public void send()
          throws com.atlassian.mail.MailException

Specified by:

send in interface com.atlassian.mail.queue.MailQueueItem

Throws:

com.atlassian.mail.MailException

getSubject

public String getSubject()

Specified by:

getSubject in interface com.atlassian.mail.queue.MailQueueItem

getDateQueued

public Date getDateQueued()

Specified by:

getDateQueued in interface com.atlassian.mail.queue.MailQueueItem

getSendCount

public int getSendCount()

Specified by:

getSendCount in interface com.atlassian.mail.queue.MailQueueItem

hasError

public boolean hasError()

Specified by:

hasError in interface com.atlassian.mail.queue.MailQueueItem

execute

public void execute()
             throws Exception

Specified by:

execute in interface com.atlassian.core.task.Task

Throws:

Exception

getLastError

public String getLastError()

getBody

public String getBody()

getFromAddress

public String getFromAddress()

Returns:

the address this mail item should appear to be from.

setFromAddress

public void setFromAddress(String fromAddress)

Parameters:

fromAddress - the address the resultant e-mail should appear to be from

getFromName

public String getFromName()

Returns:

the name of the sender the mail item should be from.

setFromName

public void setFromName(String fromName)

Parameters:

fromName - the name to use for the sender of the mail item.