com.atlassian.confluence.plugins.emailgateway.api
Interface StagedEmailThreadAdminService

All Known Implementing Classes:
DefaultEmailThreadConverterService

@PublicApi
public interface StagedEmailThreadAdminService

Describes operations for managing existing StagedEmailThread objects.

Since:
5.3
See Also:
EmailStagingService

Method Summary
 int clearExpiredEmailThreads(org.joda.time.DateTime expiry)
          Deletes old email threads from the staging area.
<C extends ContentEntityObject>
C
convertAndPublishStagedEmailThread(StagedEmailThreadKey stagedEmailThreadKey, MessageHolder messageHolder, EmailToContentConverter<C> emailToContentConverter)
          Converts an existing StagedEmailThread into a Confluence Page and publishes it.
 void deleteStagedEmailThread(StagedEmailThreadKey stagedEmailThreadKey)
          Delete an existing StagedEmailThread from the store.
 

Method Detail

convertAndPublishStagedEmailThread

<C extends ContentEntityObject> C convertAndPublishStagedEmailThread(StagedEmailThreadKey stagedEmailThreadKey,
                                                                     MessageHolder messageHolder,
                                                                     EmailToContentConverter<C> emailToContentConverter)
Converts an existing StagedEmailThread into a Confluence Page and publishes it.

Parameters:
stagedEmailThreadKey - The key used to locate the StagedEmailThread
messageHolder - The collector for any status messages that should be shown to the user
emailToContentConverter - The converter to use in publishing the staged email
Returns:
A representation of the newly published content
Throws:
java.lang.IllegalArgumentException - If no StagedEmailThread can be found for the given StagedEmailThreadKey

deleteStagedEmailThread

void deleteStagedEmailThread(StagedEmailThreadKey stagedEmailThreadKey)
Delete an existing StagedEmailThread from the store.

Parameters:
stagedEmailThreadKey - The key used to locate the StagedEmailThread

clearExpiredEmailThreads

int clearExpiredEmailThreads(org.joda.time.DateTime expiry)
Deletes old email threads from the staging area.

Parameters:
expiry - the cut-off date for which any threads older will be deleted
Returns:
the number of threads removed


Copyright © 2003-2014 Atlassian. All Rights Reserved.