# monthly_status_email

**Repository Path**: mirrors_nextcloud/monthly_status_email

## Basic Information

- **Project Name**: monthly_status_email
- **Description**: Nextcloud apps allowing to send once a month a notification per mail to the users with some status information
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-08
- **Last Updated**: 2026-01-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
  - SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
  - SPDX-License-Identifier: AGPL-3.0-or-later
-->
# Montly Status email

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/monthly_status_email)](https://api.reuse.software/info/github.com/nextcloud/monthly_status_email)

Send monthly status mails to users. This app doesn't provide a user interface.

Per default it sends a summary of used storage along with some usage hints.

The default messages are in German.

## Editing the messages sent

The messages sent to users are defined at `lib/Service/MessageProvider.php`.

To overwrite the default messages, create a new class inheriting from `MessageProvider`
and overwrite the desired methods.

Then configure your `MessageProvider` in `config.php`:

```php
[
   ...,
   'status-email-message-provider' => '\OCA\MyCustomApp\MyMessageProvider',
]
```

## Mail sending limits

In order to avoid mail floods, the app sends mails in hourly batches. Default maximum
is 1000 mails per hour. This limit can be changed via `status-email-max-mail-sent` in
the app config:

```bash
php occ config:app:set monthly_status_email status-email-max-mail-sent --value=2500
```

## Sending welcome mails

By default, this app sends a welcome mail to new users after they logged in for
the first time. This can be disabled with the following switch in config.php:

```php
[
    ...,
    'status-email-send-first-login-mail' => false
]
```

## Licensing

This project is licensed under AGPL-3.0-or-later.