it.ozimov.springboot.mail.service.EmailSchedulerService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-boot-email-core
Utilities to deal with emails in Spring Boot
There is a newer version: 1.0.0
/*
 * Copyright 2012-2015 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 it.ozimov.springboot.mail.service;

import it.ozimov.springboot.mail.model.Email;
import it.ozimov.springboot.mail.model.InlinePicture;
import it.ozimov.springboot.mail.service.exception.CannotSendEmailException;
import org.springframework.scheduling.annotation.Async;

import java.time.OffsetDateTime;
import java.util.Map;

public interface EmailSchedulerService {

    /**
     * Schedules the sending of an email message at time now (UTC).
     *
     * @param mimeEmail            an email to be sent
     * @param desiredPriorityLevel the desiredPriority level for the email:
     *                             the emails with scheduledTime<=now are sent according to an order depending
     *                             on their desiredPriority level
     */
    @Async
    void schedule(Email mimeEmail, int desiredPriorityLevel);

    /**
     * Schedules the sending of an email message.
     *
     * @param mimeEmail            an email to be sent
     * @param scheduledDateTime    the date-time at which the email should be sent
     * @param desiredPriorityLevel the desiredPriority level for the email:
     *                             the emails with scheduledTime<=now are sent according to an order depending
     *                             on their desiredPriority level
     */
    @Async
    void schedule(Email mimeEmail, OffsetDateTime scheduledDateTime, int desiredPriorityLevel);

    /**
     * Schedules the sending of an email message at time now (UTC).
     *
     * @param mimeEmail            an email to be sent
     * @param desiredPriorityLevel the desiredPriority level for the email:
     *                             the emails with scheduledTime<=now are sent according to an order depending
     *                             on their desiredPriority level
     * @param template             the reference to the template file
     * @param modelObject          the model object to be used for the template engine, it may be null
     * @param inlinePictures       list of pictures to be rendered inline in the template
     */
    @Async
    void schedule(Email mimeEmail, int desiredPriorityLevel,
                  String template, Map modelObject,
                  InlinePicture... inlinePictures) throws CannotSendEmailException;

    /**
     * Schedules the sending of an email message.
     *
     * @param mimeEmail            an email to be sent
     * @param scheduledDateTime    the date-time at which the email should be sent
     * @param desiredPriorityLevel the desiredPriority level for the email:
     *                             the emails with scheduledTime<=now are sent according to an order depending
     *                             on their desiredPriority level
     * @param template             the reference to the template file
     * @param modelObject          the model object to be used for the template engine, it may be null
     * @param inlinePictures       list of pictures to be rendered inline in the template
     */
    @Async
    void schedule(Email mimeEmail, OffsetDateTime scheduledDateTime, int desiredPriorityLevel,
                  String template, Map modelObject,
                  InlinePicture... inlinePictures) throws CannotSendEmailException;


    default ServiceStatus status() {
        return ServiceStatus.CLOSED;
    }

}