com.socketLabs.injectionApi.message.BasicMessage 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.message;
import javax.annotation.Nullable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* A Basic email message similar to one created in a personal email client such as Outlook.
* This message can have many recipients of different types, such as To, CC, and BCC. This
* message does not support merge fields.
* Example:
*
* {@code
* BasicMessage message = new BasicMessage();
*
* message.setSubject("Sending A Message");
* message.setHtmlBody("<html>This is the Html Body of my message.</html>");
* message.setPlainTextBody("This is the Plain Text Body of my message.");
* message.setAmpBody("This is the Amp Body of my message.");
*
* message.setFrom(new EmailAddress("[email protected]"));
* message.setReplyTo(new EmailAddress("[email protected]"));
*
* message.getTo().add(new EmailAddress("[email protected]"));
* message.getTo().add(new EmailAddress("[email protected]", "Recipient #2"));
*
* message.addToEmailAddress("[email protected]");
* message.addToEmailAddress("[email protected]", "Recipient #4");
* }
*
*/
public class BasicMessage implements MessageBase {
/**
* The list of To recipients.
*/
private List to = new ArrayList<>();
/**
* The list of CC recipients.
*/
private List cc = new ArrayList<>();
/**
* The list of BCC recipients.
*/
private List bcc = new ArrayList<>();
/**
* The message Subject.
*/
private String subject;
/**
* The plain text portion of the message body.
*
* (Optional)
* Either PlainTextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
*
*/
private String plainTextBody;
/**
* The HTML portion of the message body.
*
* (Optional)
* Either PlainTextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
*
*/
private String htmlBody;
/**
* The AMP portion of the message body.
*
* (Optional)
* Either PlainTextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
*
*/
private String ampBody;
/**
* The Api Template for the message.
*
* (Optional)
* Either PlainTextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
*
*/
private @Nullable Integer apiTemplate;
/**
* The custom MailingId for the message.
*
* (Optional)
* See https://www.socketlabs.com/blog/best-practices-for-using-custom-mailingids-and-messageids/ for more information.
*
*/
private String mailingId;
/**
* The custom MessageId for the message.
*
* (Optional)
*
*/
private String messageId;
/**
* The From address.
*/
private EmailAddress from;
/**
* The ReplyTo address for the message.
*
* (Optional)
*
*/
private EmailAddress replyTo;
/**
* The list of attachments.
*
* (Optional)
*
*/
private List attachments = new ArrayList<>();
/**
* The optional character set for your message.
*
* (Optional)
* Default is UTF8
*
*/
private String charSet;
/**
* A list of custom message headers added to the message.
*
* (Optional)
*
*/
private List customHeaders = new ArrayList<>();
/**
* A list of metadata items added to the message.
*
* (Optional)
*
*/
private List metadata = new ArrayList<>();
/**
* A list of tags added to the message.
*
* (Optional)
*
*/
private List tags = new ArrayList<>();
/**
* Initializes a new instance of the BasicMessage class
* {@code BasicMessage messsage = new BasicMessage();}
*/
public BasicMessage() {
}
/**
* Gets the list of To recipients.
* @return {@code List}
*/
public List getTo() { return this.to; }
/**
* Sets the list of To recipients.
* @param value {@code List}
*/
public void setTo(List value) { this.to = value; }
/**
* Add an EmailAddress to the array of To recipients
* @param emailAddress String
*/
public void addToEmailAddress(String emailAddress) {
this.to.add(new EmailAddress(emailAddress));
}
/**
* Add an EmailAddress to the array of To recipients
* @param emailAddress String
* @param name String
*/
public void addToEmailAddress(String emailAddress, String name) {
this.to.add(new EmailAddress(emailAddress, name ));
}
/**
* Add an EmailAddress to the array of To recipients
* @param emailAddress String
*/
public void addToEmailAddress(EmailAddress emailAddress) {
this.to.add(emailAddress);
}
public List getCc() { return this.cc; }
public void setCc(List value) { this.cc = value; }
/**
* Add an EmailAddress to the array of CC recipients
* @param emailAddress String
*/
public void addCcEmailAddress(String emailAddress) {
this.cc.add(new EmailAddress(emailAddress));
}
/**
* Add an EmailAddress to the array of CC recipients
* @param emailAddress String
* @param name String
*/
public void addCcEmailAddress(String emailAddress, String name) {
this.cc.add(new EmailAddress(emailAddress, name ));
}
/**
* Add an EmailAddress to the array of CC recipients
* @param emailAddress String
*/
public void addCcEmailAddress(EmailAddress emailAddress) {
this.cc.add(emailAddress);
}
public List getBcc() { return this.bcc; }
public void setBcc(List value) { this.bcc = value; }
/**
* Add an EmailAddress to the array of BCC recipients
* @param emailAddress String
*/
public void addBccEmailAddress(String emailAddress) {
this.bcc.add(new EmailAddress(emailAddress));
}
/**
* Add an EmailAddress to the array of BCC recipients
* @param emailAddress String
* @param name String
*/
public void addBccEmailAddress(String emailAddress, String name) {
this.bcc.add(new EmailAddress(emailAddress, name ));
}
/**
* Add an EmailAddress to the array of BCC recipients
* @param emailAddress String
*/
public void addBccEmailAddress(EmailAddress emailAddress) {
this.bcc.add(emailAddress);
}
/**
* Gets the instance of the message Subject.
* @return String
*/
@Override
public String getSubject() { return this.subject; }
/**
* Sets the instance of the message Subject
* @param value String
*/
@Override
public void setSubject(String value) { this.subject = value; }
/**
* Gets the plain text portion of the message body.
* @return String
*/
@Override
public String getPlainTextBody() { return this.plainTextBody; }
/**
* Gets the plain text portion of the message body.
* @param value String
*/
@Override
public void setPlainTextBody(String value) { this.plainTextBody = value; }
/**
* Gets the HTML portion of the message body.
* @return String
*/
@Override
public String getHtmlBody() { return this.htmlBody; }
/**
* Sets the HTML portion of the message body.
* @param value String
*/
@Override
public void setHtmlBody(String value) { this.htmlBody = value; }
/**
* Gets the AMP portion of the message body.
* @return String
*/
@Override
public String getAmpBody() { return this.ampBody; }
/**
* Sets the AMP portion of the message body.
* @param value String
*/
@Override
public void setAmpBody(String value) { this.ampBody = value; }
/**
* Gets the Api Template for the message.
* @return Integer
*/
@Override
public @Nullable Integer getApiTemplate() { return (this.apiTemplate == null) ? null : this.apiTemplate; }
/**
* Sets the Api Template for the message.
* @param value Integer
*/
@Override
public void setApiTemplate(@Nullable Integer value) { this.apiTemplate = value; }
/**
* Gets the custom MailingId for the message.
* @return String
*/
@Override
public String getMailingId() { return this.mailingId; }
/**
* Sets the custom MailingId for the message.
* @param value String
*/
@Override
public void setMailingId(String value) { this.mailingId = value; }
/**
* Gets the custom MessageId for the message.
* @return String
*/
@Override
public String getMessageId() { return this.messageId; }
/**
* Sets the custom MailingId for the message.
* @param value String
*/
@Override
public void setMessageId(String value) { this.messageId = value; }
/**
* Gets the From address.
* @return EmailAddress
*/
@Override
public EmailAddress getFrom() { return this.from; }
/**
* Sets the From address.
* @param value EmailAddress
*/
@Override
public void setFrom(EmailAddress value) { this.from = value; }
/**
* Gets the Reply To address.
* @return EmailAddress
*/
@Override
public EmailAddress getReplyTo() { return this.replyTo; }
/**
* Sets the Reply To address.
* @param value EmailAddress
*/
@Override
public void setReplyTo(EmailAddress value) { this.replyTo = value; }
/**
* Gets the list of attachments.
* @return {@code List}
*/
@Override
public List getAttachments() { return this.attachments; }
/**
* Sets the list of attachments.
* @param value {@code List}
*/
@Override
public void setAttachments(List value) { this.attachments = value; }
/**
* Add an attachment to the array of Attachment items using the filePath
* @param filePath The path to your attachment on your local system.
* @throws IOException IOException
*/
public void addAttachments(String filePath) throws IOException {
this.attachments.add(new Attachment(filePath));
}
/**
* Add an Attachment to the array of Attachment items
* @param attachment Attachment
* @throws IOException IOException
*/
public void addAttachments(Attachment attachment) throws IOException {
this.attachments.add(attachment);
}
/**
* Gets the optional character set for your message.
* @return String
*/
@Override
public String getCharSet() { return this.charSet; }
/**
* Sets the optional character set for your message.
* @param value String
*/
@Override
public void setCharSet(String value) { this.charSet = value; }
/**
* Gets the list of custom message headers added to the message.
* @return {@code List}
*/
@Override
public List getCustomHeaders() { return this.customHeaders; }
/**
* Sets the list of custom message headers added to the message.
* @param value {@code List}
*/
@Override
public void setCustomHeaders(List value) { this.customHeaders = value; }
/**
* Add a CustomHeader to the message
* @param name String
* @param value String
*/
public void addCustomHeader(String name, String value) {
this.customHeaders.add(new CustomHeader(name, value ));
}
/**
* Add a CustomHeader to the message
* @param header CustomHeaderJson
*/
public void addCustomHeader(CustomHeader header) {
this.customHeaders.add(header);
}
/**
* Gets the list of metadata items added to the message.
* @return {@code List}
*/
@Override
public List getMetadata() { return this.metadata; }
/**
* Sets the list of metadata items added to the message.
* @param value {@code List}
*/
@Override
public void setMetadata(List value) { this.metadata = value; }
/**
* Add a Metadata to the message
* @param name String
* @param value String
*/
public void addMetadata(String name, String value) {
this.metadata.add(new Metadata(name, value ));
}
/**
* Add a Metadata to the message
* @param header Metadata
*/
public void addMetadata(Metadata header) {
this.metadata.add(header);
}
/**
* Gets the list of metadata items added to the message.
* @return {@code List}
*/
@Override
public List getTags() { return this.tags; }
/**
* Sets the list of metadata items added to the message.
* @param value {@code List}
*/
@Override
public void setTags(List value) { this.tags = value; }
/**
* Add a Tag to the message
* @param value String
*/
public void addTags(String value) {
this.tags.add(value);
}
/**
* Returns the number of recipients and subject for the message, useful for debugging.
* @return String
*/
@Override
public String toString() {
return String.format("Recipients: %d, Subject, %s", this.to.size(), this.subject);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy