01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/email/tags/sakai_2-4-1/email-api/api/src/java/org/sakaiproject/email/api/EmailService.java $
03: * $Id: EmailService.java 13805 2006-08-17 02:47:52Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.email.api;
21:
22: import java.util.Collection;
23: import java.util.List;
24:
25: import javax.mail.internet.InternetAddress;
26:
27: /**
28: * <p>
29: * EmailService is an interface to sending emails.
30: * </p>
31: */
32: public interface EmailService {
33: /**
34: * Creates and sends a generic text MIME message to the address contained in to.
35: *
36: * @param from
37: * The address this message is to be listed as coming from.
38: * @param to
39: * The address(es) this message should be sent to.
40: * @param subject
41: * The subject of this message.
42: * @param content
43: * The body of the message.
44: * @param headerToStr
45: * If specified, this is placed into the message header, but "to" is used for the recipients.
46: * @param replyTo
47: * If specified, this is the reply to header address(es).
48: * @param additionalHeaders
49: * Additional email headers to send (List of String). For example, content type or forwarded headers (may be null)
50: */
51: void sendMail(InternetAddress from, InternetAddress[] to,
52: String subject, String content, InternetAddress[] headerTo,
53: InternetAddress[] replyTo, List additionalHeaders);
54:
55: /**
56: * Creates and sends a generic text MIME message to the address contained in to.
57: *
58: * @param fromStr
59: * The address this message is to be listed as coming from.
60: * @param toStr
61: * The address(es) this message should be sent to.
62: * @param subject
63: * The subject of this message.
64: * @param content
65: * The body of the message.
66: * @param headerToStr
67: * If specified, this is placed into the message header, but "too" is used for the recipients.
68: * @param replyToStr
69: * If specified, the reply-to header value.
70: * @param additionalHeaders
71: * Additional email headers to send (List of String). For example, content type or forwarded headers (may be null)
72: */
73: void send(String fromStr, String toStr, String subject,
74: String content, String headerToStr, String replyToStr,
75: List additionalHeaders);
76:
77: /**
78: * Send a single message to a set of Users.
79: *
80: * @param users
81: * Collection (of User) to send the message to (for those with valid email addresses).
82: * @param headers
83: * List (of String, form "name: value") of headers for the message.
84: * @param message
85: * String body of the message.
86: */
87: void sendToUsers(Collection users, Collection headers,
88: String message);
89: }
|