1 package org.apache.fulcrum.commonsemail;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import javax.mail.Address;
23
24 /**
25 * Allows to access the send delivery status of a previously sent
26 * email.
27 */
28 public interface SendDeliveryStatus
29 {
30 /**
31 * Returns true only if ALL recipients were accepted by the
32 * mailserver, i.e. everything is okay.
33 *
34 * @return true if message sending was successful
35 */
36 boolean hasSucceeded();
37
38 /**
39 * The list of mail addresses accepted by the mailserver.
40 *
41 * @return list of email addresses
42 */
43 Address[] getValidSentAddresses();
44
45 /**
46 * The list of mail addresses rejected by the mailserver.
47 *
48 * @return list of email addresses
49 */
50 Address[] getValidUnsentAddresses();
51
52 /**
53 * The list of invalid mail addresses.
54 *
55 * @return list of email addresses
56 */
57 Address[] getInvalidAddresses();
58 }