PHPackages                             fiyo/mattermost - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. fiyo/mattermost

AbandonedLibrary

fiyo/mattermost
===============

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

1.4.0(4y ago)11.1k1MITPHPPHP ^7.0 || ^7.1 || ^7.2 || ^7.3 || ^7.4 || ^8.0CI failing

Since Jul 2Pushed 4y ago1 watchersCompare

[ Source](https://github.com/onderdelenwinkelnl/mattermost)[ Packagist](https://packagist.org/packages/fiyo/mattermost)[ RSS](/packages/fiyo-mattermost/feed)WikiDiscussions development Synced 2mo ago

READMEChangelog (10)Dependencies (2)Versions (11)Used By (0)

Mattermost API
==============

[](#mattermost-api)

PHP wrapper for [Mattermost Api](https://api.mattermost.com/)

### Installation

[](#installation)

```
composer require onderdelenwinkelnl/mattermost

```

### Authentication

[](#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](https://docs.mattermost.com/developer/personal-access-tokens.html)

```
$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

[](#examples)

You can find examples for every single API request in [examples](./examples)

##### Teams

[](#teams)

- [Get all teams](./examples/Team/GetTeams.php)

##### Users

[](#users)

- [Get all users](./examples/User/GetUsers.php)
- [Get users by username](./examples/User/GetUsersByUsername.php)

##### Channels

[](#channels)

- [Create channel](./examples/Channel/CreateChannel.php)
- [Create direct message channel](./examples/Channel/CreateDirectMessageChannel.php)
- [Create group message channel](./examples/Channel/CreateGroupMessageChannel.php)
- [Get all public channels](./examples/Channel/GetPublicChannels.php)
- [Get channel by name](./examples/Channel/GetChannelByName.php)
- [Search group channels](./examples/Channel/SerachGroupChannel.php) *requires minimum Mattermost server version 5.14*
- [Get channel timezones](./examples/Channel/GetChannelTimezones.php) *requires minimum Mattermost server version 5.6*
- [Get channel by id](./examples/Channel/GetChannelById.php)
- [Update channel](./examples/Channel/UpdateChannel.php)
- [Delete channel](./examples/Channel/DeleteChannel.php)
- [Patch channel](./examples/Channel/PatchChannel.php)
- [Convert a public channel to private](./examples/Channel/ConvertPublicToPrivateChannel.php)
- [Restore a channel](./examples/Channel/RestoreChannel.php)
- [Get channel statistics](./examples/Channel/GetChannelStatistics.php)
- [Get pinned posts from a channel](./examples/Channel/GetChannelsPinnedPosts.php)
- [Get deleted channels](./examples/Channel/GetDeletedChannels.php)
- [Autocomplete public channels by searchterm](./examples/Channel/AutocompleteChannels.php) *requires minimum Mattermost server version 4.7*
- [Autocomplete your channels by searchterm](./examples/Channel/AutocompleteChannelsForSearch.php) *requires minimum Mattermost server version 5.4*
- [Search public channels](./examples/Channel/SearchChannels.php)
- [Get channel by team -and channel name](./examples/Channel/GetChannelByTeamAndName.php)

##### Posts

[](#posts)

- [Create post](./examples/Post/CreatePost.php)
- [Create ephemeral post](./examples/Post/CreateEphermeralPost.php)
- [Update post](./examples/Post/UpdatePost.php)
- [Delete post](./examples/Post/DeletePost.php)
- [Get post by id](./examples/Post/GetPost.php)

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~153 days

Recently: every ~229 days

Total

7

Last Release

1586d ago

Major Versions

0.0.3 → 1.1.12019-07-03

PHP version history (2 changes)0.0.2PHP ^7.0 || ^7.1 || ^7.2 || ^7.3

1.3.0PHP ^7.0 || ^7.1 || ^7.2 || ^7.3 || ^7.4 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/89648759c303504e066317bbc5a0c2d50c7c115675a8cc344eab6c46e7722265?d=identicon)[paulcelie](/maintainers/paulcelie)

---

Top Contributors

[![paulcelie](https://avatars.githubusercontent.com/u/4981763?v=4)](https://github.com/paulcelie "paulcelie (12 commits)")

---

Tags

Mattermost

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fiyo-mattermost/health.svg)

```
[![Health](https://phpackages.com/badges/fiyo-mattermost/health.svg)](https://phpackages.com/packages/fiyo-mattermost)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/packages/neuron-core-neuron-ai)[guanguans/notify

Push notification SDK(AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、PushMe、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPush、XiZhi、YiFengChuanHua、ZohoCliq、ZohoCliqWebHook、Zulip).

682104.9k7](/packages/guanguans-notify)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[gnello/php-mattermost-driver

The Php Driver to interact with the Mattermost Web Service API

84304.8k5](/packages/gnello-php-mattermost-driver)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)