Sending messages to consumer organization owners

You can send email messages to the owners of consumer organizations. You can also style the email to match your business theme.

Before you begin

To complete this task, you must be defined as a member in a catalog or space (if spaces are enabled), and you must be assigned a role that has the Consumer-Org > Manage permission. For more information, see Managing catalog membership.

Email messages contain a sender name and address that's based on a hierarchical search of the configured sender details in API Connect. Depending on the email being sent, the search can start at the Space level, and then go through the Catalog, Provider Organization, and the Cloud Manager levels. The sender details that are used will be the first set of configured details found during this hierarchical search. To view which search path API Connect takes when looking for the sender details for each notification template, see tbc.

Note: You can also send email messages by using the developer toolkit CLI, or by using the API Connect REST APIs. See API development and management commands, or API Connect REST APIs, for more information.

Procedure

To send a message, complete the following steps:

  1. In the navigation pane of the API Manager UI, click Manage icon in the API Manager UI navigation pane Manage, then select the catalog that you want to work with.
  2. Optional: If spaces are enabled in the catalog, select the space that you want to work with by completing the following steps:
    1. Click the Spaces tab.
    2. Select the space that you want to work with.
    For more information about enabling spaces, see Using syndication in API Connect.
  3. In the navigation pane of the API Manager UI, click the Consumers tab.
  4. You can either send a message to the owner of a specific consumer organization, or to the owners of multiple selected consumer organizations.
    • To send a message to the owner of a specific consumer organization, click the options icon More actions icon alongside the consumer organization you want to work with, then click Message owner. The Send Message window opens, and the email address of the consumer organization owner is displayed as the recipient.
    • To send a message to the owners of multiple selected consumer organizations, complete the following steps:
      1. Click the options icon More actions icon alongside the Add button, then click Message owners.
      2. Select the required consumer organizations, then click Next. The Send Message window opens, and the email addresses of the selected consumer organization owners are displayed as the recipients.
  5. Enter the subject of the message in the Subject field.
  6. Select the Content type that you want to use for the entering the content of the message, from HTML, PlainText, or Both. The default content type is PlainText.
    An edit window for the selected content type is displayed, or both edit windows are displayed if Both is selected.
    For HTML content, only the tags and their attributes that are shown in the following table are allowed.
    Table 1. List of allowed HTML tags and their attributes
    HTML tag Attribute
    <a> "class", "href", "hreflang", "style"
    <em> "class", "style"
    <strong> "class", "style"
    <cite> "class", "style"
    <blockquote> "class", "cite", "style"
    <code> "class", "style"
    <ul> "class", "type", "style"
    <ol> "class", "start", "type", "style"
    <li> "class", "style"
    <dl> "class", "style"
    <dt> "class", "style"
    <dd> "class", "style"
    <h1> "class", "id", "style"
    <h2> "class", "id", "style"
    <h3> "class", "id", "style"
    <h4> "class", "id", "style"
    <h5> "class", "id", "style"
    <h6> "class", "id", "style"
    <p> "class", "style"
    <div> "class", "style"
    <br> "class", "style"
    <span> "class", "style"
    <img> "class", "src", "alt", "data-entity-type", "data-entity-uuid", "data-align", "data-caption", "width", "height", "style"
    <table> "class", "id", "style"
    <tr> "class", "id", "style"
    <td> "class", "id", "style"
    If an HTML tag that is not allowed is used in a notification, the tag and its contents are displayed in the email as plain text.

    Images can be used by adding a <img src="https://path/to/image.png"/> tag in the template. The src attribute for the image must be a fully qualified web URL, and must be externally accessible so that the email recipients can access the image. It's not possible to reference local images, they must be fully qualified URLs. It's also not possible to embed or attach images or other files in the emails.

  7. Enter the content of the message.
  8. Click Send.