io7m | single-page | multi-page | epub | Idstore User Manual 1.0.0-rc0006
7.2.21. logout
Previous
7.2. Admin Shell Command Reference
Up
7.2.23. maintenance-mode
Next

# 7.2.22. mail-test

- 7.2.22.1. Name
- 7.2.22.2. Description
- 7.2.22.3. Example

## 7.2.22.1. Name

1
mail-test - Send a test email.

## 7.2.22.2. Description

1
The mail-test command checks to see if the mail system is working by sending a test email.
2
For obvious reasons, the command can only check that the idstore server is capable of sending mail through its configured mail service - it cannot automatically verify that the target will actually receive the sent mail.

### 7.2.22.2.3. Parameters

Parameter | Type | Cardinality | Default | Description
--- | --- | --- | --- | ---
--email | com.io7m.idstore.model.IdEmail | [1] |  | The target email address.
--token | com.io7m.idstore.model.IdShortHumanToken | [0, 1] |  | The short token to include in the email. If a value is not provided, one is randomly generated.

## 7.2.22.3. Example

### 7.2.22.3.1. Example

    [idstore]# mail-test --email user@example.com
    Mail sent successfully.
    Token: 220384

7.2.21. logout
Previous
7.2. Admin Shell Command Reference
Up
7.2.23. maintenance-mode
Next
io7m | single-page | multi-page | epub | Idstore User Manual 1.0.0-rc0006