com.ibm.commerce.emarketing.engine

Class URLEmailContent

  • java.lang.Object
    • com.ibm.commerce.emarketing.engine.URLEmailContent
  • All Implemented Interfaces:
    EmailContent

    public class URLEmailContent
extends java.lang.Object
implements EmailContent
    The implementation of EmailContent that uses a URL to fetch the content of e-mail messages. Attention should be paid to the requirements that getSubject() places on resources pointed to by such URLs.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright.

    • Constructor Summary

      Constructors 
      Constructor and Description
      URLEmailContent(java.lang.String url)
      Constructor for this class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getContent()
      Gets the e-mail message content.
      java.lang.String getSubject()
      Gets the subject line from the url used for retrieving e-mail message content.
      java.lang.String getUrl()
      Gets the url used for retreiving e-mail message content.
      void setUrl(java.lang.String url)
      Sets the url used for retreiving e-mail message content.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

    • Constructor Detail

      • URLEmailContent

        public URLEmailContent(java.lang.String url)
        Constructor for this class.
        Parameters:
        url - The url to use for the e-mail message content represented as a String.

    • Method Detail

      • getContent

        public java.lang.String getContent()
        Gets the e-mail message content.
        Specified by:
        getContent in interface EmailContent
        Returns:
        The string representation of the e-mail message.

      • getSubject

        public java.lang.String getSubject()
        Gets the subject line from the url used for retrieving e-mail message content. This method adds "returnSubject=true" to the url to indicate the url call is requesting the subject line. The resource to which the url points must be capable of reading this query string parameter and returning only the subject line when it is set to true.
        Specified by:
        getSubject in interface EmailContent
        Returns:
        The string the url returned (the subject line of the e-mail message).

      • getUrl

        public java.lang.String getUrl()
        Gets the url used for retreiving e-mail message content.
        Returns:
        the url used to retrieve the e-mail message content.

      • setUrl

        public void setUrl(java.lang.String url)
        Sets the url used for retreiving e-mail message content.
        Parameters:
        url - the url used to retrieve the e-mail message content.
Skip navigation links