Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
EmailService |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2007-2008 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl2.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | package org.kuali.rice.kcb.service; | |
17 | ||
18 | import org.kuali.rice.kcb.bo.MessageDelivery; | |
19 | ||
20 | /** | |
21 | * The EmailService class is responsible for actually sending email messages to recipients. | |
22 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
23 | */ | |
24 | public interface EmailService { | |
25 | /** | |
26 | * This service method is responsible for sending a Email notification for the given user. | |
27 | * @param messageDelivery | |
28 | * @param recipientEmailAddress | |
29 | * @param emailFormat | |
30 | * @return Long - the id of the email message | |
31 | */ | |
32 | public Long sendEmail(MessageDelivery messageDelivery, String recipientEmailAddress, String emailFormat) throws Exception; | |
33 | } |