Inheritance diagram for org.turro.mail.sender.AbstractMailSender:

[legend]

Collaboration diagram for org.turro.mail.sender.AbstractMailSender:

[legend]

Public Member Functions
IMailSender	setCategory (String idCategory)

IMailSender	setReason (String reason)

IMailSender	setPool (String pool)

IMailSender	setFrom (IContact from)

IMailSender	setRoot (String root)

IMailSender	addAdministrators ()

IMailSender	addBySyndication (String syndication)

IMailSender	addByRole (String role)

IMailSender	addByEntity (Object entity, Object data)

IMailSender	addByEntity (Object entity, boolean deep, Object data)

IMailSender	addByEntity (String path, Object data)

IMailSender	addByEntity (String path, boolean deep, Object data)

IMailSender	addContact (IContact contact)

IMailSender	addContacts (Collection< IContact > contacts)

IMailSender	addAssistant (Assistant assistant)

IMailSender	addAssistants (AssistantSet assistants)

IMailSender	addUser (String name, String email)

IMailSender	addAttachment (File file)

IMailSender	addAttachments (Collection< File > files)

IMailSender	addMailAttachments (Collection< MailAttachment > mas)

IMailSender	onStart (Consumer command)

IMailSender	onCancel (Consumer command)

IMailSender	onBuild (Consumer command)

IMailSender	onFinish (Consumer command)

AssistantSet	getAssistants ()

void	removeAttachments ()

IMailSender	putIf (Object key, Supplier< Boolean > condition, Supplier value)

IMailSender	put (Object key, Object value)

IMailSender	putAll (Map attributes)

void	send (String subject, String message)

void	send (NotificationCategory category, String subject, String message)

void	sendTemplate (String template, String subject) throws EmailException

void	sendTemplate (Object entity, String template, String subject) throws EmailException

void	sendTemplate (NotificationCategory category, Object entity, String template, String subject) throws EmailException

void	silentSendTemplate (String template, String subject)

void	silentSendTemplate (Object entity, String template, String subject)

void	silentSendTemplate (NotificationCategory category, Object entity, String template, String subject)

String	processMacros (IContact contact, String text, boolean web)

Public Member Functions inherited from org.turro.action.IContactSender< IMailSender >
T	addAdministrators ()

T	addByEntity (Object entity, Object data)

T	addByEntity (Object entity, boolean deep, Object data)

T	addByEntity (String path, Object data)

T	addByEntity (String path, boolean deep, Object data)

T	addByRole (String role)

T	addBySyndication (String syndication)

T	addContact (IContact contact)

T	addContacts (Collection< IContact > contacts)

T	addAssistant (Assistant assistant)

T	addAssistants (AssistantSet assistants)

T	addUser (String name, String email)

AssistantSet	getAssistants ()

default void	copyFrom (IContactSender sender)

Public Attributes
final AssistantSet	assistants = new AssistantSet()

Protected Member Functions
boolean	isFromValid ()

String	getFromString ()

Map	getAttributes ()

abstract void	doSend (NotificationCategory category, String subject, String message)

abstract void	doSendTemplate (NotificationCategory category, Object entity, String template, String subject) throws EmailException

Protected Attributes
String	defaultCategory = GenericElephantNotification.SYSTEM_NOTIFICATION

String	reason

Set< File >	attachments = new HashSet<>()

Set< MailAttachment >	mailAttachments = new HashSet<>()

Consumer	onStart

IContact	from

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 51 of file AbstractMailSender.java.

Member Function Documentation

◆ addAdministrators()

IMailSender org.turro.mail.sender.AbstractMailSender.addAdministrators ( )

Definition at line 107 of file AbstractMailSender.java.

                                          {
     addBySyndication(SecurityGroup.BRIGHTSIDE_ADMIN);
     return this;
   }

Here is the call graph for this function:

◆ addAssistant()

IMailSender org.turro.mail.sender.AbstractMailSender.addAssistant ( Assistant assistant )

