com.google.gerrit.server.mail

Class SmtpEmailSender

java.lang.Object

com.google.gerrit.server.mail.SmtpEmailSender

All Implemented Interfaces:

EmailSender

public class SmtpEmailSender
extends java.lang.Object
implements EmailSender

Sends email via a nearby SMTP server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmtpEmailSender.Encryption
static class	SmtpEmailSender.Module

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> callerHeaders, java.lang.String body) Sends an email message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface EmailSender

canEmail

public boolean canEmail(java.lang.String address)

Description copied from interface: EmailSender

Can the address receive messages from us?

Specified by:

canEmail in interface EmailSender

Parameters:

address - the address to consider.

Returns:

true if this sender will deliver to the address.

send

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

Description copied from interface: EmailSender

Sends an email message.

Specified by:

send in interface EmailSender

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.

callerHeaders - message headers.

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

Throws:

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