Interface EmailService
-
- All Known Implementing Classes:
DefaultEmailService
public interface EmailService
Handles creation and sending of emails.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EmailAttachmentModel
createEmailAttachment(java.io.DataInputStream masterDataStream, java.lang.String filename, java.lang.String mimeType)
Creates an email attachment from an input stream.EmailMessageModel
createEmailMessage(java.util.List<EmailAddressModel> toAddresses, java.util.List<EmailAddressModel> ccAddresses, java.util.List<EmailAddressModel> bccAddresses, EmailAddressModel fromAddress, java.lang.String replyToAddress, java.lang.String subject, java.lang.String body, java.util.List<EmailAttachmentModel> attachments)
Creates and EmailMessage object.EmailAddressModel
getOrCreateEmailAddressForEmail(java.lang.String emailAddress, java.lang.String displayName)
Returns aEmailAddressModel
.boolean
send(EmailMessageModel message)
Sends an email
-
-
-
Method Detail
-
getOrCreateEmailAddressForEmail
EmailAddressModel getOrCreateEmailAddressForEmail(java.lang.String emailAddress, java.lang.String displayName)
Returns aEmailAddressModel
. Instance is found for the given email address and display name criteria. If there is no instance for this condition the newEmailAddressModel
instance is returned based on the given criteria.- Parameters:
emailAddress
- Email iddisplayName
- Display name- Returns:
- EmailAddress object
-
createEmailAttachment
EmailAttachmentModel createEmailAttachment(java.io.DataInputStream masterDataStream, java.lang.String filename, java.lang.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(java.util.List<EmailAddressModel> toAddresses, java.util.List<EmailAddressModel> ccAddresses, java.util.List<EmailAddressModel> bccAddresses, EmailAddressModel fromAddress, java.lang.String replyToAddress, java.lang.String subject, java.lang.String body, java.util.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
boolean send(EmailMessageModel message)
Sends an email- Parameters:
message
- EmailMessage- Returns:
- true if successful
-
-