Definition at line 161 of file AbstractMailSender.java.

                                                        {
     this.assistants.add(assistant);
     return this;
   }

◆ addAssistants()

IMailSender org.turro.mail.sender.AbstractMailSender.addAssistants ( AssistantSet assistants )

Definition at line 167 of file AbstractMailSender.java.

                                                             {
     for(Assistant assistant : assistants) {
       this.assistants.add(assistant);
     }
     return this;
   }

◆ addAttachment()

IMailSender org.turro.mail.sender.AbstractMailSender.addAttachment ( File file )

Implements org.turro.action.IMailSender.

Definition at line 182 of file AbstractMailSender.java.

                                               {
     attachments.add(file);
     return this;
   }

◆ addAttachments()

IMailSender org.turro.mail.sender.AbstractMailSender.addAttachments ( Collection< File > files )

Implements org.turro.action.IMailSender.

Definition at line 188 of file AbstractMailSender.java.

                                                             {
     attachments.addAll(files);
     return this;
   }

◆ addByEntity() [1/4]

IMailSender org.turro.mail.sender.AbstractMailSender.addByEntity	(	Object	entity,
		boolean	deep,
		Object	data
	)

Definition at line 131 of file AbstractMailSender.java.

                                                                            {
     addByEntity(Entities.getController(entity).getPath(), deep, data);
     return this;
   }

Here is the call graph for this function:

◆ addByEntity() [2/4]

IMailSender org.turro.mail.sender.AbstractMailSender.addByEntity	(	Object	entity,
		Object	data
	)

Definition at line 125 of file AbstractMailSender.java.

                                                              {
     addByEntity(entity, true, data);
     return this;
   }

Here is the caller graph for this function:

◆ addByEntity() [3/4]

IMailSender org.turro.mail.sender.AbstractMailSender.addByEntity	(	String	path,
		boolean	deep,
		Object	data
	)

Definition at line 143 of file AbstractMailSender.java.

                                                                          {
     Assistants.addAssistants(path, true, assistants, data);
     return this;
   }

Here is the call graph for this function:

◆ addByEntity() [4/4]

IMailSender org.turro.mail.sender.AbstractMailSender.addByEntity	(	String	path,
		Object	data
	)

Definition at line 137 of file AbstractMailSender.java.

                                                            {
     addByEntity(path, true, data);
     return this;
   }

Here is the call graph for this function:

◆ addByRole()

IMailSender org.turro.mail.sender.AbstractMailSender.addByRole ( String role )

Definition at line 119 of file AbstractMailSender.java.

                                             {
     assistants.addContacts(Contacts.getByRole(role));
     return this;
   }

Here is the call graph for this function:

◆ addBySyndication()

IMailSender org.turro.mail.sender.AbstractMailSender.addBySyndication ( String syndication )

