opendev/gerrit
Code Issues Proposed changes

Add IMAP implementation for receiving emails

Browse Source 
This change adds code to retrieve and delete emails using IMAP and
extends the integration tests to cover IMAP as well using ConfigSuite.

Change-Id: I839744c2bb81247c1a38bdf8e39d2c5005e2940e
This commit is contained in:
Patrick Hiesel
2016-10-24 17:57:40 +02:00
parent 63eef7ae4e
commit a36e9d3a56
2 changed files with 120 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/server/mail/MailIT.java
View File

@@ -44,7 +44,6 @@ public class MailIT extends AbstractDaemonTest {
private final static String HOST = "localhost";
private final static String USERNAME = "user@domain.com";
private final static String PASSWORD = "password";
private final static String PROTOCOL = "POP3";
@Inject
private MailReceiver mailReceiver;
@@ -63,7 +62,19 @@ public class MailIT extends AbstractDaemonTest {
cfg.setString(RECEIVEEMAIL, null, "port", "3110");
cfg.setString(RECEIVEEMAIL, null, "username", USERNAME);
cfg.setString(RECEIVEEMAIL, null, "password", PASSWORD);
cfg.setString(RECEIVEEMAIL, null, "protocol", PROTOCOL);
cfg.setString(RECEIVEEMAIL, null, "protocol", "POP3");
cfg.setString(RECEIVEEMAIL, null, "fetchInterval", "99");
return cfg;
}
@ConfigSuite.Config
public static Config imapConfig() {
Config cfg = new Config();
cfg.setString(RECEIVEEMAIL, null, "host", HOST);
cfg.setString(RECEIVEEMAIL, null, "port", "3143");
cfg.setString(RECEIVEEMAIL, null, "username", USERNAME);
cfg.setString(RECEIVEEMAIL, null, "password", PASSWORD);
cfg.setString(RECEIVEEMAIL, null, "protocol", "IMAP");
cfg.setString(RECEIVEEMAIL, null, "fetchInterval", "99");
return cfg;
}

108
gerrit-server/src/main/java/com/google/gerrit/server/mail/receive/ImapMailReceiver.java
View File

@@ -15,11 +15,24 @@
package com.google.gerrit.server.mail.receive;
import com.google.gerrit.server.mail.EmailSettings;
import com.google.gerrit.server.mail.Encryption;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import org.apache.commons.net.imap.IMAPClient;
import org.apache.commons.net.imap.IMAPSClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
@Singleton
public class ImapMailReceiver extends MailReceiver {
private static final Logger log =
LoggerFactory.getLogger(ImapMailReceiver.class);
private static final String inboxFolder = "INBOX";
@Inject
public ImapMailReceiver(EmailSettings mailSettings) {
@@ -32,6 +45,99 @@ public class ImapMailReceiver extends MailReceiver {
*/
@Override
public synchronized void handleEmails() {
// TODO(hiesel) Implement.
IMAPClient imap;
if (mailSettings.encryption != Encryption.NONE) {
imap = new IMAPSClient(mailSettings.encryption.name(), false);
} else {
imap = new IMAPClient();
}
if (mailSettings.port > 0) {
imap.setDefaultPort(mailSettings.port);
}
// Set a 30s timeout for each operation
imap.setDefaultTimeout(30 * 1000);
try {
imap.connect(mailSettings.host);
try {
if (!imap.login(mailSettings.username, mailSettings.password)) {
log.error("Could not login to IMAP server");
return;
}
try {
if (!imap.select(inboxFolder)){
log.error("Could not select IMAP folder " + inboxFolder);
return;
}
// Fetch just the internal dates first to know how many messages we
// should fetch.
if (!imap.fetch("1:*", "(INTERNALDATE)")) {
log.error("IMAP fetch failed. Will retry in next fetch cycle.");
return;
}
// Format of reply is one line per email and one line to indicate
// that the fetch was successful.
// Example:
// * 1 FETCH (INTERNALDATE "Mon, 24 Oct 2016 16:53:22 +0200 (CEST)")
// * 2 FETCH (INTERNALDATE "Mon, 24 Oct 2016 16:53:22 +0200 (CEST)")
// AAAC OK FETCH completed.
int numMessages = imap.getReplyStrings().length - 1;
log.info("Fetched " + numMessages + " messages via IMAP");
if (numMessages == 0) {
return;
}
// Fetch the full version of all emails
List<MailMessage> mailMessages = new ArrayList<>(numMessages);
for (int i = 1; i <= numMessages; i++) {
if (imap.fetch(i + ":" + i, "(BODY.PEEK[])")) {
// Obtain full reply
String[] rawMessage = imap.getReplyStrings();
if (rawMessage.length < 2) {
continue;
}
// First and last line are IMAP status codes. We have already
// checked, that the fetch returned true (OK), so we safely ignore
// those two lines.
StringBuilder b = new StringBuilder(2 * (rawMessage.length - 2));
for(int j = 1; j < rawMessage.length - 1; j++) {
if (j > 1) {
b.append("\n");
}
b.append(rawMessage[j]);
}
try {
MailMessage mailMessage = RawMailParser.parse(b.toString());
if (pendingDeletion.contains(mailMessage.id())) {
// Mark message as deleted
if (imap.store(i + ":" + i, "+FLAGS", "(\\Deleted)")) {
pendingDeletion.remove(mailMessage.id());
} else {
log.error("Could not mark mail message as deleted: " +
mailMessage.id());
}
} else {
mailMessages.add(mailMessage);
}
} catch (MailParsingException e) {
log.error("Exception while parsing email after IMAP fetch", e);
}
} else {
log.error("IMAP fetch failed. Will retry in next fetch cycle.");
}
}
// Permanently delete emails marked for deletion
if (!imap.expunge()) {
log.error("Could not expunge IMAP emails");
}
// TODO(hiesel) Call email handling logic with mailMessages
} finally {
imap.logout();
}
} finally {
imap.disconnect();
}
} catch (IOException e) {
log.error("Error while talking to IMAP server", e);
return;
}
}
}