com.google.gerrit.server.mail

Interface EmailSender

All Known Implementing Classes:

SmtpEmailSender

public interface EmailSender

Sends email messages to third parties.

Method Summary

Modifier and Type	Method and Description
boolean	canEmail(java.lang.String address) Can the address receive messages from us?
boolean	isEnabled()
void	send(Address from, java.util.Collection<Address> rcpt, java.util.Map<java.lang.String,EmailHeader> headers, java.lang.String body) Sends an email message.

Method Detail

isEnabled

boolean isEnabled()

canEmail

boolean canEmail(java.lang.String address)

Can the address receive messages from us?

Parameters:

address - the address to consider.

Returns:

true if this sender will deliver to the address.

send

void send(Address from,
          java.util.Collection<Address> rcpt,
          java.util.Map<java.lang.String,EmailHeader> headers,
          java.lang.String body)
   throws com.google.gerrit.common.errors.EmailException

Sends an email message.

Parameters:

from - who the message is from.

rcpt - one or more address where the message will be delivered to. This list overrides any To or CC headers in headers.

headers - message headers.

body - text to appear in the body of the message.

Throws:

com.google.gerrit.common.errors.EmailException - the message cannot be sent.