API functions

  1. privatemsg
    1. 1 privatemsg.api.php
    2. 6-2 privatemsg.api.php
    3. 7-1 privatemsg.api.php
    4. 7-2 privatemsg.api.php

There are two different functions to send messages. Either by starting a new thread or reply to an existing thread.

There is also a function which returns a link to the privatemsg new message form with the recipient pre-filled if the user is allowed to. privatemsg_get_link().

Functions & methods

NameDescription
privatemsg_get_linkReturns a link to send message form for a specific users.
privatemsg_message_change_deleteDelete or restore a message.
privatemsg_message_loadLoad a single message.
privatemsg_message_load_multipleLoad multiple messages.
privatemsg_new_threadSend a new message.
privatemsg_replySend a reply message
privatemsg_thread_loadLoad a thread with all the messages and participants.
privatemsg_unread_countReturn number of unread messages for an account.
privatemsg_user_accessPrivatemsg wrapper for user_access.
privatemsg_view_accessCheck access to the view messages page.

File

./privatemsg.api.php, line 134
Privatemsg API Documentation

Add new comment

Filtered HTML

  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd>
  • Lines and paragraphs break automatically.

Plain text

  • No HTML tags allowed.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Lines and paragraphs break automatically.