IMailSender.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2018 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.action;
 
import java.io.File;
import java.util.Collection;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.apache.commons.mail.EmailException;
import org.turro.action.queue.NotificationCategory;
import org.turro.plugin.contacts.IContact;
 
public interface IMailSender extends IContactSender<IMailSender> {
 
  public IMailSender addAttachment(File file);
  public IMailSender addAttachments(Collection<File> files);
  public IMailSender addMailAttachments(Collection<MailAttachment> files);
  public IMailSender onStart(Consumer command);
  public IMailSender onCancel(Consumer command);
  public IMailSender onBuild(Consumer command);
  public IMailSender onFinish(Consumer command);
  
  public IMailSender setCategory(String idCategory);
  public IMailSender setPool(String pool);
  public IMailSender setReason(String reason);
  
  /* Not for queue or authenticated accounts */
  public IMailSender setFrom(IContact contact);
  
  /* Attributes */
  public IMailSender putIf(Object key, Supplier<Boolean> condition, Supplier value);
  public IMailSender put(Object key, Object value);
  public IMailSender putAll(Map attributes);
  
  public IMailSender setRoot(String root);
  
  public void removeAttachments();
  
  /* Direct sending */
  public void send(String subject, String message);
  public void send(NotificationCategory category, String subject, String message);
 
  /* Template sending */
  public void sendTemplate(String template, String subject) throws EmailException;
  public void sendTemplate(Object entity, String template, String subject) throws EmailException;
  public void sendTemplate(NotificationCategory category, Object entity, String template, String subject) throws EmailException;
 
  public void silentSendTemplate(String template, String subject);
  public void silentSendTemplate(Object entity, String template, String subject);
  public void silentSendTemplate(NotificationCategory category, Object entity, String template, String subject);
  
  /* Utils */
  
  public String processMacros(IContact contact, String text, boolean web);
  
}