diff options
Diffstat (limited to 'doc/administration/reply_by_email.md')
| -rw-r--r-- | doc/administration/reply_by_email.md | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/doc/administration/reply_by_email.md b/doc/administration/reply_by_email.md index 4108635ba2c..ebb9e086cb7 100644 --- a/doc/administration/reply_by_email.md +++ b/doc/administration/reply_by_email.md @@ -1,7 +1,7 @@ --- stage: Plan group: Certify -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Reply by email @@ -15,34 +15,40 @@ replying to notification emails. Make sure [incoming email](incoming_email.md) is set up. -## How it works? +## How it works -### 1. GitLab sends a notification email +Replying by email happens in three steps: + +1. GitLab sends a notification email. +1. You reply to the notification email. +1. GitLab receives your reply to the notification email. + +### GitLab sends a notification email When GitLab sends a notification and Reply by email is enabled, the `Reply-To` header is set to the address defined in your GitLab configuration, with the `%{key}` placeholder (if present) replaced by a specific "reply key". In addition, this "reply key" is also added to the `References` header. -### 2. You reply to the notification email +### You reply to the notification email -When you reply to the notification email, your email client will: +When you reply to the notification email, your email client: -- send the email to the `Reply-To` address it got from the notification email -- set the `In-Reply-To` header to the value of the `Message-ID` header from the +- sends the email to the `Reply-To` address it got from the notification email +- sets the `In-Reply-To` header to the value of the `Message-ID` header from the notification email -- set the `References` header to the value of the `Message-ID` plus the value of +- sets the `References` header to the value of the `Message-ID` plus the value of the notification email's `References` header. -### 3. GitLab receives your reply to the notification email +### GitLab receives your reply to the notification email -When GitLab receives your reply, it will look for the "reply key" in the +When GitLab receives your reply, it looks for the "reply key" in the following headers, in this order: 1. the `To` header 1. the `References` header -If it finds a reply key, it will be able to leave your reply as a comment on +If it finds a reply key, it leaves your reply as a comment on the entity the notification was about (issue, merge request, commit...). For more details about the `Message-ID`, `In-Reply-To`, and `References headers`, |