flexagon.fd.services.groovy.functions

Class EmailFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.EmailFunctions

All Implemented Interfaces:

IEmailFunctions

public class EmailFunctions
extends BaseFunctions
implements IEmailFunctions

Utility functions used to send emails

Since:

5.4

Field Summary

Fields inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
EmailFunctions()
EmailFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
java.lang.String	getGroovyKey()
void	sendEmail(java.lang.String pSubject, java.lang.String pBody, java.util.Collection<java.lang.String> pRecipientAddresses) Sends emails using FlexDeploy's System Settings SMTP information to the Collection of email addresses specified.
void	sendEmail(java.lang.String pSubject, java.lang.String pBody, java.util.Collection<java.lang.String> pRecipientAddresses, java.util.Collection<EmailAttachment> pAttachments) Sends an email using FlexDeploy's System Settings SMTP information to the Collection of email addresses specified.
void	sendEmail(java.lang.String pSubject, java.lang.String pBody, java.lang.Long pGroupId) Sends an email using FlexDeploy's System Settings SMTP information to all users associated with FlexDeploy security group of specified Id.
void	sendEmail(java.lang.String pSubject, java.lang.String pBody, java.lang.Long pGroupId, java.util.Collection<EmailAttachment> pAttachments) Sends emails using FlexDeploy's System Settings SMTP information to all users associated with FlexDeploy security group of specified Id.
void	sendEmail(java.lang.String pSubject, java.lang.String pBody, SendEmailOptions pSendEmailOptions, java.util.Collection<EmailAttachment> pAttachments)

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailFunctions

public EmailFunctions()

EmailFunctions

public EmailFunctions(boolean isExecute,
                      LogFunctions pFLOG)

Method Detail

sendEmail

public void sendEmail(java.lang.String pSubject,
                      java.lang.String pBody,
                      java.lang.Long pGroupId)

Sends an email using FlexDeploy's System Settings SMTP information to all users associated with FlexDeploy security group of specified Id.

Specified by:

sendEmail in interface IEmailFunctions

Parameters:

pSubject - The subject line for the email.

pBody - The html body that will be used as the email body to be sent. A simple string can also be used instead of html.

pGroupId - The FlexDeploy security group that the email will be sent to.

sendEmail

public void sendEmail(java.lang.String pSubject,
                      java.lang.String pBody,
                      java.lang.Long pGroupId,
                      java.util.Collection<EmailAttachment> pAttachments)

Sends emails using FlexDeploy's System Settings SMTP information to all users associated with FlexDeploy security group of specified Id.

Specified by:

sendEmail in interface IEmailFunctions

Parameters:

pSubject - The subject line for the email.

pBody - The html body that will be used as the email body to be sent. A simple string can also be used instead of html.

pGroupId - The FlexDeploy security group that the email will be sent to.

pAttachments - Collection of EmailAttachment objects to include.

sendEmail

public void sendEmail(java.lang.String pSubject,
                      java.lang.String pBody,
                      java.util.Collection<java.lang.String> pRecipientAddresses)

Sends emails using FlexDeploy's System Settings SMTP information to the Collection of email addresses specified.

Specified by:

sendEmail in interface IEmailFunctions

Parameters:

pSubject - The subject line for the email.

pBody - The html body that will be used as the email body to be sent. A simple string can also be used instead of html.

pRecipientAddresses - A Collection of email addresses that the email will be sent to.

sendEmail

public void sendEmail(java.lang.String pSubject,
                      java.lang.String pBody,
                      java.util.Collection<java.lang.String> pRecipientAddresses,
                      java.util.Collection<EmailAttachment> pAttachments)

Sends an email using FlexDeploy's System Settings SMTP information to the Collection of email addresses specified.

Specified by:

sendEmail in interface IEmailFunctions

Parameters:

pSubject - The subject line for the email.

pBody - The html body that will be used as the email body to be sent. A simple string can also be used instead of html.

pRecipientAddresses - A Collection of email addresses that the email will be sent to.

pAttachments - Collection of EmailAttachment objects to include.

sendEmail

public void sendEmail(java.lang.String pSubject,
                      java.lang.String pBody,
                      SendEmailOptions pSendEmailOptions,
                      java.util.Collection<EmailAttachment> pAttachments)

Specified by:

sendEmail in interface IEmailFunctions

Parameters:

pSubject - The subject line for the email.

pBody - The html body that will be used as the email body to be sent. A simple string can also be used instead of html.

pSendEmailOptions - a SendEmailOptions POJO with the email recipients and aggregation settings.

pAttachments - Collection of EmailAttachment objects to include.

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in interface IEmailFunctions

Specified by:

getGroovyKey in class BaseFunctions

cleanup

public void cleanup()

Specified by:

cleanup in interface IEmailFunctions

Specified by:

cleanup in class BaseFunctions