fr.sii.ogham.email.builder.JavaMailBuilder Maven / Gradle / Ivy
package fr.sii.ogham.email.builder;
import java.util.Properties;
import javax.mail.Authenticator;
import fr.sii.ogham.core.builder.Builder;
import fr.sii.ogham.core.charset.FixedCharsetProvider;
import fr.sii.ogham.core.message.content.Content;
import fr.sii.ogham.core.message.content.MultiContent;
import fr.sii.ogham.core.message.content.StringContent;
import fr.sii.ogham.core.mimetype.FallbackMimeTypeProvider;
import fr.sii.ogham.core.mimetype.FixedMimeTypeProvider;
import fr.sii.ogham.core.mimetype.MimeTypeProvider;
import fr.sii.ogham.core.mimetype.TikaProvider;
import fr.sii.ogham.core.resource.ByteResource;
import fr.sii.ogham.core.resource.FileResource;
import fr.sii.ogham.core.resource.NamedResource;
import fr.sii.ogham.core.util.BuilderUtils;
import fr.sii.ogham.email.EmailConstants.SmtpConstants;
import fr.sii.ogham.email.message.content.ContentWithAttachments;
import fr.sii.ogham.email.sender.impl.JavaMailSender;
import fr.sii.ogham.email.sender.impl.javamail.ContentWithAttachmentsHandler;
import fr.sii.ogham.email.sender.impl.javamail.FileResourceHandler;
import fr.sii.ogham.email.sender.impl.javamail.JavaMailAttachmentResourceHandler;
import fr.sii.ogham.email.sender.impl.javamail.JavaMailContentHandler;
import fr.sii.ogham.email.sender.impl.javamail.JavaMailInterceptor;
import fr.sii.ogham.email.sender.impl.javamail.MapAttachmentResourceHandler;
import fr.sii.ogham.email.sender.impl.javamail.MapContentHandler;
import fr.sii.ogham.email.sender.impl.javamail.MultiContentHandler;
import fr.sii.ogham.email.sender.impl.javamail.PropertiesUsernamePasswordAuthenticator;
import fr.sii.ogham.email.sender.impl.javamail.StreamResourceHandler;
import fr.sii.ogham.email.sender.impl.javamail.StringContentHandler;
/**
* Builder that helps to construct the Java mail API implementation.
*
* @author Aurélien Baudet
*
*/
public class JavaMailBuilder implements Builder {
/**
* The properties to use
*/
private Properties properties;
/**
* The content handler to use. By default, it uses a
* {@link MapContentHandler}.
*/
private JavaMailContentHandler contentHandler;
/**
* The content handler that associates the content class to the content
* handler implementation
*/
private MapContentHandler mapContentHandler;
/**
* The attachment resource handler to use. By default, it uses a
* {@link MapAttachmentResourceHandler}.
*/
private JavaMailAttachmentResourceHandler attachmentResourceHandler;
/**
* The attachment resource handler that associates the attachment resource class to the
* attachment resource handler implementation
*/
private MapAttachmentResourceHandler mapAttachmentResourceHandler;
/**
* The provider for Mime Type detection
*/
private FallbackMimeTypeProvider mimetypeProvider;
/**
* Extra operations to apply on the message
*/
private JavaMailInterceptor interceptor;
/**
* Authentication mechanism
*/
private Authenticator authenticator;
public JavaMailBuilder() {
super();
mapContentHandler = new MapContentHandler();
contentHandler = mapContentHandler;
attachmentResourceHandler = mapAttachmentResourceHandler = new MapAttachmentResourceHandler();
mimetypeProvider = new FallbackMimeTypeProvider();
}
/**
* Tells the builder to use all default behaviors and values:
*
* - Use the system properties
* - Register Mime Type detection using MimeMagic library
* - Register default Mime Type (text/plain)
* - Handle {@link MultiContent}
* - Handle {@link StringContent}
* - Handle {@link ByteResource}
* - Handle {@link FileResource}
*
*
* @return this instance for fluent use
*/
public JavaMailBuilder useDefaults() {
useDefaults(BuilderUtils.getDefaultProperties());
return this;
}
/**
* Tells the builder to use all default behaviors and values:
*
* - Use the provided properties
* - Register Mime Type detection using MimeMagic library
* - Register default Mime Type (text/plain)
* - Handle {@link MultiContent}
* - Handle {@link StringContent}
* - Handle {@link ByteResource}
* - Handle {@link FileResource}
*
*
* @param props
* the properties to use
* @return this instance for fluent use
*/
public JavaMailBuilder useDefaults(Properties props) {
withProperties(props);
if (props.containsKey(SmtpConstants.AUTHENTICATOR_USERNAME_KEY)) {
setAuthenticator(new PropertiesUsernamePasswordAuthenticator(props));
}
registerMimeTypeProvider(new TikaProvider());
registerMimeTypeProvider(new FixedMimeTypeProvider());
registerContentHandler(MultiContent.class, new MultiContentHandler(mapContentHandler));
// TODO: make charset provider configurable
registerContentHandler(StringContent.class, new StringContentHandler(mimetypeProvider, new FixedCharsetProvider()));
registerContentHandler(ContentWithAttachments.class, new ContentWithAttachmentsHandler(mapContentHandler));
registerAttachmentResourceHandler(ByteResource.class, new StreamResourceHandler(mimetypeProvider));
registerAttachmentResourceHandler(FileResource.class, new FileResourceHandler(mimetypeProvider));
return this;
}
/**
* Set the properties to use for Java mail API implementation.
*
* @param props
* the properties to use
* @return this instance for fluent use
*/
public JavaMailBuilder withProperties(Properties props) {
properties = props;
return this;
}
/**
* Register a new handler for a specific content.
*
* @param clazz
* the class of the content to handle
* @param handler
* the handler
* @return this instance for fluent use
*/
public JavaMailBuilder registerContentHandler(Class clazz, JavaMailContentHandler handler) {
mapContentHandler.addContentHandler(clazz, handler);
return this;
}
/**
* Register a new handler for a specific attachment resource.
*
* @param clazz
* the class of the attachment resource to handle
* @param handler
* the handler
* @return this instance for fluent use
*/
public JavaMailBuilder registerAttachmentResourceHandler(Class clazz, JavaMailAttachmentResourceHandler handler) {
mapAttachmentResourceHandler.addResourceHandler(clazz, handler);
return this;
}
/**
*
* Register a new Mime Type provider. Registering several providers allows
* to try detecting using the first one. If it can't detect the mimetype, it
* tries with the next one until one detects successfully the Mime Type.
*
*
* The provider is added at the end so any previously registered provider
* that is able to provide a Mime Type prevents to use this provider.
*
*
* @param provider
* the provider to register
* @return this instance for fluent use
*/
public JavaMailBuilder registerMimeTypeProvider(MimeTypeProvider provider) {
mimetypeProvider.addProvider(provider);
return this;
}
/**
* Set an interceptor used to customize the message before sending it. It is
* called at the really end and just before sending the message.
*
* @param interceptor
* the interceptor to use
* @return this instance for fluent use
*/
public JavaMailBuilder setInterceptor(JavaMailInterceptor interceptor) {
this.interceptor = interceptor;
return this;
}
/**
* Set the authentication mechanism to use for sending email.
*
* @param authenticator
* the authentication mechanism
* @return this instance for fluent use
*/
public JavaMailBuilder setAuthenticator(Authenticator authenticator) {
this.authenticator = authenticator;
return this;
}
@Override
public JavaMailSender build() {
return new JavaMailSender(properties, contentHandler, attachmentResourceHandler, authenticator, interceptor);
}
}