coimstark/mattermost

Php Wrapper to interact with Mattermost API https://api.mattermost.com/

1.3.0 2021-07-15 12:55 UTC

Requires

• php: ^7.0 || ^7.1 || ^7.2 || ^7.3 || ^7.4 || ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.3

Requires (Dev)

• phpunit/phpunit: ^8.2

MIT

• Paul Celie

• Mattermost

README

PHP wrapper for Mattermost Api

Installation

composer require coimstark/mattermost

Authentication

Authentication can be handled via username / password

$username = '';
$password = '';

$session = (new Session())
    ->fromLogin($username, $password);

Or it can be handled by using personal access tokens

$accessToken = '';

$session = (new Session())
    ->fromPersonalAccessToken($accessToken);

Now setup the client with the session you've just created:

$uri = ''; // Mattermost uri incl. port (f.e. https://mattermost.acme.com:443)
$client = new Client($session, $uri);

Examples

You can find examples for every single API request in examples

Teams

• Get all teams

Users

• Get all users
• Get users by username

Channels

• Create channel
• Create direct message channel
• Create group message channel
• Get all public channels
• Get channel by name
• Search group channels requires minimum Mattermost server version 5.14
• Get channel timezones requires minimum Mattermost server version 5.6
• Get channel by id
• Update channel
• Delete channel
• Patch channel
• Convert a public channel to private
• Restore a channel
• Get channel statistics
• Get pinned posts from a channel
• Get deleted channels
• Autocomplete public channels by searchterm requires minimum Mattermost server version 4.7
• Autocomplete your channels by searchterm requires minimum Mattermost server version 5.4
• Search public channels
• Get channel by team -and channel name

Posts

• Create post
• Create ephemeral post
• Update post
• Delete post
• Get post by id