inbox

Represents an inbox. An inbox is a list of content items. Inboxes belong to sections and are generally used by section editors to organize publication work flow. A content item may not belong to more than one inbox at a time The content items in an inbox are represented by the inbox element's child content-ref elements.

Syntax
<inbox
    name="text"?
    id-ref="text"?
    (source="text" sourceid="text")?
    dbid="text"?
    exported-dbid="text"?
    unique-name="text"?
    action="(remove|insert)"?
  >
  <content-ref/>*
</inbox>
Examples
  • This example imports an inbox called "review". The source and source-id attributes identify the section to which the inbox is to be added. This section must already exist in the database or appear before this element in the syndication file, as must the content item that is included in the inbox.

    <inbox source="ex" sourceid="s12" name="review">
      <content-ref source="ex" sourceid="13"/>
    </inbox>
Attributes
name="text" (optional)

The name of this inbox. To import content items to the default inbox called "Inbox", either omit this attribute or specify name="". Do not specify name="Inbox", as this will create a second inbox with the name "Inbox".

id-ref="text" (optional)

The id of the section to which this inbox is to be added. If this attribute is specified, a section element with an id attribute that matches this attribute must appear somewhere before this inbox element in the syndication file.

If dbid or source and sourceid are specified, then this attribute is ignored.

source="text" (optional)

The source of the section to which this inbox is to be added. If this attribute is specified, then sourceid must also be specified. One of the following two conditions must be satisfied:

  • The target publication must already contain a section with source and sourceid attributes that match source and sourceid, or

  • A section element with source and sourceid attributes that match source and sourceid must appear somewhere before this inbox element in the syndication file.

If dbid is specified, then source and sourceid are ignored.

sourceid="text" (optional)

The sourceid of the section to which this inbox is to be added. If this attribute is specified, then source must also be specified. One of the following two conditions must be satisfied:

  • The target publication must already contain a section with source and sourceid attributes that match source and sourceid, or

  • A section element with source and sourceid attributes that match source and sourceid must appear somewhere before this inbox element in the syndication file.

If dbid is specified, then source and sourceid are ignored.

dbid="text" (optional)

The dbid of the section to which this inbox is to be added. If this attribute is specified then one of the following two conditions must be satisfied:

  • The target publication must already contain a section with a dbid attribute that matches this attribute, or

  • A section element with a dbid attribute that matches this attribute must appear somewhere before this inbox element in the syndication file.

exported-dbid="text" (optional)
unique-name="text" (optional)

The unique-name or name of the section to which this inbox is to be added. If this attribute is specified, then one of the following conditions must be satisified:

  • The target publication must already contain a section with a uniquename or name attribute that matches this attribute, or

  • A section element with a unique-name or name attribute that matches this attribute must appear somewhere before this inbox element in the syndication file.

If this is not the case, or if there is a matching name attribute but it is not unique, then import will fail.

If dbid or source and sourceid or id are specified, then this attribute is ignored.

action="(remove|insert)" (optional)

Determines what action is taken during import if the section page already exists.

Allowed values are:

remove

The inbox is cleared before import.

insert (default)

The inbox is not cleared before import: new entries are simply appended to the inbox.