Definition at line 113 of file AbstractMailSender.java.

                                                           {
     assistants.addContacts(Contacts.getBySyndication(syndication));
     return this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addContact()

IMailSender org.turro.mail.sender.AbstractMailSender.addContact ( IContact contact )

Definition at line 149 of file AbstractMailSender.java.

                                                   {
     assistants.addContact(contact, null);
     return this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addContacts()

IMailSender org.turro.mail.sender.AbstractMailSender.addContacts ( Collection< IContact > contacts )

Definition at line 155 of file AbstractMailSender.java.

                                                                 {
     assistants.addContacts(contacts);
     return this;
   }

Here is the call graph for this function:

◆ addMailAttachments()

IMailSender org.turro.mail.sender.AbstractMailSender.addMailAttachments ( Collection< MailAttachment > mas )

Implements org.turro.action.IMailSender.

Definition at line 194 of file AbstractMailSender.java.

                                                                         {
     mailAttachments.addAll(mas);
     return this;
   }

◆ addUser()

IMailSender org.turro.mail.sender.AbstractMailSender.addUser	(	String	name,
		String	email
	)

Definition at line 175 of file AbstractMailSender.java.

                                                         {
     assistants.addUser(name, email, null);
     return this;
   }

Here is the call graph for this function:

◆ doSend()

abstract void org.turro.mail.sender.AbstractMailSender.doSend	(	NotificationCategory	category,
		String	subject,
		String	message
	)

abstractprotected

Reimplemented in org.turro.mail.sender.MailQueue, org.turro.mail.sender.MailPool, and org.turro.mail.sender.MailHeavy.

◆ doSendTemplate()

abstract void org.turro.mail.sender.AbstractMailSender.doSendTemplate	(	NotificationCategory	category,
		Object	entity,
		String	template,
		String	subject
	)		throws EmailException

abstractprotected

Reimplemented in org.turro.mail.sender.MailQueue, org.turro.mail.sender.MailPool, and org.turro.mail.sender.MailHeavy.

◆ getAssistants()

AssistantSet org.turro.mail.sender.AbstractMailSender.getAssistants ( )

Definition at line 224 of file AbstractMailSender.java.

                                       {
     return assistants;
   }

◆ getAttributes()

Map org.turro.mail.sender.AbstractMailSender.getAttributes ( )

protected

Definition at line 257 of file AbstractMailSender.java.

                                 {
     return attributes;
   }

◆ getFromString()

String org.turro.mail.sender.AbstractMailSender.getFromString ( )

protected

Definition at line 90 of file AbstractMailSender.java.

                                    {
     return isFromValid() ? from.getEmail() : null;
   }

Here is the call graph for this function:

◆ isFromValid()

boolean org.turro.mail.sender.AbstractMailSender.isFromValid ( )

protected

Definition at line 86 of file AbstractMailSender.java.

                                   {
     return from != null && from.isWebUser();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onBuild()

IMailSender org.turro.mail.sender.AbstractMailSender.onBuild ( Consumer command )

Implements org.turro.action.IMailSender.

Definition at line 212 of file AbstractMailSender.java.

                                                {
     onBuild = command;
     return this;
   }

◆ onCancel()

IMailSender org.turro.mail.sender.AbstractMailSender.onCancel ( Consumer command )

Implements org.turro.action.IMailSender.

Definition at line 206 of file AbstractMailSender.java.

                                                 {
     onCancel = command;
     return this;
   }

◆ onFinish()

IMailSender org.turro.mail.sender.AbstractMailSender.onFinish ( Consumer command )

Implements org.turro.action.IMailSender.

Definition at line 218 of file AbstractMailSender.java.

                                                 {
     onFinish = command;
     return this;
   }

◆ onStart()

IMailSender org.turro.mail.sender.AbstractMailSender.onStart ( Consumer command )

Implements org.turro.action.IMailSender.

Definition at line 200 of file AbstractMailSender.java.

                                                {
     onStart = command;
     return this;
   }

◆ processMacros()

String org.turro.mail.sender.AbstractMailSender.processMacros	(	IContact	contact,
		String	text,
		boolean	web
	)

Implements org.turro.action.IMailSender.

Definition at line 328 of file AbstractMailSender.java.

                                                                           {
     return web ? MailUtils.processMacrosForWeb(contact, text) :
             MailUtils.processMacros(contact, text);
   }

Here is the call graph for this function:

◆ put()

IMailSender org.turro.mail.sender.AbstractMailSender.put	(	Object	key,
		Object	value
	)

Implements org.turro.action.IMailSender.

Definition at line 246 of file AbstractMailSender.java.

                                                    {
     if(key != null && value != null) attributes.put(key, value);
     return this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putAll()

IMailSender org.turro.mail.sender.AbstractMailSender.putAll ( Map attributes )

Implements org.turro.action.IMailSender.

Definition at line 252 of file AbstractMailSender.java.

                                             {
     this.attributes.putAll(attributes);
     return this;
   }

Here is the call graph for this function:

◆ putIf()

IMailSender org.turro.mail.sender.AbstractMailSender.putIf	(	Object	key,
		Supplier< Boolean >	condition,
		Supplier	value
	)

Implements org.turro.action.IMailSender.

Definition at line 240 of file AbstractMailSender.java.

                                                                                     {
     if(condition.get()) put(key, value.get());
     return this;
   }

Here is the call graph for this function:

◆ removeAttachments()

void org.turro.mail.sender.AbstractMailSender.removeAttachments ( )

Implements org.turro.action.IMailSender.

Definition at line 229 of file AbstractMailSender.java.

                                   {
     attachments.forEach(file -> {
       file.delete();
     });
   }

◆ send() [1/2]

void org.turro.mail.sender.AbstractMailSender.send	(	NotificationCategory	category,
		String	subject,
		String	message
	)

Implements org.turro.action.IMailSender.

Definition at line 270 of file AbstractMailSender.java.

                                                                                   {
     doSend(category, subject, message);
   }

◆ send() [2/2]

void org.turro.mail.sender.AbstractMailSender.send	(	String	subject,
		String	message
	)

Implements org.turro.action.IMailSender.

Definition at line 264 of file AbstractMailSender.java.

                                                    {
     NotificationCategory category = Notifications.getCategory(defaultCategory);
     send(category, subject, message);
   }

◆ sendTemplate() [1/3]

void org.turro.mail.sender.AbstractMailSender.sendTemplate	(	NotificationCategory	category,
		Object	entity,
		String	template,
		String	subject
	)		throws EmailException

Implements org.turro.action.IMailSender.

Definition at line 291 of file AbstractMailSender.java.

                                                                                                                                 {
     doSendTemplate(category, entity, template, subject);
   }

◆ sendTemplate() [2/3]

void org.turro.mail.sender.AbstractMailSender.sendTemplate	(	Object	entity,
		String	template,
		String	subject
	)		throws EmailException

Implements org.turro.action.IMailSender.

Definition at line 285 of file AbstractMailSender.java.

                                                                                                  {
     NotificationCategory category = Notifications.getCategory(defaultCategory);
     sendTemplate(category, entity, template, subject);
   }

◆ sendTemplate() [3/3]

void org.turro.mail.sender.AbstractMailSender.sendTemplate	(	String	template,
		String	subject
	)		throws EmailException

Implements org.turro.action.IMailSender.

Definition at line 279 of file AbstractMailSender.java.

                                                                                   {
     NotificationCategory category = Notifications.getCategory(defaultCategory);
     sendTemplate(category, null, template, subject);
   }

◆ setCategory()

IMailSender org.turro.mail.sender.AbstractMailSender.setCategory ( String idCategory )

Implements org.turro.action.IMailSender.

Definition at line 63 of file AbstractMailSender.java.

                                                     {
     defaultCategory = idCategory;
     return this;
   }

◆ setFrom()

IMailSender org.turro.mail.sender.AbstractMailSender.setFrom ( IContact from )

Implements org.turro.action.IMailSender.

Definition at line 81 of file AbstractMailSender.java.

                                             {
     this.from = from;
     return this;
   }

◆ setPool()

IMailSender org.turro.mail.sender.AbstractMailSender.setPool ( String pool )

Implements org.turro.action.IMailSender.

Definition at line 75 of file AbstractMailSender.java.

                                           {
     this.pool = pool;
     return this;
   }

◆ setReason()

IMailSender org.turro.mail.sender.AbstractMailSender.setReason ( String reason )

Implements org.turro.action.IMailSender.

Definition at line 69 of file AbstractMailSender.java.

                                               {
     this.reason = reason;
     return this;
   }

◆ setRoot()

IMailSender org.turro.mail.sender.AbstractMailSender.setRoot ( String root )

Parameters

root	Templates' root on templates-mail/content. Defaults to / and must be prepended with a slash.

Returns

Implements org.turro.action.IMailSender.

Definition at line 101 of file AbstractMailSender.java.

                                           {
     this.root = root;
     return this;
   }

Here is the caller graph for this function:

◆ silentSendTemplate() [1/3]

void org.turro.mail.sender.AbstractMailSender.silentSendTemplate	(	NotificationCategory	category,
		Object	entity,
		String	template,
		String	subject
	)

Implements org.turro.action.IMailSender.

Definition at line 314 of file AbstractMailSender.java.

                                                                                                                 {
     try {
       sendTemplate(category, entity, template, subject);
     } catch (EmailException ex) {
       Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

◆ silentSendTemplate() [2/3]

void org.turro.mail.sender.AbstractMailSender.silentSendTemplate	(	Object	entity,
		String	template,
		String	subject
	)

Implements org.turro.action.IMailSender.

Definition at line 305 of file AbstractMailSender.java.

                                                                                  {
     try {
       sendTemplate(entity, template, subject);
     } catch (EmailException ex) {
       Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

◆ silentSendTemplate() [3/3]

void org.turro.mail.sender.AbstractMailSender.silentSendTemplate	(	String	template,
		String	subject
	)

Implements org.turro.action.IMailSender.

Definition at line 296 of file AbstractMailSender.java.

                                                                   {
     try {
       sendTemplate(template, subject);
     } catch (EmailException ex) {
       Logger.getLogger(AbstractMailSender.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

Member Data Documentation

◆ assistants

final AssistantSet org.turro.mail.sender.AbstractMailSender.assistants = new AssistantSet()

Definition at line 53 of file AbstractMailSender.java.

◆ attachments

Set<File> org.turro.mail.sender.AbstractMailSender.attachments = new HashSet<>()

protected

Definition at line 57 of file AbstractMailSender.java.

◆ defaultCategory

String org.turro.mail.sender.AbstractMailSender.defaultCategory = GenericElephantNotification.SYSTEM_NOTIFICATION

protected

Definition at line 55 of file AbstractMailSender.java.

◆ from

IContact org.turro.mail.sender.AbstractMailSender.from

protected

Definition at line 60 of file AbstractMailSender.java.

◆ mailAttachments

Set<MailAttachment> org.turro.mail.sender.AbstractMailSender.mailAttachments = new HashSet<>()

protected

Definition at line 58 of file AbstractMailSender.java.

◆ onStart

Consumer org.turro.mail.sender.AbstractMailSender.onStart

protected

Definition at line 59 of file AbstractMailSender.java.

◆ reason

String org.turro.mail.sender.AbstractMailSender.reason

protected

Definition at line 56 of file AbstractMailSender.java.

The documentation for this class was generated from the following file:

AbstractMailSender.java

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addAdministrators()

◆ addAssistant()

◆ addAssistants()

◆ addAttachment()

◆ addAttachments()

◆ addByEntity() [1/4]

◆ addByEntity() [2/4]

◆ addByEntity() [3/4]

◆ addByEntity() [4/4]

◆ addByRole()

◆ addBySyndication()

◆ addContact()

◆ addContacts()

◆ addMailAttachments()

◆ addUser()

◆ doSend()

◆ doSendTemplate()

◆ getAssistants()

◆ getAttributes()

◆ getFromString()

◆ isFromValid()

◆ onBuild()

◆ onCancel()

◆ onFinish()

◆ onStart()

◆ processMacros()

◆ put()

◆ putAll()

◆ putIf()

◆ removeAttachments()

◆ send() [1/2]

◆ send() [2/2]

◆ sendTemplate() [1/3]

◆ sendTemplate() [2/3]

◆ sendTemplate() [3/3]

◆ setCategory()

◆ setFrom()

◆ setPool()

◆ setReason()

◆ setRoot()

◆ silentSendTemplate() [1/3]

◆ silentSendTemplate() [2/3]

◆ silentSendTemplate() [3/3]

Member Data Documentation

◆ assistants

◆ attachments

◆ defaultCategory

◆ from

◆ mailAttachments

◆ onStart

◆ reason