001    /**
002     * Copyright 2005-2014 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kcb.service;
017    
018    import org.kuali.rice.kcb.bo.MessageDelivery;
019    
020    /**
021     * The EmailService class is responsible for actually sending email messages to recipients.
022     * @author Kuali Rice Team (rice.collab@kuali.org)
023     */
024    public interface EmailService {
025        /**
026         * This service method is responsible for sending a Email notification for the given user.
027         * @param messageDelivery
028         * @param recipientEmailAddress
029         * @param emailFormat
030         * @return Long - the id of the email message
031         */
032        public Long sendEmail(MessageDelivery messageDelivery, String recipientEmailAddress, String emailFormat) throws Exception;
033    }