Interface EmailService
- All Known Implementing Classes:
DefaultEmailService
public interface EmailService
Handles creation and sending of emails.
-
Method Summary
Modifier and TypeMethodDescriptioncreateEmailAttachment(DataInputStream masterDataStream, String filename, String mimeType) Creates an email attachment from an input stream.createEmailMessage(List<EmailAddressModel> toAddresses, List<EmailAddressModel> ccAddresses, List<EmailAddressModel> bccAddresses, EmailAddressModel fromAddress, String replyToAddress, String subject, String body, List<EmailAttachmentModel> attachments) Creates and EmailMessage object.getOrCreateEmailAddressForEmail(String emailAddress, String displayName) Returns aEmailAddressModel.booleansend(EmailMessageModel message) Sends an email
-
Method Details
-
getOrCreateEmailAddressForEmail
Returns aEmailAddressModel. Instance is found for the given email address and display name criteria. If there is no instance for this condition the newEmailAddressModelinstance is returned based on the given criteria.- Parameters:
emailAddress- Email iddisplayName- Display name- Returns:
- EmailAddress object
-
createEmailAttachment
EmailAttachmentModel createEmailAttachment(DataInputStream masterDataStream, String filename, String mimeType) Creates an email attachment from an input stream.- Parameters:
masterDataStream- Input data streamfilename- File namemimeType- Mime type- Returns:
- EmailAttachment object
-
createEmailMessage
EmailMessageModel createEmailMessage(List<EmailAddressModel> toAddresses, List<EmailAddressModel> ccAddresses, List<EmailAddressModel> bccAddresses, EmailAddressModel fromAddress, String replyToAddress, String subject, String body, List<EmailAttachmentModel> attachments) Creates and EmailMessage object.- Parameters:
toAddresses- List of To email addressesccAddresses- List of CC email addressesbccAddresses- List of BCC email addressesfromAddress- From email addressreplyToAddress- Reply To email addresssubject- Subject of the emailbody- Contents of the emailattachments- List of email attachments- Returns:
- EmailMessage object
-
send
Sends an email- Parameters:
message- EmailMessage- Returns:
- true if successful
-