Configuring Brightspot for email submissions

Administrators perform this task.

After configuring your AWS account as described in Configuring AWS for email submissions, follow the procedures below to configure Brightspot for submitting content over email.

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

Configuring the bounce and complaint interface

If you configured bounce and complaint notifications in the Amazon SES console, you can optionally turn on support for these notifications in Brightspot.

To configure the bounce and complaint interface:

  1. From the Navigation menu, select Admin > Sites & Settings.
  2. In the Sites widget, click Global. The Edit Global widget appears.
  3. Under 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.

Activating mail ingestion

To activate email ingestion:

  1. From the Navigation menu, select Admin > Sites & Settings.
  2. In the Sites widget, click Global. The Edit Global widget appears.
  3. Under 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.

Configuring an email ingestor

An email ingestor performs the following:

  • Strips the signatures that some email clients automatically attach to the end of an email’s body.
  • Provides the “from” address on the confirmation email Brightspot sends to an editor who submitted content via email.

To configure an email ingestor:

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

  2. In the Sites widget, click Global. The Edit Global widget appears.

  3. Under Main, expand Email to CMS.

    ../../../_images/mail-publisher.png
  4. If you want to use a different ingestor than the current one, do the following:

    1. Click search. A content picker appears.

    2. If you want to use one of the available publishers, select it and skip to step 4j.

    3. Click New Mail to Content Mapper. A content edit page appears.

      ../../../_images/custom-ingestor.png
    4. In the Display name field, enter a name for this ingestor.

    5. In the Signature Stripping Pattern field, do one of the following:

      • Select Standard to select patterns that typically introduce an email signature.
      • Select Custom to compose patterns that you expect to introduce an email signature.
    6. In the Response From Email field, enter a “from” email address that Brightspot uses when sending a confirmation or error message to the editor regarding the submission. 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 is blank, Brightspot does not send confirmation emails.

    7. Click Save.

    8. Click Back to Select Mail Publisher. You return to the content picker.

    9. Select the ingestor you just created. You return to the Edit Global widget.

    10. Click Save.

Mail content mappings

Brightspot uses mail content mappings to transform an email submission to an actual item, such as to an article or an image. This section describes how to configure the fields in an article or an image so that editors can submit them over email. If you want to enable mappings for other content types, contact your Brightspot developer.

To create a mail content mapping:

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

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

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

  4. Under Mail Content Mappings, click add_circle_outline. A Mail Content Mapping form appears.

    ../../../_images/mail_mapping_form.png
  5. In the Receiving Email field, enter a “to” address to which editors submit content for a given content type.

    • For the username, as a best practice use the content type, such as article or image.
    • For the domain, use the Brightspot domain that you set in the AWS SES configuration.
    • Examples of “to” addresses are article@brightspot.dev.example.com and image@brightspot.dev.example.com.

    Caution

    If you are configuring mail content mappings for multiple sites, ensure that the receiving email addresses are unique across sites.

  6. Under Parsing Method, set Field Delimiter to the symbol for indicating a field name in an email. For example, if you enter #, then editors prefix the field names in their emails with an octothorpe (as in the sample Submitting content via email).

  7. Under Content type, and using the table Options for article and image converters as a reference, configure the converter to be used for an email sent to this address, and then set the field options. For some fields, you can select a markdown or simple processor to convert the field. If you configure a field to use a markdown processor, editors can include text formatting such as boldface and italics.

  8. To publish submitted articles immediately, turn on Publish Immediately.

  9. Click Save.

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 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. Editors can enter comma-separated values to associate the article with one or more sections.
Tags Processor Specify the name of the tags field as found in the article content type. Editors can enter comma-separated values to associate and articles with one or more tags.
Image Email Converter Caption Processor Set the type of processor for the field used for 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. Editors can enter comma-separated values to associate the image with one or more tags.