1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19 package org.apache.jsieve.mailet;
20
21 import java.util.Collection;
22
23 import javax.mail.MessagingException;
24 import javax.mail.internet.MimeMessage;
25
26 import org.apache.commons.logging.Log;
27 import org.apache.mailet.MailAddress;
28
29 /**
30 * Provides context for action execution.
31 */
32 public interface ActionContext {
33
34 /**
35 * Gets the log.
36 * @return not null
37 */
38 public Log getLog();
39
40 /**
41 * Experimental mail delivery.
42 * POST verb indicate that mail should be attached to the collection
43 * indicated by the given URI.
44 *
45 * @param uri indicates the destination to which the mail to added. ATM
46 * the value should be mailbox://<user>@localhost/<mailbox-path>
47 * @param mail not null
48 */
49 public void post(String uri, MimeMessage mail) throws MessagingException;
50
51 /**
52 * Posts the given mail.
53 * @param sender possibly null
54 * @param recipients not null
55 * @param mail not null
56 * @throws MessagingException when mail cannot be posted
57 */
58 public void post(MailAddress sender, Collection<MailAddress> recipients, MimeMessage mail) throws MessagingException;
59
60 /**
61 * Gets name (including version) of this server.
62 * @return not nul
63 */
64 public String getServerInfo();
65 }