Interface EmailService

  • All Known Implementing Classes:
    DefaultEmailService

    public interface EmailService
    Handles creation and sending of emails.
    • Method Detail

      • getOrCreateEmailAddressForEmail

        EmailAddressModel getOrCreateEmailAddressForEmail​(java.lang.String emailAddress,
                                                          java.lang.String displayName)
        Returns a EmailAddressModel. Instance is found for the given email address and display name criteria. If there is no instance for this condition the new EmailAddressModel instance is returned based on the given criteria.
        Parameters:
        emailAddress - Email id
        displayName - 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 stream
        filename - File name
        mimeType - 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 addresses
        ccAddresses - List of CC email addresses
        bccAddresses - List of BCC email addresses
        fromAddress - From email address
        replyToAddress - Reply To email address
        subject - Subject of the email
        body - Contents of the email
        attachments - List of email attachments
        Returns:
        EmailMessage object
      • send

        boolean send​(EmailMessageModel message)
        Sends an email
        Parameters:
        message - EmailMessage
        Returns:
        true if successful