com.phloc.web.smtp.IEmailAttachmentList Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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 com.phloc.web.smtp;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.io.IInputStreamProvider;
import com.phloc.commons.state.EChange;
import com.phloc.commons.state.IClearable;

/**
 * This interface represents attachments to be added to a mail message. Messages
 * with attachments are always send as MIME messages.
 * 
 * @author Philip Helger
 */
public interface IEmailAttachmentList extends IReadonlyEmailAttachmentList, IClearable
{
  /**
   * Add an attachment.
   * 
   * @param sFilename
   *        The ID/filename of the attachment. May not be null.
   * @param aISS
   *        The {@link IInputStreamProvider} representing the data. May not be
   *        null.
   */
   void addAttachment (@Nonnull String sFilename, @Nonnull ISP aISS);

  /**
   * Add an attachment.
   * 
   * @param aAttachment
   *        The attachment to be added. May not be null.
   */
  void addAttachment (@Nonnull IEmailAttachment aAttachment);

  /**
   * Remove the passed attachment.
   * 
   * @param sFilename
   *        The file name of the attachment to be removed. The file name is case
   *        sensitive.
   * @return {@link EChange}
   */
  @Nonnull
  EChange removeAttachment (@Nullable String sFilename);
}