jetbrains.buildServer.notification

Interface MessageSender

All Superinterfaces:

ServerExtension, TeamCityExtension

public interface MessageSender
extends ServerExtension

Simple messenger extension point.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe() Returns name / description of this message sender (e.g.
java.lang.String	getAddress(SUser user) Returns address which can be used to send message to the specified user
void	sendMessage(java.lang.String shortSummary, java.lang.String message, java.util.Set<java.lang.String> recipients) Sends a message to specified recipients

Method Detail

sendMessage

void sendMessage(@Nullable
                 java.lang.String shortSummary,
                 @NotNull
                 java.lang.String message,
                 @NotNull
                 java.util.Set<java.lang.String> recipients)
          throws SendFailedException

Sends a message to specified recipients

Parameters:

shortSummary - message summary (e.g. subject for email), can be null

message - message text

recipients - collection of recipients

Throws:

SendFailedException - if failed to send message

getAddress

@Nullable
java.lang.String getAddress(@NotNull
                                      SUser user)

Returns address which can be used to send message to the specified user

Parameters:

user - recipient

Returns:

address or null if message sender can't send message to the specified user

describe

@NotNull
java.lang.String describe()

Returns name / description of this message sender (e.g. Email, Jabber and so on)

Returns:

see above