com.atlassian.confluence.plugins.dailysummary.components
Interface SummaryEmailService

All Known Implementing Classes:

DefaultSummaryEmailService

public interface SummaryEmailService

Method Summary

Map	getContext(com.atlassian.user.User user, Date date) Exposes the context required to render the daily summary email.
void	sendEmail(com.atlassian.user.User user, Date date) Send a summary email to a user with content generate with respect to the given date.
int	sendEmailForDate(Date date) Send email to any users that have mail enabled for the specific datetime.

Method Detail

sendEmailForDate

int sendEmailForDate(Date date)

Send email to any users that have mail enabled for the specific datetime. Content is generated with respect to the given date and the users preferences for the period of time that they would like to receive the email (weekly or daily)

Parameters:

date -

Returns:

the number of emails processed successfully

sendEmail

void sendEmail(com.atlassian.user.User user,
               Date date)

Send a summary email to a user with content generate with respect to the given date.

Parameters:

user -

date -

getContext

Map getContext(com.atlassian.user.User user,
               Date date)

Exposes the context required to render the daily summary email. This allows the email template to be rendered within confluence.

Parameters:

user -

date -

Returns: