com.google.gerrit.server.mail.send

Class SmtpEmailSender

java.lang.Object

com.google.gerrit.server.mail.send.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.Module

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildMultipartBody(java.lang.String boundary, java.lang.String textPart, java.lang.String htmlPart)
boolean	canEmail(java.lang.String address) Can the address receive messages from us?
static java.lang.String	generateMultipartBoundary(java.lang.String textBody, java.lang.String htmlBody)
boolean	isEnabled()
protected java.lang.String	quotedPrintableEncode(java.lang.String input)
void	send(com.google.gerrit.mail.Address from, java.util.Collection<com.google.gerrit.mail.Address> rcpt, java.util.Map<java.lang.String,com.google.gerrit.mail.EmailHeader> callerHeaders, java.lang.String body) Sends an email message with a text body only (i.e.
void	send(com.google.gerrit.mail.Address from, java.util.Collection<com.google.gerrit.mail.Address> rcpt, java.util.Map<java.lang.String,com.google.gerrit.mail.EmailHeader> callerHeaders, java.lang.String textBody, java.lang.String htmlBody) 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(com.google.gerrit.mail.Address from,
                 java.util.Collection<com.google.gerrit.mail.Address> rcpt,
                 java.util.Map<java.lang.String,com.google.gerrit.mail.EmailHeader> callerHeaders,
                 java.lang.String body)
          throws com.google.gerrit.exceptions.EmailException

Description copied from interface: EmailSender

Sends an email message with a text body only (i.e. not HTML or multipart).

Authors of new implementations of this interface should not use this method to send a message because this method does not accept the HTML body. Instead, authors should use the above signature of send.

This version of the method is preserved for support of legacy implementations.

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.exceptions.EmailException - the message cannot be sent.

send

public void send(com.google.gerrit.mail.Address from,
                 java.util.Collection<com.google.gerrit.mail.Address> rcpt,
                 java.util.Map<java.lang.String,com.google.gerrit.mail.EmailHeader> callerHeaders,
                 java.lang.String textBody,
                 java.lang.String htmlBody)
          throws com.google.gerrit.exceptions.EmailException

Description copied from interface: EmailSender

Sends an email message. Messages always contain a text body, but messages can optionally include an additional HTML body. If both body types are present, send should construct a multipart/alternative message with an appropriately-selected boundary.

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.

textBody - text to appear in the text/plain body of the message.

htmlBody - optional HTML code to appear in the text/html body of the message.

Throws:

com.google.gerrit.exceptions.EmailException - the message cannot be sent.

generateMultipartBoundary

public static java.lang.String generateMultipartBoundary(java.lang.String textBody,
                                                         java.lang.String htmlBody)
                                                  throws com.google.gerrit.exceptions.EmailException

Throws:

com.google.gerrit.exceptions.EmailException

buildMultipartBody

protected java.lang.String buildMultipartBody(java.lang.String boundary,
                                              java.lang.String textPart,
                                              java.lang.String htmlPart)
                                       throws java.io.IOException

Throws:

java.io.IOException

quotedPrintableEncode

protected java.lang.String quotedPrintableEncode(java.lang.String input)
                                          throws java.io.IOException

Throws:

java.io.IOException