Progress on IMAP implementation : list folders, some fetch orders

git-svn-id: http://svn.code.sf.net/p/davmail/code/trunk@301 3d1905a2-6b24-0410-a738-b14d5a86fcbd
This commit is contained in:
mguessan 2009-01-23 00:59:41 +00:00
parent 66029f92cb
commit 09de523391
4 changed files with 229 additions and 82 deletions

View File

@ -81,7 +81,6 @@ public class ExchangeSession {
*/ */
private String mailPath; private String mailPath;
private String email; private String email;
private String currentFolderUrl;
private WebdavResource wdr = null; private WebdavResource wdr = null;
private final ExchangeSessionFactory.PoolKey poolKey; private final ExchangeSessionFactory.PoolKey poolKey;
@ -367,8 +366,6 @@ public class ExchangeSession {
wdr.setPath(mailPath); wdr.setPath(mailPath);
getWellKnownFolders(); getWellKnownFolders();
// set current folder to Inbox // set current folder to Inbox
selectFolder("INBOX");
wdr.setPath(URIUtil.getPath(inboxUrl)); wdr.setPath(URIUtil.getPath(inboxUrl));
} catch (AuthenticationException exc) { } catch (AuthenticationException exc) {
@ -437,19 +434,6 @@ public class ExchangeSession {
); );
} }
/**
* Create message in current folder
*
* @param messageName message name
* @param bcc blind carbon copy header
* @param messageBody mail body
* @param allowOverwrite allow existing message overwrite
* @throws java.io.IOException when unable to create message
*/
public void createMessage(String messageName, String bcc, String messageBody, boolean allowOverwrite) throws IOException {
createMessage(currentFolderUrl, messageName, bcc, messageBody, allowOverwrite);
}
/** /**
* Create message in specified folder. * Create message in specified folder.
* Will overwrite an existing message with same subject in the same folder * Will overwrite an existing message with same subject in the same folder
@ -550,13 +534,14 @@ public class ExchangeSession {
} }
public List<Message> getAllMessages() throws IOException { public List<Message> getAllMessages(String folderName) throws IOException {
String folderUrl = getFolderPath(folderName);
List<Message> messages = new ArrayList<Message>(); List<Message> messages = new ArrayList<Message>();
String searchRequest = "Select \"DAV:uid\", \"http://schemas.microsoft.com/mapi/proptag/x0e080003\"" + String searchRequest = "Select \"DAV:uid\", \"http://schemas.microsoft.com/mapi/proptag/x0e080003\"" +
" FROM Scope('SHALLOW TRAVERSAL OF \"" + currentFolderUrl + "\"')\n" + " FROM Scope('SHALLOW TRAVERSAL OF \"" + folderUrl + "\"')\n" +
" WHERE \"DAV:ishidden\" = False AND \"DAV:isfolder\" = False\n" + " WHERE \"DAV:ishidden\" = False AND \"DAV:isfolder\" = False\n" +
" ORDER BY \"urn:schemas:httpmail:date\" ASC"; " ORDER BY \"urn:schemas:httpmail:date\" ASC";
Enumeration folderEnum = DavGatewayHttpClientFacade.executeSearchMethod(wdr.retrieveSessionInstance(), currentFolderUrl, searchRequest); Enumeration folderEnum = DavGatewayHttpClientFacade.executeSearchMethod(wdr.retrieveSessionInstance(), folderUrl, searchRequest);
while (folderEnum.hasMoreElements()) { while (folderEnum.hasMoreElements()) {
ResponseEntity entity = (ResponseEntity) folderEnum.nextElement(); ResponseEntity entity = (ResponseEntity) folderEnum.nextElement();
@ -567,6 +552,65 @@ public class ExchangeSession {
return messages; return messages;
} }
public List<Folder> getSubFolders(String folderName) throws IOException {
List<Folder> folders = new ArrayList<Folder>();
String searchRequest = "Select \"DAV:nosubs\", \"DAV:hassubs\"," +
" \"DAV:hassubs\",\"urn:schemas:httpmail:unreadcount\"" +
" FROM Scope('SHALLOW TRAVERSAL OF \"" + getFolderPath(folderName) + "\"')\n" +
" WHERE \"DAV:ishidden\" = False AND \"DAV:isfolder\" = True \n";
Enumeration folderEnum = DavGatewayHttpClientFacade.executeSearchMethod(wdr.retrieveSessionInstance(), mailPath, searchRequest);
while (folderEnum.hasMoreElements()) {
ResponseEntity entity = (ResponseEntity) folderEnum.nextElement();
folders.add(buildFolder(entity));
}
return folders;
}
protected Folder buildFolder(ResponseEntity entity) throws URIException {
String href = URIUtil.decode(entity.getHref());
Folder folder = new Folder();
Enumeration enumeration = entity.getProperties();
while (enumeration.hasMoreElements()) {
Property property = (Property) enumeration.nextElement();
if ("hassubs".equals(property.getLocalName())) {
folder.hasChildren = "1".equals(property.getPropertyAsString());
}
if ("nosubs".equals(property.getLocalName())) {
folder.noInferiors = "1".equals(property.getPropertyAsString());
}
if ("objectcount".equals(property.getLocalName())) {
folder.objectCount = Integer.parseInt(property.getPropertyAsString());
}
if ("unreadcount".equals(property.getLocalName())) {
folder.unreadCount = Integer.parseInt(property.getPropertyAsString());
}
}
if (href.endsWith("/")) {
href = href.substring(0, href.length()-1);
}
// replace well known folder names
if (href.startsWith(inboxUrl)) {
folder.folderUrl = href.replaceFirst(inboxUrl, "INBOX");
} else if (href.startsWith(sentitemsUrl)) {
folder.folderUrl = href.replaceFirst(sentitemsUrl, "Sent");
} else if (href.startsWith(draftsUrl)) {
folder.folderUrl = href.replaceFirst(draftsUrl, "Drafts");
} else if (href.startsWith(deleteditemsUrl)) {
folder.folderUrl = href.replaceFirst(deleteditemsUrl, "Trash");
} else {
int index = href.indexOf(mailPath.substring(0, mailPath.length()-1));
if (index >= 0) {
folder.folderUrl = href.substring(index + mailPath.length());
} else {
throw new URIException("Invalid folder url: " + folder.folderUrl);
}
}
return folder;
}
/** /**
* Delete oldest messages in trash. * Delete oldest messages in trash.
* keepDelay is the number of days to keep messages in trash before delete * keepDelay is the number of days to keep messages in trash before delete
@ -676,6 +720,25 @@ public class ExchangeSession {
} }
public String getFolderPath(String folderName) {
String folderPath;
if (folderName.startsWith("INBOX")) {
folderPath = folderName.replaceFirst("INBOX", inboxUrl);
} else if (folderName.startsWith("Trash")) {
folderPath = folderName.replaceFirst("Trash", deleteditemsUrl);
} else if (folderName.startsWith("Drafts")) {
folderPath = folderName.replaceFirst("Drafts", draftsUrl);
} else if (folderName.startsWith("Sent")) {
folderPath = folderName.replaceFirst("Sent", sentitemsUrl);
// absolute folder path
} else if (folderName != null && folderName.startsWith("/")) {
folderPath = folderName;
} else {
folderPath = mailPath + folderName;
}
return folderPath;
}
/** /**
* Select current folder. * Select current folder.
* Folder name can be logical names INBOX, DRAFTS or TRASH (translated to local names), * Folder name can be logical names INBOX, DRAFTS or TRASH (translated to local names),
@ -685,51 +748,40 @@ public class ExchangeSession {
* @return Folder object * @return Folder object
* @throws IOException when unable to change folder * @throws IOException when unable to change folder
*/ */
public Folder selectFolder(String folderName) throws IOException { public Folder getFolder(String folderName) throws IOException {
Folder folder = new Folder(); Folder folder = new Folder();
folder.folderUrl = null; folder.folderUrl = getFolderPath(folderName);
if ("INBOX".equals(folderName)) {
folder.folderUrl = inboxUrl;
} else if ("TRASH".equals(folderName)) {
folder.folderUrl = deleteditemsUrl;
} else if ("DRAFTS".equals(folderName)) {
folder.folderUrl = draftsUrl;
// absolute folder path
} else if (folderName != null && folderName.startsWith("/")) {
folder.folderUrl = folderName;
} else {
folder.folderUrl = mailPath + folderName;
}
Vector<String> reqProps = new Vector<String>(); Vector<String> reqProps = new Vector<String>();
reqProps.add("DAV:hassubs");
reqProps.add("DAV:nosubs");
reqProps.add("DAV:objectcount");
reqProps.add("urn:schemas:httpmail:unreadcount"); reqProps.add("urn:schemas:httpmail:unreadcount");
reqProps.add("DAV:childcount");
Enumeration folderEnum = wdr.propfindMethod(folder.folderUrl, 0, reqProps); Enumeration folderEnum = wdr.propfindMethod(folder.folderUrl, 0, reqProps);
if (folderEnum.hasMoreElements()) { if (folderEnum.hasMoreElements()) {
ResponseEntity entity = (ResponseEntity) folderEnum.nextElement(); ResponseEntity entity = (ResponseEntity) folderEnum.nextElement();
Enumeration propertiesEnum = entity.getProperties(); folder = buildFolder(entity);
while (propertiesEnum.hasMoreElements()) { }
Property prop = (Property) propertiesEnum.nextElement();
if ("unreadcount".equals(prop.getLocalName())) {
folder.unreadCount = Integer.parseInt(prop.getPropertyAsString());
}
if ("childcount".equals(prop.getLocalName())) {
folder.childCount = Integer.parseInt(prop.getPropertyAsString());
}
}
} else {
throw new IOException("Folder not found: " + folder.folderUrl);
}
currentFolderUrl = folder.folderUrl;
return folder; return folder;
} }
public static class Folder { public static class Folder {
public String folderUrl; public String folderUrl;
public int childCount; public int objectCount;
public int unreadCount; public int unreadCount;
public boolean hasChildren;
public boolean noInferiors;
public String getFlags() {
if (noInferiors) {
return "\\NoInferiors";
} else if (hasChildren) {
return "\\HasChildren";
} else {
return "\\HasNoChildren";
}
}
} }
public class Message { public class Message {

View File

@ -1,6 +1,8 @@
package davmail.imap; package davmail.imap;
import java.net.Socket; import java.net.Socket;
import java.net.SocketTimeoutException;
import java.net.SocketException;
import java.util.StringTokenizer; import java.util.StringTokenizer;
import java.util.List; import java.util.List;
import java.io.IOException; import java.io.IOException;
@ -9,6 +11,8 @@ import davmail.AbstractConnection;
import davmail.tray.DavGatewayTray; import davmail.tray.DavGatewayTray;
import davmail.exchange.ExchangeSession; import davmail.exchange.ExchangeSession;
import davmail.exchange.ExchangeSessionFactory; import davmail.exchange.ExchangeSessionFactory;
import com.sun.mail.imap.protocol.BASE64MailboxEncoder;
import com.sun.mail.imap.protocol.BASE64MailboxDecoder;
/** /**
* Dav Gateway smtp connection implementation. * Dav Gateway smtp connection implementation.
@ -18,6 +22,9 @@ public class ImapConnection extends AbstractConnection {
protected static final int INITIAL = 0; protected static final int INITIAL = 0;
protected static final int AUTHENTICATED = 1; protected static final int AUTHENTICATED = 1;
ExchangeSession.Folder currentFolder;
List<ExchangeSession.Message> messages;
// Initialize the streams and start the thread // Initialize the streams and start the thread
public ImapConnection(Socket clientSocket) { public ImapConnection(Socket clientSocket) {
super("ImapConnection", clientSocket, null); super("ImapConnection", clientSocket, null);
@ -27,7 +34,7 @@ public class ImapConnection extends AbstractConnection {
String line; String line;
StringTokenizer tokens; StringTokenizer tokens;
try { try {
sendClient("* OK Davmail Imap Server ready"); sendClient("* OK [CAPABILITY IMAP4REV1 AUTH=LOGIN] IMAP4rev1 DavMail server ready");
for (; ;) { for (; ;) {
line = readClient(); line = readClient();
// unable to read line, connection closed ? // unable to read line, connection closed ?
@ -35,7 +42,17 @@ public class ImapConnection extends AbstractConnection {
break; break;
} }
tokens = new StringTokenizer(line); tokens = new StringTokenizer(line) {
public String nextToken() {
StringBuilder nextToken = new StringBuilder();
nextToken.append(super.nextToken());
while (hasMoreTokens() && nextToken.length() > 0 && nextToken.charAt(0) == '"'
&& nextToken.charAt(nextToken.length() - 1) != '"') {
nextToken.append(' ').append(super.nextToken());
}
return nextToken.toString();
}
};
if (tokens.hasMoreTokens()) { if (tokens.hasMoreTokens()) {
String commandId = tokens.nextToken(); String commandId = tokens.nextToken();
if (tokens.hasMoreTokens()) { if (tokens.hasMoreTokens()) {
@ -43,11 +60,10 @@ public class ImapConnection extends AbstractConnection {
if ("LOGOUT".equalsIgnoreCase(command)) { if ("LOGOUT".equalsIgnoreCase(command)) {
sendClient("* BYE Closing connection"); sendClient("* BYE Closing connection");
sendClient(commandId + " OK Completed");
break; break;
} }
if ("capability".equalsIgnoreCase(command)) { if ("capability".equalsIgnoreCase(command)) {
sendClient("* CAPABILITY IMAP4REV1"); sendClient("* CAPABILITY IMAP4REV1 AUTH=LOGIN");
sendClient(commandId + " OK CAPABILITY completed"); sendClient(commandId + " OK CAPABILITY completed");
} else if ("login".equalsIgnoreCase(command)) { } else if ("login".equalsIgnoreCase(command)) {
parseCredentials(tokens); parseCredentials(tokens);
@ -60,45 +76,103 @@ public class ImapConnection extends AbstractConnection {
sendClient(commandId + " NO LOGIN failed"); sendClient(commandId + " NO LOGIN failed");
state = INITIAL; state = INITIAL;
} }
} else if ("AUTHENTICATE".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens()) {
String authenticationMethod = tokens.nextToken();
if ("LOGIN".equalsIgnoreCase(authenticationMethod)) {
sendClient("+ " + base64Encode("Username:"));
userName = base64Decode(readClient());
sendClient("+ " + base64Encode("Password:"));
password = base64Decode(readClient());
try {
session = ExchangeSessionFactory.getInstance(userName, password);
sendClient(commandId + " OK Authenticated");
state = AUTHENTICATED;
} catch (Exception e) {
DavGatewayTray.error(e);
sendClient(commandId + " NO LOGIN failed");
state = INITIAL;
}
} else {
sendClient(commandId + " NO unsupported authentication method");
}
} else {
sendClient(commandId + " BAD authentication method required");
}
} else { } else {
if (state != AUTHENTICATED) { if (state != AUTHENTICATED) {
sendClient(commandId + " BAD command authentication required"); sendClient(commandId + " BAD command authentication required");
} else { } else {
if ("lsub".equalsIgnoreCase(command)) { if ("lsub".equalsIgnoreCase(command)) {
/* TODO : implement
2 lsub "" "*"
* LSUB () "/" INBOX/sent-mail
* LSUB () "/" Trash
* LSUB () "/" INBOX/spam
* LSUB () "/" Envoy&AOk-s
* LSUB () "/" Drafts
2 OK LSUB completed
*/
sendClient(commandId + " OK LSUB completed"); sendClient(commandId + " OK LSUB completed");
} else if ("list".equalsIgnoreCase(command)) { } else if ("list".equalsIgnoreCase(command)) {
/* TODO : implement
*/
sendClient(commandId + " OK LIST completed");
} else if ("select".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens()) { if (tokens.hasMoreTokens()) {
String folderName = removeQuotes(tokens.nextToken()); String folderContext = BASE64MailboxDecoder.decode(removeQuotes(tokens.nextToken()));
ExchangeSession.Folder folder = session.selectFolder(folderName); if (tokens.hasMoreTokens()) {
sendClient("* " + folder.childCount + " EXISTS"); String folderQuery = folderContext + BASE64MailboxDecoder.decode(removeQuotes(tokens.nextToken()));
sendClient("* " + folder.unreadCount + " RECENT"); if (folderQuery.endsWith("%")) {
// TODO : implement, compute session message ids List<ExchangeSession.Folder> folders = session.getSubFolders(folderQuery.substring(0, folderQuery.length() - 1));
//sendClient("* [UNSEEN 1] first unseen message in inbox"); for (ExchangeSession.Folder folder : folders) {
sendClient(commandId + " OK [READ-WRITE] SELECT completed"); sendClient("* LIST (" + folder.getFlags() + ") \"/\" \"" + BASE64MailboxEncoder.encode(folder.folderUrl) + "\"");
}
sendClient(commandId + " OK LIST completed");
} else {
ExchangeSession.Folder folder = session.getFolder(folderQuery);
if (folder != null) {
sendClient("* LIST (" + folder.getFlags() + ") \"/\" \"" + BASE64MailboxEncoder.encode(folder.folderUrl) + "\"");
sendClient(commandId + " OK LIST completed");
} else {
sendClient(commandId + " NO Folder not found");
}
}
} else {
sendClient(commandId + " BAD missing folder argument");
}
} else {
sendClient(commandId + " BAD missing folder argument");
}
} else if ("select".equalsIgnoreCase(command) || "examine".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens()) {
String folderName = BASE64MailboxDecoder.decode(removeQuotes(tokens.nextToken()));
currentFolder = session.getFolder(folderName);
messages = session.getAllMessages(currentFolder.folderUrl);
sendClient("* " + currentFolder.objectCount + " EXISTS");
sendClient("* " + currentFolder.objectCount + " RECENT");
sendClient("* OK [UIDVALIDITY " + System.currentTimeMillis() + "]");
sendClient("* OK [UIDNEXT " + (currentFolder.objectCount + 1) + "]");
sendClient("* FLAGS (\\Answered \\Deleted \\Draft \\Flagged \\Seen)");
sendClient("* OK [PERMANENTFLAGS (\\Answered \\Deleted \\Draft \\Flagged \\Seen)]");
sendClient("* [UNSEEN 1] first unseen message in inbox");
sendClient(commandId + " OK [READ-WRITE] " + command + " completed");
} else { } else {
sendClient(commandId + " BAD command unrecognized"); sendClient(commandId + " BAD command unrecognized");
} }
} else if ("close".equalsIgnoreCase(command)) {
currentFolder = null;
messages = null;
sendClient(commandId + " OK CLOSE unrecognized");
} else if ("create".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens()) {
String folderName = BASE64MailboxDecoder.decode(removeQuotes(tokens.nextToken()));
if (session.getFolder(folderName) != null) {
sendClient(commandId + " OK folder already exists");
} else {
// TODO
sendClient(commandId + " NO unsupported");
}
} else {
sendClient(commandId + " BAD missing create argument");
}
} else if ("uid".equalsIgnoreCase(command)) { } else if ("uid".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens() && "fetch".equalsIgnoreCase(tokens.nextToken())) { if (tokens.hasMoreTokens() && "fetch".equalsIgnoreCase(tokens.nextToken())) {
if (tokens.hasMoreTokens()) { if (tokens.hasMoreTokens()) {
String parameter = tokens.nextToken(); String parameter = tokens.nextToken();
if (currentFolder == null) {
sendClient(commandId + " NO no folder selected");
}
if ("1:*".equals(parameter)) { if ("1:*".equals(parameter)) {
List<ExchangeSession.Message> messages = session.getAllMessages(); for (int i = 0; i < currentFolder.objectCount; i++) {
for (ExchangeSession.Message message : messages) { sendClient("* FETCH (UID " + (i + 1) + " FLAGS (\\Recent))");
sendClient("* FETCH (UID " + message.uid + " FLAGS ())");
} }
sendClient(commandId + " OK UID FETCH completed"); sendClient(commandId + " OK UID FETCH completed");
} else { } else {
@ -110,6 +184,22 @@ public class ImapConnection extends AbstractConnection {
} else { } else {
sendClient(commandId + " BAD command unrecognized"); sendClient(commandId + " BAD command unrecognized");
} }
} else if ("fetch".equalsIgnoreCase(command)) {
if (tokens.hasMoreTokens()) {
int messageIndex = Integer.parseInt(tokens.nextToken());
ExchangeSession.Message message = messages.get(messageIndex - 1);
if (tokens.hasMoreTokens()) {
String parameters = tokens.nextToken();
if ("(BODYSTRUCTURE)".equals(parameters)) {
sendClient("* "+messageIndex+" FETCH (BODYSTRUCTURE (\"TEXT\" \"PLAIN\" (\"CHARSET\" \"windows-1252\") NIL NIL \"QUOTED-PRINTABLE\" "+message.size+" 50 NIL NIL NIL NIL))");
sendClient(commandId + " OK FETCH completed");
} else {
sendClient("* "+messageIndex+" 1 FETCH (BODY[TEXT]<0> {" + message.size + "}");
message.write(os);
sendClient(commandId + " OK FETCH completed");
}
}
}
} else { } else {
sendClient(commandId + " BAD command unrecognized"); sendClient(commandId + " BAD command unrecognized");
} }
@ -126,6 +216,13 @@ public class ImapConnection extends AbstractConnection {
os.flush(); os.flush();
} catch (SocketTimeoutException e) {
DavGatewayTray.debug("Closing connection on timeout");
try {
sendClient("* BYE Closing connection");
} catch (IOException e1) {
DavGatewayTray.debug("Exception closing connection on timeout");
}
} catch (IOException e) { } catch (IOException e) {
DavGatewayTray.error("Exception handling client", e); DavGatewayTray.error("Exception handling client", e);
} finally { } finally {
@ -136,6 +233,7 @@ public class ImapConnection extends AbstractConnection {
/** /**
* Decode IMAP credentials * Decode IMAP credentials
*
* @param tokens tokens * @param tokens tokens
* @throws java.io.IOException on error * @throws java.io.IOException on error
*/ */
@ -168,8 +266,5 @@ public class ImapConnection extends AbstractConnection {
return result; return result;
} }
public void sendMessage(StringBuffer buffer) {
// TODO implement
}
} }

View File

@ -109,7 +109,7 @@ public class PopConnection extends AbstractConnection {
password = line.substring("PASS".length() + 1); password = line.substring("PASS".length() + 1);
try { try {
session = ExchangeSessionFactory.getInstance(userName, password); session = ExchangeSessionFactory.getInstance(userName, password);
messages = session.getAllMessages(); messages = session.getAllMessages("INBOX");
sendOK("PASS"); sendOK("PASS");
state = AUTHENTICATED; state = AUTHENTICATED;
} catch (SocketException e) { } catch (SocketException e) {

View File

@ -26,7 +26,7 @@ public class TestExchangeSession {
ExchangeSessionFactory.checkConfig(); ExchangeSessionFactory.checkConfig();
session = ExchangeSessionFactory.getInstance(argv[currentArg++], argv[currentArg++]); session = ExchangeSessionFactory.getInstance(argv[currentArg++], argv[currentArg++]);
ExchangeSession.Folder folder = session.selectFolder(argv[currentArg++]); ExchangeSession.Folder folder = session.getFolder(argv[currentArg++]);
String messageName; String messageName;
messageName = URIUtil.decode(argv[currentArg]); messageName = URIUtil.decode(argv[currentArg]);