ru.dlabs71.library.email.util

Class AttachmentUtils

java.lang.Object

ru.dlabs71.library.email.util.AttachmentUtils

public class AttachmentUtils
extends Object

This is the utility class is for creating EmailAttachment objects.

Project name: d-email

Creation date: 2023-09-11

Since:

1.0.0

Author:

Ivanov Danila

Constructor Summary

Constructors

Constructor and Description
AttachmentUtils()

Method Summary

Modifier and Type	Method and Description
EmailAttachment	create(String pathToFile) Creates an object of the EmailAttachment class by the path to file.
EmailAttachment	create(String pathToFile, FileParametersDetector detector) Creates an object of the EmailAttachment class by the path to file argument The path to file must start with the following prefixes: "file://", "classpath:" or a path separator.
String	createContentTypeForAttachment(File file) This method creates string for the value of Content-Type header.
String	createContentTypeForAttachment(File file, FileParametersDetector detector) This method creates string for the value of Content-Type header.
File	createFile(String pathToFile) Creates a file object from the file path argument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentUtils

public AttachmentUtils()

Method Detail

createFile

public File createFile(String pathToFile)
                throws AttachmentException

Creates a file object from the file path argument. The path to file must start with the following prefixes: "file://", "classpath:" or a path separator. Relatives paths is not supported.

Parameters:

pathToFile - the path to file

Returns:

object of the class File

Throws:

AttachmentException - exception may occur when the file path doesn't satisfy conditions or doesn't parse

create

public EmailAttachment create(String pathToFile)
                       throws AttachmentException

Creates an object of the EmailAttachment class by the path to file.

Throws:

AttachmentException

See Also:

create(String, FileParametersDetector)

create

public EmailAttachment create(String pathToFile,
                              FileParametersDetector detector)
                       throws AttachmentException

Creates an object of the EmailAttachment class by the path to file argument The path to file must start with the following prefixes: "file://", "classpath:" or a path separator. Relatives paths is not supported.

Parameters:

pathToFile - the path to file

Returns:

an object of the EmailAttachment class

Throws:

AttachmentException - exception may occur when the file path doesn't satisfy conditions or doesn't parse. Also, an exception may occur while reading the file.

createContentTypeForAttachment

public String createContentTypeForAttachment(File file)

This method creates string for the value of Content-Type header.

See Also:

createContentTypeForAttachment(File, FileParametersDetector)

createContentTypeForAttachment

public String createContentTypeForAttachment(File file,
                                             FileParametersDetector detector)

This method creates string for the value of Content-Type header. If a mime type of file is a 'text/' then a result will contain 'charset='.

Parameters:

file - a path to the file

detector - FileParametersDetector detector for getting different file parameters

Returns:

a completed string for using in the Content-Type header