org.simplejavamail.email.EmailBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of simple-java-mail Show documentation
Simple API, Complex Emails. A light weight wrapper for the JavaMail SMTP API
There is a newer version: 8.12.4
/*
 * Copyright © 2009 Benny Bottema ([email protected])
 *
 * 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.simplejavamail.email;

import jakarta.mail.internet.MimeMessage;
import org.jetbrains.annotations.NotNull;
import org.simplejavamail.api.email.Email;
import org.simplejavamail.api.email.EmailPopulatingBuilder;
import org.simplejavamail.api.email.EmailStartingBuilder;
import org.simplejavamail.email.internal.EmailPopulatingBuilderImpl;
import org.simplejavamail.email.internal.EmailStartingBuilderImpl;

/**
 * Builder starter which offers initial starting places after which control is passed on to the {@link EmailPopulatingBuilderImpl} for filling in details.
 * 
 * Starter methods are all variations of one of the following:
 * 

 * startingBlank()
 * replyingTo()
 * replyingToAll()
 * forwarding()
 * copying()
 * 
 */
public class EmailBuilder {
	
	/**
	 * Configures this builder to create an email ignoring the normal (optional) defaults that apply from property config files.
	 */
	@SuppressWarnings("deprecation")
	public static EmailStartingBuilder ignoringDefaults() {
		return new EmailStartingBuilderImpl().ignoringDefaults();
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingTo(Email)}.
	 */
	@SuppressWarnings("deprecation")
	public static EmailPopulatingBuilder replyingTo(@NotNull final Email email) {
		return new EmailStartingBuilderImpl().replyingTo(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingToAll(Email)}.
	 */
	@SuppressWarnings("deprecation")
	public static EmailPopulatingBuilder replyingToAll(@NotNull final Email email) {
		return new EmailStartingBuilderImpl().replyingToAll(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingToAll(Email, String)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingToAll(@NotNull final Email email, @NotNull final String customQuotingTemplate) {
		return new EmailStartingBuilderImpl().replyingToAll(email, customQuotingTemplate);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingTo(Email, String)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingTo(@NotNull final Email email, @NotNull final String customQuotingTemplate) {
		return new EmailStartingBuilderImpl().replyingTo(email, customQuotingTemplate);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingTo(MimeMessage)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingTo(@NotNull final MimeMessage email) {
		return new EmailStartingBuilderImpl().replyingTo(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingToAll(MimeMessage, String)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingToAll(@NotNull final MimeMessage email, @NotNull final String customQuotingTemplate) {
		return new EmailStartingBuilderImpl().replyingToAll(email, customQuotingTemplate);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingTo(MimeMessage, String)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingTo(@NotNull final MimeMessage email, @NotNull final String customQuotingTemplate) {
		return new EmailStartingBuilderImpl().replyingTo(email, customQuotingTemplate);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#replyingToAll(MimeMessage)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder replyingToAll(@NotNull final MimeMessage email) {
		return new EmailStartingBuilderImpl().replyingToAll(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#forwarding(Email)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder forwarding(@NotNull final Email email) {
		return new EmailStartingBuilderImpl().forwarding(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#forwarding(MimeMessage)}.
	 */
	@SuppressWarnings("deprecation")
	public static EmailPopulatingBuilder forwarding(@NotNull final MimeMessage emailMessage) {
		return new EmailStartingBuilderImpl().forwarding(emailMessage);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#copying(MimeMessage)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder copying(@NotNull final MimeMessage message) {
		return new EmailStartingBuilderImpl().copying(message);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#copying(EmailPopulatingBuilder)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder copying(@NotNull final EmailPopulatingBuilder emailBuilder) {
		return new EmailStartingBuilderImpl().copying(emailBuilder);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#copying(Email)}.
	 */
	@SuppressWarnings({"deprecation", "unused"})
	public static EmailPopulatingBuilder copying(@NotNull final Email email) {
		return new EmailStartingBuilderImpl().copying(email);
	}
	
	/**
	 * Delegates to {@link EmailStartingBuilder#startingBlank()}.
	 */
	@SuppressWarnings("deprecation")
	public static EmailPopulatingBuilder startingBlank() {
		return new EmailStartingBuilderImpl().startingBlank();
	}
	
	private EmailBuilder() {
	}
	
}