forgejo-docs/v1.19/admin/incoming-email.md

---
layout: '~/layouts/Markdown.astro'
title: 'Incoming Email'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/usage/incoming-email.en-us.md'
---

Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up.

## Requirements

Handling incoming email messages requires an IMAP-enabled email account.
The recommended strategy is to use [email sub-addressing](https://en.wikipedia.org/wiki/Email_address#Sub-addressing) but a catch-all mailbox does work too.
The receiving email address contains a user/action specific token which tells Forgejo which action should be performed.
This token is expected in the `To` and `Delivered-To` header fields.

Forgejo tries to detect automatic responses to skip and the email server should be configured to reduce the incoming noise too (spam, newsletter).

## Configuration

To activate the handling of incoming email messages you have to configure the `email.incoming` section in the configuration file.

The `REPLY_TO_ADDRESS` contains the address an email client will respond to.
This address needs to contain the `%{token}` placeholder which will be replaced with a token describing the user/action.
This placeholder must only appear once in the address and must be in the user part of the address (before the `@`).

An example using email sub-addressing may look like this: `incoming+%{token}@example.com`

If a catch-all mailbox is used, the placeholder may be used anywhere in the user part of the address: `incoming+%{token}@example.com`, `incoming_%{token}@example.com`, `%{token}@example.com`

## Security

Be careful when choosing the domain used for receiving incoming email.
It's recommended receiving incoming email on a subdomain, such as `incoming.example.com` to prevent potential security problems with other services running on `example.com`.
incoming-email.md: verbatim copy 2023-02-26 19:20:23 -05:00			`---`
			`layout: '~/layouts/Markdown.astro'`
			`title: 'Incoming Email'`
Fix licensing problems 2023-03-03 01:44:11 -05:00			`license: 'Apache-2.0'`
use permalinks so they do no break when files move 2023-03-03 05:14:29 -05:00			`origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/usage/incoming-email.en-us.md'`
incoming-email.md: verbatim copy 2023-02-26 19:20:23 -05:00			`---`

incoming-email.md: s/gitea/forgejo/ 2023-02-26 19:21:54 -05:00			`Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up.`
incoming-email.md: verbatim copy 2023-02-26 19:20:23 -05:00
			`## Requirements`

			`Handling incoming email messages requires an IMAP-enabled email account.`
			`The recommended strategy is to use [email sub-addressing](https://en.wikipedia.org/wiki/Email_address#Sub-addressing) but a catch-all mailbox does work too.`
incoming-email.md: s/gitea/forgejo/ 2023-02-26 19:21:54 -05:00			`The receiving email address contains a user/action specific token which tells Forgejo which action should be performed.`
incoming-email.md: verbatim copy 2023-02-26 19:20:23 -05:00			This token is expected in the `To` and `Delivered-To` header fields.

incoming-email.md: s/gitea/forgejo/ 2023-02-26 19:21:54 -05:00			`Forgejo tries to detect automatic responses to skip and the email server should be configured to reduce the incoming noise too (spam, newsletter).`
incoming-email.md: verbatim copy 2023-02-26 19:20:23 -05:00
			`## Configuration`

			To activate the handling of incoming email messages you have to configure the `email.incoming` section in the configuration file.

			The `REPLY_TO_ADDRESS` contains the address an email client will respond to.
			This address needs to contain the `%{token}` placeholder which will be replaced with a token describing the user/action.
			This placeholder must only appear once in the address and must be in the user part of the address (before the `@`).

			An example using email sub-addressing may look like this: `incoming+%{token}@example.com`

			If a catch-all mailbox is used, the placeholder may be used anywhere in the user part of the address: `incoming+%{token}@example.com`, `incoming_%{token}@example.com`, `%{token}@example.com`

			`## Security`

			`Be careful when choosing the domain used for receiving incoming email.`
			It's recommended receiving incoming email on a subdomain, such as `incoming.example.com` to prevent potential security problems with other services running on `example.com`.