Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.atlassian.bamboo.emailer.strategy
Interface EmailStrategy

All Known Implementing Classes:
  AbstractEmailStrategy, AlwaysEmailStrategy, EmailErrorsAndFirstSuccessfulBuildStrategy, LegacyAbstractEmailStrategy, LegacyAlwaysEmailStrategy, LegacyEmailErrorsAndFirstSuccessfulBuildStrategy, LegacyNeverEmailStrategy, NeverEmailStrategy

    public interface EmailStrategy

Defines a strategy for deciding if Bamboo should email the build results.

Method Summary
`String` | `getLabel()` Obtain a description of the strategy for displaying in the GUI
`String` | `getName()` Used to identify the strategy within the UI
`boolean` | `shouldEmailBuildResults(BuildResults buildResults, BuildState previousBuildState)` Should we email the given buildResults, based on the previousBuildState?

Method Detail

### getLabel

    String getLabel()

  Obtain a description of the strategy for displaying in the GUI

  Returns:
    the descriptive label for the GUI

### getName

    String getName()

  Used to identify the strategy within the UI

  Returns:
    The name

### shouldEmailBuildResults

    boolean shouldEmailBuildResults(BuildResults buildResults,
                                    BuildState previousBuildState)

  Should we email the given buildResults, based on the previousBuildState?

  Parameters:
    `buildResults` - The build results to email
    `previousBuildState` - The status of the previous build
  Returns:
    true iff the email should be sent

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 Atlassian Software Systems. All Rights Reserved.