Emailing plan subscribers

As a site administrator, you can use the email Plan subscribers wizard to send messages to all subscribers of a chosen plan that belongs to a specific product on your Developer Portal.

1. Navigate to People > Email subscribers.
2. Select Plan subscribers, and click Save.
3. In the text box, enter the name of the product whose subscribers you want to email. If you start typing in the text box, you can choose from the options that you are given. Click Next.
   Note: You can select more than one product as a comma-separated list.
4. Select the name of the plan whose subscribers you want to email. Click Next.
5. Select the role of the recipients that you want to send the email to, then click Next.
   • Owners - sends the email to the relevant consumer organization owners.
   • Members - sends the email to all members of the relevant consumer organizations.
6. Enter the content of the email, subject, and body, and set the Text Format of the email:
   • Basic HTML
   • Plain text
7. Expand the REPLACEMENTS drop-down, and click Browse available tokens to view which tokens can be added to the subject and body fields for replacement.

   You can select a token to use by either typing it directly, or by clicking in the subject or body field. You are then given a list of available tokens, and you can insert the token that you want. For a reference list of tokens, see Token reference.

8. Expand the ADDITIONAL EMAIL OPTIONS drop-down to configure any additional settings:
   • Priority: Set the priority of the email. Many email programs ignore a priority setting.
   • Request receipt: Request a read receipt from your emails. Many email programs ignore these requests so it is not a definitive indication of how many people read your email.
   • Additional headers: Set any additional headers to be sent with the email.
9. Use the remaining check boxes to configure what messages are to be sent and how:
   • Send the message directly by using the Batch API: This option sends the emails directly by the Batch API. If not selected, then the emails are added to the spool and sent out by cron.
   • Only send one email per user: Select this option to ensure that each user receives the email only once even if the user is a part of multiple selected plans.
   • Send a copy of all messages to the sender: As the emails might contain context-specific tokens, a new email is generated for each recipient with the correct token replacement. This option sends a copy of all generated emails to the sender.
   • Send a copy of the original message to the sender: This option sends a single copy of the original email, subject, and body, without the replacement of any specified tokens.
10. Click Next.
11. Confirm that the email is ready to send, then click Next. If you chose to send the emails by the Batch API, you see a progress page that indicates how many emails were sent. You are then redirected to a Summary page that shows the total number of emails that were sent. If you chose to spool the delivery of the emails, you are redirected to the Summary page that shows the total number of emails that are spooled.
12. In the Summary page, enter a name in the text box to save the email list.
    Note: To delete the saved email list,

    1. Go to Configuration > System > Email subscriber settings and click Delete against the email list name.
    2. Click Delete again to confirm the action.
    3. Click Save configuration.
13. Click Finish.