EmailPreparator.java

/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springmodules.email;

/**
 * Uses to prepare emails before they're being sent by the {@link EmailDispatcher email dispatcher}.
 *
 * @author Uri Boness
 */
public interface EmailPreparator {

    /**
     * Prepares the given email before sending.
     *
     * @param email The email to prepare.
     * @return The prepared email (may be the same as the passed in email)
     */
    Email prepare(Email email);

}