1 /*
2 * Wallace IMAP Server
3 * Copyright (C) 2004 Robert Newson
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19 package net.sf.wallace;
20
21
22 /***
23 * A message from an IMAP4 client.
24 *
25 * @author rnewson
26 */
27 public interface ClientMessage {
28
29 /***
30 * Return a command object capable of processing this message.
31 *
32 * This is generally implemented as an inner class. If so, care must be
33 * taken to use the client message parameter, and not access the outer
34 * Message instance.
35 *
36 * @return
37 */
38 Command getCommand();
39
40 /***
41 * Get the IMAP4 tag identifier for this message.
42 *
43 * @return
44 */
45 String getTag();
46
47 /***
48 * Set the IMAP4 tag identifier for this message.
49 *
50 * @param newTag
51 */
52 void setTag(final String newTag);
53
54 }