sirius.web.mails.Attachment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirius-web Show documentation
Provides a modern and scalable web server as SIRIUS module
There is a newer version: 22.2.3
/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.web.mails;

import com.google.common.collect.Maps;

import javax.activation.DataSource;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Map;
import java.util.Set;

/**
 * Encapsulates all information required to add an attachment to a mail being sent.
 */
public abstract class Attachment implements DataSource {

    private String contentType;
    private boolean asAlternative;
    private String name;
    private Map headers = Maps.newTreeMap();

    /**
     * Generates a new attachment with the given name, mime type and contents.
     *
     * @param name          the name of the attached file
     * @param mimeType      the mime type of the file. Use {@link sirius.web.http.MimeHelper} to determine it at
     *                      runtime if it is not know in advance
     * @param asAlternative determines if this attachment is an alternative to the text content of the mail
     *                      (true) or a real attachment (false)
     */
    public Attachment(String name, String mimeType, boolean asAlternative) {
        this.name = name;
        this.contentType = mimeType;
        this.asAlternative = asAlternative;
    }

    /**
     * Adds a header to the attachment.
     *
     * @param name  the name of the header
     * @param value the value of the header
     * @return the attachment itself to support fluent method calls
     */
    public Attachment addHeader(String name, String value) {
        headers.put(name, value);
        return this;
    }

    /**
     * Updates the content type of the attachment.
     *
     * @param contentType the new content type to use
     * @return the attachment itself for fluent method calls
     */
    public Attachment withContentType(String contentType) {
        this.contentType = contentType;
        return this;
    }

    @Override
    public String getContentType() {
        return contentType;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public OutputStream getOutputStream() throws IOException {
        return null;
    }

    /**
     * Returns all headers declared for this attachment.
     *
     * @return all headers for this attachment
     */
    public Set> getHeaders() {
        return headers.entrySet();
    }

    /**
     * Determines if this is an "alternative" to the text content of the mail or a "real" attachment
     *
     * @return true if this is an alternative, false if this is a real attachment
     */
    public boolean isAlternative() {
        return asAlternative;
    }
}