Skip to content

Latest commit

 

History

History
189 lines (113 loc) · 3.91 KB

mailingLists.rst

File metadata and controls

189 lines (113 loc) · 3.91 KB
Raw

mailingLists

The address books API, also including the :doc:`addressBooks` and :doc:`contacts` namespaces, first appeared in Thunderbird 64.

The Address Books sample extension uses this API.

Note

The permission addressBooks is required to use mailingLists.

Functions

list(parentId)

Gets all the mailing lists in the address book with id parentId.

  • parentId (string)

Returns a Promise fulfilled with:

get(id)

Gets a single mailing list.

  • id (string)

Returns a Promise fulfilled with:

create(parentId, properties)

Creates a new mailing list in the address book with id parentId.

  • parentId (string)
  • properties (object)
    • name (string)
    • [description] (string)
    • [nickName] (string)

Returns a Promise fulfilled with:

  • string The ID of the new mailing list.

update(id, properties)

Edits the properties of a mailing list.

  • id (string)
  • properties (object)
    • name (string)
    • [description] (string)
    • [nickName] (string)

delete(id)

Removes the mailing list.

  • id (string)

addMember(id, contactId)

Adds a contact to the mailing list with id id. If the contact and mailing list are in different address books, the contact will also be copied to the list's address book.

  • id (string)
  • contactId (string)

listMembers(id)

Gets all contacts that are members of the mailing list with id id.

  • id (string)

Returns a Promise fulfilled with:

removeMember(id, contactId)

Removes a contact from the mailing list with id id. This does not delete the contact from the address book.

  • id (string)
  • contactId (string)

Events

onCreated(node)

Fired when a mailing list is created.

onUpdated(node)

Fired when a mailing list is changed.

onDeleted(parentId, id)

Fired when a mailing list is deleted.

  • parentId (string)
  • id (string)

onMemberAdded(node)

Fired when a contact is added to the mailing list.

onMemberRemoved(parentId, id)

Fired when a contact is removed from the mailing list.

  • parentId (string)
  • id (string)

Types

MailingListNode

A node representing a mailing list.

object

  • description (string)
  • id (string) The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the program is restarted.
  • name (string)
  • nickName (string)
  • type (:ref:`addressBooks.NodeType`) Always set to mailingList.
  • [contacts] (array of :ref:`contacts.ContactNode`) A list of contacts held by this node's address book or mailing list.
  • [parentId] (string) The id of the parent object.
  • [readOnly] (boolean) Indicates if the object is read-only. Currently this returns false in all cases, as read-only address books are ignored by the API.