Configuring Brightspot

Administrators perform this task.

After configuring AWS services, follow the procedures below to configure Brightspot for Mail Publishing.

If your Brightspot deployment is missing any of the following configuration options, contact your Brightspot developer.

AWS SES

If you configured bounce and complaint notifications in the Amazon SES console, you can optionally turn on support for these notifications in Brightspot. See SES (Simple Email Service).

  1. From the Navigation Menu, select Admin > Sites & Settings.
  2. In the Sites widget, select Global.
  3. In Main, expand AWS SES.
  4. Turn on Enable Bounce and Complaint Notification Service.
  5. Set the queue name fields to match the queue names that you set in the Amazon SES console.
  6. Click Save.

Mail Publishing

  1. From the Navigation Menu, select Admin > Sites & Settings.
  2. In the Sites widget, select Global.
  3. In Main, expand Mail Publishing.
  4. Set S3Region to the AWS region where your queue resides. See SQS (Simple Queue Service).
  5. Set Queue Name to the name of the queue.
  6. Click Save.

Content Mapper

The content mapper converts Emails to article and image instances using mail content mappings.

Brightspot provides a default content mapper that strips signatures from incoming Emails, and provides a field to set an Email address from which to send response emails back to clients. When Brightspot successfully receives an Email, it sends the originator a confirmation Email with links to the generated content. If there are errors while publishing, Brightspot sends the originator a response detailing the errors.

Brightspot automatically uses the default mapper, unless you replace it with a custom mapper.

  1. From the Navigation Menu, select Admin > Sites & Settings.

  2. In the Sites widget, select Global.

  3. In Main, expand Email to CMS. The Mail Publisher field appears, showing that the Default mapper is set.

    ../../../_images/mail_publisher.png

    Using the selection field, you can modify the default mapper, or you can create a custom mapper.

  4. To modify the default mapper, click edit. A Content Edit form appears.

  5. Change the default values for the following fields:

    • Display name – The name of the configuration for the default mapper.

    • Signature Stripping Pattern – The HTML or text pattern that the content mapper attempts to match to identify an email signature. If the pattern is found, the content mapper strips the signature.

      If you expect users to have signatures in their emails that begin with a line of --, select Standard. Otherwise, select Custom and add anticipated patterns.

    • Response From Email – The Email address from which to send a response Email to the sender. The domain name must match the Brightspot domain that you set in the AWS SES configuration. If it does not match the Brightspot domain, or left blank, Brightspot does not send response emails.

  6. Click Save.

  7. Click Back to return to the Mail Publisher field.

  8. Click Save.

Mail Content Mappings

Mail content mappings are used by the content mapper to transform article or image fields specified in an Email body to content contained in an article or image instance in Brightspot.

  1. From the Navigation Menu, select Admin > Sites & Settings.

  2. In the Sites widget, select the site to which you want emailed articles to be published. The site you select will become the owner of article or images emailed to the site.

  3. In Front-End, expand Email to CMS.

  4. Click add_circle_outline to add a mail content mapping. A Mail Content Mapping form appears. This form associates a receiving Email address with a converter that transforms either an emailed article or image to an article or image instance in Brightspot.

    ../../../_images/mail_mapping_form.png
  5. Set Receiving Email to an address that triggers publishing to occur for the content type. The domain name must match the Brightspot domain that you set in the AWS SES configuration.

    The address you enter here will be used by Email contributors. For example, if you set article@brightspot.com for the article content type, contributors will use that address for submitting articles. If you set image@brightspot.com for the image content type, contributors will use that address for submitting images.

    Note

    If you are configuring mail content mappings for multiple sites, make sure that the receiving Email addresses are unique across sites.

  6. Under Parsing Method, set Field Delimiter to a value that indicates how to delimit a content type field in an Email. For example, if # is used as a delimiter, then a Email contributor would indicate an article headline as follows: #headline. See Overview.

  7. Under Content type, set the type of converter to be used for an Email sent to this address, and then set the field options. Depending on the converter, a different set of fields appears, as described in the following table.

    Note that for some fields, you can select either a Markdown or simple processor to convert the field. For fields transformed by the Markdown processor, Email contributors can mark up text with Markdown syntax. Brightspot converts Markdown syntax to rich text.

    Options for Article and Image Converters
    Converter Field Description
    Article Email Converter Headline Processor Set the type of processor for the field used as a headline, and specify the name of the field as found in the article content type.
      Body Processor Set the type of processor for the article field used for body text, and specify the name of the field as found in the article content type.
      Section Processor Specify the name of the section field as found in the article content type. Contributors can enter comma-separated values to associate the article with one or more section instances.
      Tags Processor Specify the name of the tags field as found in the article content type. Contributors can enter comma-separated values to associate the articles with one or more tag instances.
    Image Email Converter Caption Processor Set the type of processor for the field used as a caption, and specify the name of the field as found in the image content type.
      Tags Processor Specify the name of the tags field as found in the image content type. Contributors can enter comma-separated values to associate the image with one or more tag instances.
  8. If you do not want the default behavior of saving emailed articles or images as drafts, turn on Publish Immediately.

  9. Click Save.