Download the PHP package bluemantis/private-messaging without Composer
On this page you can find all versions of the php package bluemantis/private-messaging. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bluemantis/private-messaging
More information about bluemantis/private-messaging
Files in bluemantis/private-messaging
Package private-messaging
Short Description Allows sending private messages between users
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package private-messaging
Craft Private Messaging
A Craft 3 CMS plugin. Grant your site users the power of communication, via private messaging!
User Guide
1. Send a private message
Add the following form to your template:
You will need to set the following form values:
- redirect - This should be set to the template to redirect to, upon successfully sending the private message
- subject - This should be the subject of the message
- body - This should be the content of the message
- recipientId - This should be the ID of the user due to receive the message
2. View messages
To view the logged in users messages, you will need to add the following to your template:
Within this loop you can access the following private message attributes:
- message.id - The message ID. [type: integer]
- message.subject - The subject of the message. [type: string(255)]
- message.body - The body of the message. [type: text]
- message.sender - The sender user. [type: user object]
- message.recipient - The recipient user. [type: user object]
- message.siteId - The id of the site. [type: integer]
- message.thread - The message thread. [type: thread object]
- message.isRead - Whether the message has been read. [type: boolean]
- message.dateCreated - The created dateTime of the message. [type: dateTime]
3. View unread message count
To view the unread message count for the currently logged in user, you will need to add the following to your template:
4. View total message count
To view the total message count for the currently logged in user, you will need to add the following to your template:
5. View a message
To access an individual message, you will need to pass the id of a message to your template.
This can be achieved by setting up a new route that passes the message id (number) to your template, like so:
Inside the template, we will use this ID (number) to retrieve the message, but, first we check to ensure we have actually been passed an ID:
If we have an ID, then we pass this to the getPrivateMessage method (which is a twig extension built into the plugin):
If this method does not return an associated message, it will return null. We may wish to handle that also:
The getPrivateMessage method with return a null value when:
- Out of range - A message with that ID doesn't exist in the database
- Deleted - A message with that ID has been deleted from the database
- Permissions - A message with that ID does not belong to the user trying to access it
6. View threads
To view the logged in users threads, you will need to add the following to your template:
Within this loop you can access the following message thread attributes:
- thread.id - The message ID. [type: integer]
- thread.subject - The subject of the message. [type: string(255)]
- thread.excerpt - The body of the message. [type: text]
- thread.siteId - The id of the site. [type: integer]
- thread.dateCreated - The created dateTime of the message. [type: dateTime]
- thread.messages - Array of messages in this thread. [type: array]
Inside the template, we will use this ID (number) to retrieve the message, but, first we check to ensure we have actually been passed an ID:
If we have an ID, then we pass this to the getPrivateMessageThread method (which is a twig extension built into the plugin):
The getPrivateMessageThread method with return a null value when:
- Out of range - A thread with that ID doesn't exist in the database
- Deleted - A thread with that ID has been deleted from the database
- Permissions - A thread with that ID does not belong to the user trying to access it
Threads are only visible to the parties involved in the conversation
7. Reply to a message
Add the following form to your template:
You will need to set the following form values:
- redirect - This should be set to the template to redirect to, upon successfully sending the private message
- threadId - This should be the ID of the conversation thread (use thread id of the message you're replying to
- recipientId - This should be the ID of the user you're sending the message to
- subject - This should be the subject of the message
- body - This should be the content of the message
8. Delete a message
Add the following form to your template:
You will need to set the following form values:
- redirect - This should be set to the template to redirect to, upon successfully deleting the private message
- id - This should be the ID of the message
NB: A user can only delete messages that belong to them.
More plugins by Blue Mantis
... can be found here
