com.socketLabs.injectionApi.core.SendValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of injectionApi Show documentation
Show all versions of injectionApi Show documentation
SocketLabs Email Delivery Java library
package com.socketLabs.injectionApi.core;
import com.socketLabs.injectionApi.*;
import com.socketLabs.injectionApi.message.*;
import java.util.ArrayList;
import java.util.List;
public class SendValidator {
private int MaximumRecipientsPerMessage = 50;
/**
* Validate the ServerId and Api Key pair prior before sending to the Injection API.
* @param serverId Your SocketLabs ServerId number.
* @param apiKey Your SocketLabs Injection API key.
* @return A SendResponse with the validation results
*/
public SendResponse ValidateCredentials(int serverId, String apiKey) {
if (isNullOrEmpty(apiKey))
return new SendResponse(SendResult.AuthenticationValidationFailed);
if (serverId <= 0)
return new SendResponse(SendResult.AuthenticationValidationFailed);
return new SendResponse(SendResult.Success);
}
/**
* Validate a Basic email message before sending to the Injection API.
* @param message An BasicMessage object to be sent.
* @return A SendResponse with the validation results
*/
public SendResponse ValidateMessage(BasicMessage message)
{
SendResult result = ValidateMessageBase(message);
if (result == SendResult.Success)
return ValidateRecipients(message);
return new SendResponse(result);
}
/**
*Validate a Bulk email message before sending to the Injection API.
* @param message An BulkMessage object to be sent.
* @return A SendResponse with the validation results
*/
public SendResponse ValidateMessage(BulkMessage message)
{
SendResult result = ValidateMessageBase(message);
if (result == SendResult.Success)
return ValidateRecipients(message);
return new SendResponse(result);
}
/**
* Validate the required fields of a message. Fields validated are Subject, From AddressJson, Reply To (if set), Message Body, and Custom Headers (if set)
* @param message The base interface, MessageBase, of the message to be sent.
* @return The validation result as SendResult
*/
private SendResult ValidateMessageBase(MessageBase message)
{
if (!HasSubject(message)) return SendResult.MessageValidationEmptySubject;
if (!HasFromAddress(message)) return SendResult.EmailAddressValidationMissingFrom;
if (!message.getFrom().isValid()) return SendResult.EmailAddressValidationInvalidFrom;
if (!HasValidReplyTo(message)) return SendResult.RecipientValidationInvalidReplyTo;
if (!HasMessageBody(message)) return SendResult.MessageValidationEmptyMessage;
if (message.getCustomHeaders() != null && !message.getCustomHeaders().isEmpty())
if (!HasValidCustomHeaders(message.getCustomHeaders())) return SendResult.MessageValidationInvalidCustomHeaders;
if (message.getMetadata() != null && !message.getMetadata().isEmpty())
if (!HasValidMetadata(message.getMetadata())) return SendResult.MessageValidationInvalidMetadata;
return SendResult.Success;
}
/**
* Check if the message has a subject
* @param message The base interface, MessageBase, of the message to be sent.
* @return boolean result
*/
private boolean HasSubject(MessageBase message)
{
return !isNullOrEmpty(message.getSubject());
}
/**
* Check if the message has a valid From Email AddressJson
* @param message The base interface, MessageBase, of the message to be sent.
* @return boolean result
*/
private boolean HasFromAddress(MessageBase message)
{
if (message.getFrom() == null)
return false;
return (!isNullOrEmpty(message.getFrom().getEmailAddress()));
}
/**
* Check if the message has a Message Body.
* If an Api Template is specified it will override the HtmlBody, AmpBody, and/or the PlainTextBody.
* If no Api Template is specified the HtmlBody and/or the PlainTextBody must be set
* @param message The base interface, MessageBase, of the message to be sent.
* @return boolean result
*/
private boolean HasMessageBody(MessageBase message)
{
boolean hasApiTemplate = HasApiTemplate(message);
if (hasApiTemplate) return true;
boolean hasHtmlBody = !isNullOrEmpty(message.getHtmlBody());
boolean hasPlainTextBody = !isNullOrEmpty(message.getPlainTextBody());
return (hasHtmlBody || hasPlainTextBody);
}
/**
* Check if an ApiTemplate was specified and is valid.
* @param message The base interface, MessageBase, of the message to be sent.
* @return boolean result
*/
private boolean HasApiTemplate(MessageBase message)
{
return (message.getApiTemplate() == null || message.getApiTemplate() != 0);
}
/**
* If set, check if a ReplyTo email address is valid
* @param message The base interface, MessageBase, of the message to be sent.
* @return boolean result
*/
private boolean HasValidReplyTo(MessageBase message)
{
if (message.getReplyTo() == null) return true;
if (isNullOrEmpty(message.getReplyTo().getEmailAddress()) && isNullOrEmpty(message.getReplyTo().getFriendlyName())) return true;
return message.getReplyTo().isValid();
}
/**
* Validate email recipients for a Basic message
* Checks the To, Cc, and the Bcc recipient fields (List of IEmailAddress) for the following:
* > At least 1 recipient is in the list.
* > Cumulative count of recipients in all 3 lists do not exceed the MaximumRecipientsPerMessage.
* > Recipients in lists are valid.
* If errors are found, the SendResponse will contain the invalid email addresses
* @param message An BasicMessage object to be sent.
* @return A SendResponse with the validation results.
*/
private SendResponse ValidateRecipients(BasicMessage message)
{
int fullRecipientCount = GetFullRecipientCount(message);
if (fullRecipientCount <= 0) return new SendResponse(SendResult.RecipientValidationNoneInMessage);
if (fullRecipientCount > MaximumRecipientsPerMessage) return new SendResponse(SendResult.RecipientValidationMaxExceeded);
List invalidRec = HasInvalidRecipients(message);
if (invalidRec != null && !invalidRec.isEmpty())
return new SendResponse(SendResult.RecipientValidationInvalidRecipients, invalidRec);
return new SendResponse(SendResult.Success);
}
/**
* Validate email recipients for a Bulk message
* Checks the To recipient field (List of BulkRecipient) for the following:
* > At least 1 recipient is in the list.
* > Cumulative count of recipients in all 3 lists do not exceed the MaximumRecipientsPerMessage.
* > Recipients in lists are valid.
* If errors are found, the SendResponse will contain the invalid email addresses
* @param message An BulkMessage object to be sent.
* @return A SendResponse with the validation results.
*/
private SendResponse ValidateRecipients(BulkMessage message)
{
if (message.getTo() == null || message.getTo().size() <= 0) return new SendResponse(SendResult.RecipientValidationMissingTo);
if (message.getTo().size() > MaximumRecipientsPerMessage) return new SendResponse(SendResult.RecipientValidationMaxExceeded);
List invalidRec = HasInvalidRecipients(message);
if (invalidRec != null && !invalidRec.isEmpty())
return new SendResponse(SendResult.RecipientValidationInvalidRecipients, invalidRec);
return new SendResponse(SendResult.Success);
}
/**
* Cumulative count of recipients in all 3 recipient lists To, Cc, and Bcc (List of EmailAddress)
* @param message An BasicMessage object to be sent.
* @return an int count of recipients
*/
private int GetFullRecipientCount(BasicMessage message)
{
int recipientCount = 0;
if (message.getTo() != null)
recipientCount += message.getTo().size();
if (message.getCc() != null)
recipientCount += message.getCc().size();
if (message.getBcc() != null)
recipientCount += message.getBcc().size();
return recipientCount;
}
/**
* Check all 3 recipient lists To, Cc, and Bcc (List of EmailAddress) for valid email addresses
* @param message An BasicMessage object to be sent.
* @return A List of AddressResult if an invalid email address is found.
*/
private List HasInvalidRecipients(BasicMessage message)
{
List result = new ArrayList<>();
List invalidTo = FindInvalidEmailAddresses(message.getTo());
if (invalidTo != null && !invalidTo.isEmpty())
result.addAll(invalidTo);
List invalidCc = FindInvalidEmailAddresses(message.getCc());
if (invalidCc != null && !invalidCc.isEmpty())
result.addAll(invalidCc);
List invalidBcc = FindInvalidEmailAddresses(message.getBcc());
if (invalidBcc != null && !invalidBcc.isEmpty())
result.addAll(invalidBcc);
return result;
}
/**
* Check the To recipient list (List of BulkMessage) for valid email addresses.
* @param message An BulkMessage object to be sent.
* @return A List of AddressResult if an invalid email address is found.
*/
private List HasInvalidRecipients(BulkMessage message)
{
List result = new ArrayList<>();
List invalidTo = FindInvalidRecipients(message.getTo());
if (invalidTo != null && !invalidTo.isEmpty())
result.addAll(invalidTo);
return result;
}
/**
* Check List for valid email addresses
* @param recipients List to validate
* @return A List if an invalid email address is found.
*/
private List FindInvalidEmailAddresses(List recipients)
{
List invalid = new ArrayList<>();
for(EmailAddress r: recipients) {
if (!r.isValid()) {
invalid.add(new AddressResult(r.getEmailAddress(), false, "InvalidAddress"));
}
}
return !invalid.isEmpty()? invalid: null;
}
/**
* Check List for valid email addresses
* @param recipients List to validate
* @return A List if an invalid email address is found.
*/
private List FindInvalidRecipients(List recipients)
{
List invalid = new ArrayList<>();
for(BulkRecipient r: recipients) {
if (!r.isValid()) {
invalid.add(new AddressResult(r.getEmailAddress(), false, "InvalidAddress"));
}
}
return !invalid.isEmpty()? invalid: null;
}
/**
* Check if CustomHeader in List are valid.
* @param customHeaders List to validate
* @return boolean result
*/
private boolean HasValidCustomHeaders(List customHeaders)
{
for (CustomHeader c : customHeaders) {
if (!c.isValid()) return false;
}
return true;
}
/**
* Check if Metadata in List are valid.
* @param metadata List to validate
* @return boolean result
*/
private boolean HasValidMetadata(List metadata)
{
for (Metadata m : metadata) {
if (!m.isValid()) return false;
}
return true;
}
/**
* Check if string is null or empyt
* @param string String to check
* @return boolean
*/
private boolean isNullOrEmpty(String string) {
if (string == null) return true;
if (string.isEmpty()) return true;
return string.trim().equals("");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy