1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.geronimo.javamail.store.imap.connection;
19 import java.util.ArrayList;
20 import java.util.List;
21
22 import javax.mail.MessagingException;
23
24 /**
25 * Util class to represent an untagged response from a IMAP server
26 *
27 * @version $Rev: 594520 $ $Date: 2007-11-13 07:57:39 -0500 (Tue, 13 Nov 2007) $
28 */
29 public class IMAPOkResponse extends IMAPUntaggedResponse {
30 // the response status value
31 protected List status;
32 // any message following the response
33 protected String message;
34
35 /**
36 * Create a reply object from a server response line (normally, untagged). This includes
37 * doing the parsing of the response line.
38 *
39 * @param response The response line used to create the reply object.
40 */
41 public IMAPOkResponse(String keyword, List status, String message, byte [] response) {
42 super(keyword, response);
43 this.status = status;
44 this.message = message;
45 }
46
47 /**
48 * Get the response code included with the OK
49 * response.
50 *
51 * @return The string name of the response code.
52 */
53 public String getResponseCode() {
54 return getKeyword();
55 }
56
57 /**
58 * Return the status argument values associated with
59 * this status response.
60 *
61 * @return The status value information, as a list of tokens.
62 */
63 public List getStatus() {
64 return status;
65 }
66
67 /**
68 * Get any trailing message associated with this
69 * status response.
70 *
71 * @return
72 */
73 public String getMessage() {
74 return message;
75 }
76 }
77
78