{ "componentChunkName": "component---src-templates-plugin-docs-tsx", "path": "/plugins/scm-mail-plugin/docs/3.5.x/en/configuration/", "result": {"data":{"plugin":{"name":"scm-mail-plugin","displayName":"Mail","description":"Provides an api for sending e-mails and can be used by other plugins","author":"Cloudogu GmbH","documentation":[{"version":"3.5.x","languages":["de","en"]},{"version":"3.4.x","languages":["de","en"]},{"version":"3.3.x","languages":["de","en"]},{"version":"3.2.x","languages":["de","en"]},{"version":"3.1.x","languages":["de","en"]},{"version":"3.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"Getting Started","entries":[{"frontmatter":{"title":"Configuration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-mail-plugin/docs/3.5.x/en/configuration/"}},{"frontmatter":{"title":"Permissions","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-mail-plugin/docs/3.5.x/en/permission/"}},{"frontmatter":{"title":"Testing","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-mail-plugin/docs/3.5.x/en/testing/"}}]}]},"versions":{"group":[{"fieldValue":"3.0.x"},{"fieldValue":"3.1.x"},{"fieldValue":"3.2.x"},{"fieldValue":"3.3.x"},{"fieldValue":"3.4.x"},{"fieldValue":"3.5.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"

There are two different configurations for the scm-mail-plugin.

\n

Global configuration

\n

The global configuration can be found under “Administration”, “Settings”, and then “Email”.\nThis way, administrators can configure the transportation of emails by an SMTP server.\nAt first, the administrator can configure the host and the port of the SMTP server.\nThen the “from” email address (sender) and a prefix for the subject can be configured for every email sent by the SMTP server.\nIf necessary, credentials needed to authenticate against the SMTP server can be configured in the next step.\nAll those values are set within text input field.\nIn the next step, the default language of the emails sent by the SCM-Server can be configured by a dropdown.\nLastly, the transport strategy can also be configured by a dropdown.\nThe available options are “SMTP”, “SMTPS”, and “SMTP via TLS”.\nChanges need to be saved by clicking the “Submit” button at the end of the page.

\n

At the end of the configuration page, the administrators can check the validity of the configuration\nby sending an email to a specified address.\nThat specified email address can be set by a text input.\nBy clicking the button “Test configuration”, the email gets send out.\nThe result of sending that email will be displayed in a newly-opened modal.

\n

User-specific configuration

\n

The user-specific configuration can be found under “Email” in the footer.\nUsers can configure their personal settings for notifications via email.\nFirst, the user can set the language used in the email notifications with a dropdown.

\n

Subsequently, the user can activate or deactivate the summarization of their email notifications by clicking a checkbox.\nIf the summarization is activated, the user can further configure the summary mails.\nThe emails can either be summarized by category or by a specific entity.\nFor example, if the scm-review-plugin is also installed, then email notifications regarding pull requests are available.\nEither every email notification will be summarized by a specific pull request and therefore the user gets a summary email for each pull request,\nor the summarization is done by the pull request category, which means every email notification regarding any pull request\nwill be summarized into one email notification.\nBy clicking a checkbox, the user can decide which summarization strategy should be used.

\n

After that, the user can select the frequency of the emails with a dropdown.\nIt is important to note that not all email notifications get summarized.\nSome topics are deemed prioritized.\nThose topics are always send out directly and individually.

\n

Lastly, the user can select the topics for which notifications will be sent.\nFor each topic and its category, a checkbox is available to include / exclude the topic / category.\nTo save those settings, the user must click the “Submit” button at the end of the page.

","description":"There are two different configurations for the scm-mail-plugin. Global configuration The global configuration can be found under “Administration”, “Settings…","tableOfContents":"","frontmatter":{"title":"Configuration","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-mail-plugin","slug":"/plugins/scm-mail-plugin/docs/3.5.x/en/configuration/","version":"3.5.x","latestVersion":"3.5.x","latestPageVersion":"3.5.x","language":"en","canonicalPath":"/plugins/scm-mail-plugin/docs/latest/en/configuration/","latestRootPath":"/plugins/scm-mail-plugin/docs/3.5.x/en/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}