diff --git a/channels/email/accounts/account-setup.rst b/channels/email/accounts/account-setup.rst index cc00d442..647ebfd8 100644 --- a/channels/email/accounts/account-setup.rst +++ b/channels/email/accounts/account-setup.rst @@ -25,7 +25,7 @@ The import process does things you might not expect: Google is in the process of upgrading its security policies. To stay up-to-date, do **not** add your account as an email channel — instead, create a - :doc:`Google channel `. + :doc:`Google channel `. **Microsoft 365 users:** Microsoft is in the process of upgrading its security policies. @@ -38,7 +38,7 @@ Basic In most cases, Zammad is smart enough to figure out your email provider's configuration based on your email address alone. If the correct configuration -could not be retreived, Zammad asks you to provide the correct parameters +could not be retrieved, Zammad asks you to provide the correct parameters manually. .. figure:: /images/channels/email/account-basic-setup-inbound.png diff --git a/channels/email/index.rst b/channels/email/index.rst index 4eb79e23..68bee048 100644 --- a/channels/email/index.rst +++ b/channels/email/index.rst @@ -28,7 +28,7 @@ Control how Zammad **sends and receives email**. 🚛 Migrate existing email channel to "XOAUTH" channel At this moment Zammad supports XOAUTH for the following providers: - * :doc:`Google ` + * :ref:`Google ` * :doc:`Microsoft 365 (formerly Office 365) ` Use above links to use the migration option instead of removing and re-adding diff --git a/channels/google/accounts.rst b/channels/google/accounts.rst deleted file mode 100644 index 5e1d13a4..00000000 --- a/channels/google/accounts.rst +++ /dev/null @@ -1,73 +0,0 @@ -Accounts -======== - -.. toctree:: - :hidden: - - accounts/register-app - accounts/account-setup - accounts/migrate-from-email-channel - accounts/secondary-addresses - accounts/managing-accounts - -:doc:`accounts/register-app` - Use the **Connect Google App** dialog to register Zammad as an OAuth app on - Google. - - (This step is **required**; read on to learn why.) - - .. figure:: /images/channels/google/accounts/register-app/05-add-oauth-credentials.gif - :alt: Registering Zammad as a Google OAuth app - :scale: 60% - :align: center - -:doc:`accounts/account-setup` - Use the **Add Account** dialog to connect your account. - - You're migrating existing email channels? Look below! - - .. figure:: /images/channels/google/accounts/account-setup/add-gmail-account-to-zammad.gif - :alt: Adding your gmail account to Zammad - :scale: 60% - :align: center - -:doc:`accounts/migrate-from-email-channel` - Use the *Migrate now!* button within your email channels to quickly move - your mailboxes to Google. You can roll back if things hit the fan! - - .. figure:: /images/channels/google/accounts/migrate-email-channel-to-google.gif - :alt: Migrate an existing email channel to Google - :scale: 60% - :align: center - -:doc:`accounts/secondary-addresses` - Send and receive email at **additional email addresses**, - all through the same mailbox/account. - - .. figure:: /images/channels/google/add-gmail-alias.gif - :alt: Adding new aliases to your gmail account in Zammad - :scale: 60% - :align: center - -:doc:`accounts/managing-accounts` - Edit the configuration of existing accounts in the **Accounts Panel**. - - .. figure:: /images/channels/google/panel.png - :alt: Existing accounts can be edited from the Accounts panel. - :scale: 60% - :align: center - -.. note:: 🤔 **How do I use my Gmail account for outgoing system notifications?** - - On **subscription/cloud-hosted instances**, you can’t. - Notifications will always come from - “Notification Master ”. - - On **self-hosted instances**, we still don’t recommend it. - Using a Gmail account for automated, outgoing messages is risky: - users who exceed Google’s `email sending limits - `_ - can have their accounts suspended. - - Set up a generic :doc:`email channel ` instead and - use the :ref:`Email Notification ` setting. diff --git a/channels/google/accounts/account-setup.rst b/channels/google/accounts/account-setup.rst deleted file mode 100644 index e8d89103..00000000 --- a/channels/google/accounts/account-setup.rst +++ /dev/null @@ -1,117 +0,0 @@ -Account Setup -============= - -After you've :doc:`registered Zammad as an OAuth app ` -in your Google Developer settings, -you can begin connecting Gmail accounts to Zammad. - -☠️ **But first, a word of warning!** -The import process does things you might not expect: - -.. danger:: - * By default, Zammad will **delete all emails** in your inbox - during the import process. Use the *Keep Messages on Server* setting to - :ref:`disable this behavior `. - * Zammad will send an auto-reply message - to every email it imports (including the old ones!). - Make sure to :doc:`disable this behavior ` - prior adding an email account and to turn it back on once all your - messages have been imported. - -🚛 Migrate an Existing Email Channel ------------------------------------- - -If you've already added your Google account as a regular email channel, -you'll have to convert it to a Google channel eventually: -Google is planning to end support for simple password authentication -in third-party email clients (like Zammad). - -Please refer the :doc:`migrate-from-email-channel` guide. - -Add a New Account ------------------ - -.. figure:: /images/channels/google/accounts/account-setup/add-gmail-account-to-zammad.gif - :alt: Click on Add Account to add your Google account to Zammad - :scale: 50% - :align: center - -Click **Add Account** to connect your Gmail / G Suite accounts to Zammad. -You will be redirected to a Google sign-in and confirmation page. - -Any aliases registered in your Gmail settings will be imported automatically. - -.. note:: - - .. figure:: /images/channels/google/accounts/account-setup/unverified-app-warning.png - :alt: Google warning for unverified OAuth apps - :align: center - :scale: 60% - - Google has a stringent verification process - to protect users from third-party websites that use OAuth to access their - data. Since you *are* the third-party website here, - you can safely ignore this warning. - -Channel -^^^^^^^ - -.. figure:: /images/channels/google/accounts/account-setup/gmail-account-settings.png - :alt: Click on Add Account to add your Google account to Zammad - :scale: 50% - :align: center - -.. _google-folder: - -Folder - Specify which folder (or *label*) to fetch from, - or leave empty to fetch from ``INBOX``. - - If specifying a nested folder, be sure to use the full path; - *e.g.,* ``Inquiries/Tech-Support``. - - .. _google-keep-messages-on-server: - -Keep messages on server - Specify what happens to your emails after Zammad imports them: - - * ``no`` Zammad deletes all imported messages - - * ``yes`` Zammad marks imported messages as read - - (With this option, Zammad will only import unread messages. - This means Zammad may miss messages if the mailbox is externally modified.) - - .. note:: 🤔 **Why does Zammad delete messages by default?** - - If you never clean out your inbox, - it'll eventually reach its storage limit, - and your mail server will start **rejecting incoming messages**. - Most Zammad users never even look at their inbox once it's set up, - so they rely on Zammad to keep it clean for them. - - If you choose **yes** here, remember that it's your responsibility - to clean out your inbox from time to time - to keep it below its storage limit. - -After adding the account - After successfully adding the Google mail account, you can adjust - the default group Zammad is going to assign incoming new tickets to. - - .. figure:: /images/channels/google/accounts/account-setup/change-destination-group.png - :alt: Location of "Destination Group" setting for existing accounts - :scale: 60% - :align: center - - Only **active** groups will be displayed. - - Changing this setting will not reassign existing tickets to the new group. - - .. include:: /channels/email/accounts/account-setup-group-hint.include.rst - -Troubleshooting ---------------- - -I successfully added my account, but Zammad isn't fetching new email - If you specified a :ref:`custom folder/label to fetch from `, - are you sure incoming mail is arriving in that folder? diff --git a/channels/google/accounts/migrate-from-email-channel.rst b/channels/google/accounts/migrate-from-email-channel.rst deleted file mode 100644 index 384e4b0d..00000000 --- a/channels/google/accounts/migrate-from-email-channel.rst +++ /dev/null @@ -1,38 +0,0 @@ -Migrate From Email Channel to Google Channel -============================================ - -Zammad provides a migration logic that allows you to migrate existing Google -accounts from an email channel into a Google channel. - -.. note:: 🧐 **Zammad is expecting specific settings** - - In order for Zammad to display the migration option, it expects the channels - hostname to be ``imap.gmail.com`` for IMAP and ``smtp.gmail.com`` for SMTP. - -The easiest way to start the migration is to :doc:`register-app` for your -Google accounts before migrating. However, if you don't, Zammad will ask you -to provide your app credentials before allowing you to continue. - -If you're ready to go, simply click on the *Migrate now!* button in the red -banner of the email channel in question. Zammad will redirect you to -Google and request you to authenticate and consent to said account. - -After you pressed next you'll be redirect to Zammad's Google channel overview. -Your channel, if successful, is now migrated to an Google channel. - -.. figure:: /images/channels/google/accounts/migrate-email-channel-to-google.gif - :alt: Migrate an existing email channel to Google - :align: center - -Rolling Back the Migration --------------------------- - -In case something went wrong, Zammad allows you to roll back the migration -for up to 7 days. For this time period Zammad will remember your original -credentials and restore it if needed. These information will be removed -entirely after 7 days. - - .. figure:: /images/channels/google/accounts/managing-accounts/rollback-migration.png - :alt: Migrate an existing email channel to Google - :scale: 90% - :align: center diff --git a/channels/google/accounts/register-app.rst b/channels/google/accounts/register-app.rst deleted file mode 100644 index 1e5b4fef..00000000 --- a/channels/google/accounts/register-app.rst +++ /dev/null @@ -1,122 +0,0 @@ -Register an OAuth App -===================== - -Setting up a new Gmail / G Suite account? -Because of Google's strict security policies, -it's not as simple as entering your username and password. - -First, you'll have to connect Zammad to your Google account as an **OAuth app** -via the Google Developer settings panel. -Once that's done, you'll be able to connect as many Gmail accounts to Zammad as -you want, using only active Gmail browser sessions -(no usernames or passwords required). - -.. note:: 🤔 **What the heck is OAuth?** - - If you've ever used a website that lets you - “Sign in with Google/Facebook/Twitter”, you've used OAuth. - OAuth is a way for you to let a third-party website see a tiny slice - of your Google/Facebook/Twitter account data - without giving them your password (which would let them see *everything*). - - .. figure:: /images/channels/google/accounts/register-app/sign-in-with.png - :alt: Screenshot of website with various OAuth sign-in options - :align: center - - When a third-party website wants to use OAuth, - it has to **register with the provider first** (*i.e.,* Google). - This way, the provider knows who's receiving its users' data, - and can give users a way to revoke access if they change their minds. - - In this case, **Zammad is that third-party website**. - That's why adding a Gmail account is a two-stage process: - first, you have to register Zammad as a website that wishes to access Google - user data; then, you have to add yourself as a Google user who agrees to let - Zammad fetch your email. - -Step-by-Step ------------- - -To get started, head over to `Google's -Developer settings panel `_. - -1. **Create a new project** - - For the purposes of this guide, a “project” and an OAuth app are the same - thing. You may name it whatever you wish. - - .. figure:: /images/channels/google/accounts/register-app/01-create-project.gif - :alt: Screencast demo of new project creation in Google Developer settings - :align: center - -2. **Enable & add the Gmail API** - - Use the **➕ Enable APIs and Services** button to start your search. - - .. figure:: /images/channels/google/accounts/register-app/02-enable-api.gif - :alt: Screencast demo of enabling Gmail API in Google Developer settings - :align: center - -3. **Set up the OAuth consent screen** - - Configure who can use your app, what kind of access it's asking for, - and a few fine print details (like a link to Zammad's privacy policy). - - This information will be displayed in the process of connecting a Gmail - account to Zammad, when users are redirected to Google for - sign-in/confirmation. - - .. figure:: /images/channels/google/accounts/register-app/03-set-up-consent-screen.gif - :alt: Screencast demo of OAuth consent screen setup in Google Developer - settings - :align: center - - User Type - This option is only available to G Suite users. - - If you have the option, choose **Internal** - (unless you plan on creating channels for Gmail addresses - from outside your G Suite domain). - - Scopes for Google APIs - Add **Gmail API: https://mail.google.com**. - -4. **Generate OAuth credentials** - - Click on **➕ Create credentials > OAuth client ID** to begin. - - .. figure:: /images/channels/google/accounts/register-app/04-generate-oauth-credentials.gif - :alt: Screencast demo of OAuth app creation in Google Developer settings - :align: center - - Application type - Choose **Web application**. - - Authorized redirect URIs - *E.g.,* - ``https://your-domain.com/api/v1/external_credentials/google/callback`` - - Find it in the Zammad admin panel - under **Channels > Google > Connect Google App > Your callback URL**. - -5. **Connect your Google app in Zammad** - - Copy your new OAuth app's credentials (**client ID** and **client secret**) - into Zammad in the admin panel, under - **Channels > Google > Connect Google App**. - - .. figure:: /images/channels/google/accounts/register-app/05-add-oauth-credentials.gif - :alt: Screencast demo of entering Gmail OAuth credentials in Zammad - admin panel - :align: center - -🍾 Congratulations! Now you're ready to connect Gmail accounts to Zammad. - -Troubleshooting ---------------- - -My OAuth credentials stopped working all of a sudden - Did you recently reset your Google password? - - (Google invalidates all your OAuth tokens whenever you change your password. - Generate a new one per Steps 4 and 5 above.) diff --git a/channels/google/basic-setup.rst b/channels/google/basic-setup.rst new file mode 100644 index 00000000..115d93d9 --- /dev/null +++ b/channels/google/basic-setup.rst @@ -0,0 +1,253 @@ +Basic Setup +=========== + +To set up a new Gmail or G Suite channel in Zammad, you first have +to create an **OAuth app** in Google's Cloud console. Then you can connect +Zammad with your Google account and add as many Gmail accounts to Zammad as +you want, using only active Gmail browser sessions (no usernames or passwords +required). + +If you already set up Google email channels in Zammad, you can easily +migrate them to a Google channel. Follow the steps below but skip the step +"Add Account" and proceed with :ref:`migrate-channel`. + +.. _register-oauth-google: + +Register an OAuth App +--------------------- + +Sign in to the `Google Cloud console `_. +You should see a dashboard where you can add a new project. If you already +have an app which is in production, create a new one and follow the steps +below. + +Create an OAuth Consent Screen +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the left sidebar of your project's "APIs & Services" section, select +OAuth consent screen and provide the requested information. + +.. figure:: /images/channels/google/oauth-consent-screen.png + :alt: Screenshot shows OAuth consent screen creation in Google Cloud console + +In the first screen, select "Internal" as User Type and click on "Create". + +Provide the following information in the next screen: + +- **App name**: enter a suitable name for this app +- **User support email**: select an email address from the dropdown +- **Authorized domain**: the domain of your Zammad without http or https prefix +- **Developer contact information**: enter a valid email address + +After entering the information, click on "Save and Continue". You should be +on the "Scopes" screen. Click on "Add or Remove Scopes" to see the dialog as in +the following screenshot. + +.. figure:: /images/channels/google/add-api.png + :scale: 60% + :align: center + :alt: Screenshot with highlighted API selection + +1. Enter ``https://mail.google.com`` in the "Manually add scopes" text field +2. Click on "Add to Table" to have it in the selectable scopes table above +3. Select it by checking the box +4. Confirm by clicking the "Update" button + +Go on by clicking "Save and Continue". If your app is in "Testing" mode, add a +user as which you want to sign in to your Google account. +After that you see a summary screen where you can check the information. +Confirm by clicking the "Back to Dashboard" button and go on with creating +credentials for your app. + +Create Credentials +^^^^^^^^^^^^^^^^^^ + +Select "Credentials" in the left sidebar, click on "➕ Create Credentials" and +choose "OAuth client ID". + +.. figure:: /images/channels/google/add-credentials-oauth.png + :alt: Screenshot shows credentials screen with highlighted elements + :align: center + +Select "Web application" as Application type, give it a name and enter your +redirect URL. + +.. figure:: /images/channels/google/oauth-credentials-dialog.png + :alt: + :align: center + +The redirect URL is basically the domain of your Zammad instance, extended with +``/api/v1/external_credentials/google/callback``. + +You can even find the complete redirect URL in Zammad's admin area +under Channels > Google. Click on "Configure App" and find your URL under +"Your callback URL". + +.. figure:: /images/channels/google/configure-app-dialog.png + :alt: Screenshot shows Zammad's configuration dialog for a Google app + :align: center + :scale: 70% + +Click on "Create" after inserting the information. You will see a dialog with +your client ID and client secret. You need both of them in the next step for +configuring Zammad to connect it to Google. + +Configure App +------------- + +Go to Channels > Google in Zammad's admin area and click on "Configure App". +Insert the client ID and client secret which you got in the step before. + +.. figure:: /images/channels/google/client-id-secret.png + :alt: Screenshot shows dialogs from Google and Zammad with client ID and secret + :scale: 70% + :align: center + +Confirm by clicking the "Submit" button. Now you can add a Google account as +channel in Zammad, see next step. + +Add Account +----------- + +If you already have Google email channels, you can skip this step and head over +to :ref:`migrate-channel`. + +After you've registered Zammad as an OAuth app, you can connect Gmail accounts +to Zammad. + +☠️ **But first, a word of warning!** +The import process does things you might not expect: + +.. danger:: + * By default, Zammad will **delete all emails** in your inbox + during the import process. Use the *Keep Messages on Server* setting to + :ref:`disable this behavior `. + * Zammad will send an auto-reply message + to every email it imports (including the old ones!). + Make sure to :doc:`disable this behavior ` + prior adding an email account and to turn it back on once all your + messages have been imported. + +To connect you Google account, click on "Add Account" in Zammad. You will be +redirected to a consent dialog. Click through the screens and and make sure +to select the desired Google account as well as to grant the permission for +email handling as you can see in the following screenshot. + +.. figure:: /images/channels/google/consent-screen-email-permission.png + :alt: Screenshot shows Google's consent screen with checked email permission + :scale: 50% + :align: center + +After clicking on "Continue", you are redirected to Zammad where you can see a +dialog for specifying a folder and if you want to keep messages on the server. + +.. _google-folder: + +Folder + Specify which folder (or *label*) to fetch from, + or leave empty to fetch from ``INBOX``. + If specifying a nested folder, be sure to use the full path, + e.g. ``Inquiries/Tech-Support``. + + .. _google-keep-messages-on-server: + +Keep messages on server + Specify what happens to your emails after Zammad imports them: + + * ``no``: Zammad deletes all imported messages + * ``yes``: Zammad marks imported messages as read. With this option, + Zammad will only import unread messages. This means Zammad may miss + messages if the mailbox is externally modified. + + .. note:: 🤔 **Why does Zammad delete messages by default?** + + If you never clean out your inbox, + it'll eventually reach its storage limit, + and your mail server will start **rejecting incoming messages**. + Most Zammad users never even look at their inbox once it's set up, + so they rely on Zammad to keep it clean for them. + + If you choose **yes** here, remember that it's your responsibility + to clean out your inbox from time to time + to keep it below its storage limit. + + +After successfully adding the Google account, you can adjust +the default group Zammad is going to assign incoming new tickets to. + +.. figure:: /images/channels/google/change-destination-group.png + :alt: Location of "Destination Group" setting for existing accounts + :scale: 70% + :align: center + +Only **active** groups will be displayed. Changing this setting will not +reassign existing tickets to the new group. + +.. _migrate-channel: + +Migrate from Email Channel +-------------------------- + +Convert Email Channel to Google Channel +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Zammad provides a migration logic that allows you to migrate existing Google +accounts from an email channel into a Google channel. + +.. note:: 🧐 **Zammad is expecting specific settings** + + In order for Zammad to display the migration option, it expects the channels + hostname to be ``imap.gmail.com`` for IMAP and ``smtp.gmail.com`` for SMTP. + +The easiest way to start the migration is to :ref:`register-oauth-google` for +your Google accounts before migrating. However, if you don't, Zammad will ask +you to provide your app credentials before allowing you to continue. + +If you're ready to go, simply click on the *Migrate now!* button in the red +banner of the email channel in question. Zammad will redirect you to +Google and request you to authenticate and consent to said account. + +After you pressed next you'll be redirect to Zammad's Google channel overview. +Your channel, if successful, is now migrated to an Google channel. + +.. figure:: /images/channels/google/migrate-email-channel-to-google.gif + :alt: Migrate an existing email channel to Google + :align: center + +Rolling Back the Migration +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In case something went wrong, Zammad allows you to roll back the migration +for up to 7 days. For this time period Zammad will remember your original +credentials and restore it if needed. These information will be removed +entirely after 7 days. + + .. figure:: /images/channels/google/rollback-migration.png + :alt: Migrate an existing email channel to Google + :scale: 90% + :align: center + +Troubleshooting +--------------- + +My OAuth credentials stopped working + Did you recently change your Google password? Google invalidates all your + OAuth tokens whenever you change it. + +How to use the Gmail account for outgoing system notifications? + On **subscription/cloud-hosted instances**, you can't do that. + Notifications will always come from + “Notification Master ”. + + On **self-hosted instances**, we still don't recommend it. + Using a Gmail account for automated, outgoing messages is risky: + users who exceed Google's `email sending limits + `_ + can have their accounts suspended. + + Set up a generic :doc:`email channel ` instead and + use the :ref:`Email Notification ` setting. + +I successfully added my account, but Zammad isn't fetching new emails + If you specified a :ref:`custom folder/label to fetch from `, + are you sure incoming mail is arriving in that folder? \ No newline at end of file diff --git a/channels/google/index.rst b/channels/google/index.rst index 40a46f9a..ea431fb3 100644 --- a/channels/google/index.rst +++ b/channels/google/index.rst @@ -4,7 +4,9 @@ Google .. toctree:: :hidden: - accounts + basic-setup + accounts/managing-accounts + accounts/secondary-addresses filters signatures settings @@ -13,16 +15,37 @@ Google Connect a Gmail or G Suite account to Zammad. .. figure:: /images/channels/google/panel.png - :alt: Email settings panel + :alt: Google channel settings panel :align: center .. note:: Google channels are a specialized kind of :doc:`📨 email channel `. If you're already familiar with email channels, - you can skip most of this - but **watch out for the “Accounts” section**, - which has a few extra quirks due to Google's strict security measures. + you can skip most of this. However, you should have a look at the + :doc:`./basic-setup` to get started. -.. include:: /channels/email/index.rst - :start-after: .. start-after-migration - :end-before: Extra Options for Self-Hosted Users +:doc:`basic-setup` + Connect Zammad to Google and add an account to fetch emails from. + + Self-hosted users may have already completed this step during new + system setup. + +:doc:`Filters ` + Make sure new tickets show up in the right place + with automated, if-this-then-that rules for all incoming email. + +:doc:`Signatures ` + Customize signatures for all outgoing emails. + +:doc:`Settings ` + Manage options like: + + * set the “From:” address on system notifications + * raise the limit on attachment sizes + * modify subject-line prefixes (*e.g.,* use “AW:” instead of “RE:”) + +:doc:`Header based actions ` + Manipulate auto response behavior or incoming routing. + + .. warning:: 🤓 This is a very advanced topic. diff --git a/images/channels/google/accounts/account-setup/add-gmail-account-to-zammad.gif b/images/channels/google/accounts/account-setup/add-gmail-account-to-zammad.gif deleted file mode 100644 index ff3a35df..00000000 Binary files a/images/channels/google/accounts/account-setup/add-gmail-account-to-zammad.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/01-create-project.gif b/images/channels/google/accounts/register-app/01-create-project.gif deleted file mode 100644 index b4e179cd..00000000 Binary files a/images/channels/google/accounts/register-app/01-create-project.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/02-enable-api.gif b/images/channels/google/accounts/register-app/02-enable-api.gif deleted file mode 100644 index 8d29111c..00000000 Binary files a/images/channels/google/accounts/register-app/02-enable-api.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/03-set-up-consent-screen.gif b/images/channels/google/accounts/register-app/03-set-up-consent-screen.gif deleted file mode 100644 index 6d2587c3..00000000 Binary files a/images/channels/google/accounts/register-app/03-set-up-consent-screen.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/04-generate-oauth-credentials.gif b/images/channels/google/accounts/register-app/04-generate-oauth-credentials.gif deleted file mode 100644 index 252ecc94..00000000 Binary files a/images/channels/google/accounts/register-app/04-generate-oauth-credentials.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/05-add-oauth-credentials.gif b/images/channels/google/accounts/register-app/05-add-oauth-credentials.gif deleted file mode 100644 index ffc2c883..00000000 Binary files a/images/channels/google/accounts/register-app/05-add-oauth-credentials.gif and /dev/null differ diff --git a/images/channels/google/accounts/register-app/sign-in-with.png b/images/channels/google/accounts/register-app/sign-in-with.png deleted file mode 100644 index df0cf307..00000000 Binary files a/images/channels/google/accounts/register-app/sign-in-with.png and /dev/null differ diff --git a/images/channels/google/add-api.png b/images/channels/google/add-api.png new file mode 100644 index 00000000..9cefee3f Binary files /dev/null and b/images/channels/google/add-api.png differ diff --git a/images/channels/google/add-credentials-oauth.png b/images/channels/google/add-credentials-oauth.png new file mode 100644 index 00000000..0b716562 Binary files /dev/null and b/images/channels/google/add-credentials-oauth.png differ diff --git a/images/channels/google/add-credentials.png b/images/channels/google/add-credentials.png new file mode 100644 index 00000000..eb648042 Binary files /dev/null and b/images/channels/google/add-credentials.png differ diff --git a/images/channels/google/add-gmail-alias.gif b/images/channels/google/add-gmail-alias.gif deleted file mode 100644 index a028a44b..00000000 Binary files a/images/channels/google/add-gmail-alias.gif and /dev/null differ diff --git a/images/channels/google/accounts/account-setup/change-destination-group.png b/images/channels/google/change-destination-group.png similarity index 100% rename from images/channels/google/accounts/account-setup/change-destination-group.png rename to images/channels/google/change-destination-group.png diff --git a/images/channels/google/client-id-secret.png b/images/channels/google/client-id-secret.png new file mode 100644 index 00000000..756a1f56 Binary files /dev/null and b/images/channels/google/client-id-secret.png differ diff --git a/images/channels/google/configure-app-dialog.png b/images/channels/google/configure-app-dialog.png new file mode 100644 index 00000000..0bc1a1d1 Binary files /dev/null and b/images/channels/google/configure-app-dialog.png differ diff --git a/images/channels/google/consent-screen-email-permission.png b/images/channels/google/consent-screen-email-permission.png new file mode 100644 index 00000000..028c38ef Binary files /dev/null and b/images/channels/google/consent-screen-email-permission.png differ diff --git a/images/channels/google/create-app-credentials-and-provide-zammad.gif b/images/channels/google/create-app-credentials-and-provide-zammad.gif deleted file mode 100644 index 66002b36..00000000 Binary files a/images/channels/google/create-app-credentials-and-provide-zammad.gif and /dev/null differ diff --git a/images/channels/google/accounts/account-setup/gmail-account-settings.png b/images/channels/google/gmail-account-settings.png similarity index 100% rename from images/channels/google/accounts/account-setup/gmail-account-settings.png rename to images/channels/google/gmail-account-settings.png diff --git a/images/channels/google/accounts/migrate-email-channel-to-google.gif b/images/channels/google/migrate-email-channel-to-google.gif similarity index 100% rename from images/channels/google/accounts/migrate-email-channel-to-google.gif rename to images/channels/google/migrate-email-channel-to-google.gif diff --git a/images/channels/google/oauth-consent-screen.png b/images/channels/google/oauth-consent-screen.png new file mode 100644 index 00000000..d051db54 Binary files /dev/null and b/images/channels/google/oauth-consent-screen.png differ diff --git a/images/channels/google/oauth-credentials-dialog.png b/images/channels/google/oauth-credentials-dialog.png new file mode 100644 index 00000000..573c92eb Binary files /dev/null and b/images/channels/google/oauth-credentials-dialog.png differ diff --git a/images/channels/google/panel.png b/images/channels/google/panel.png index 99b627a1..9c2a0012 100644 Binary files a/images/channels/google/panel.png and b/images/channels/google/panel.png differ diff --git a/images/channels/google/accounts/managing-accounts/rollback-migration.png b/images/channels/google/rollback-migration.png similarity index 100% rename from images/channels/google/accounts/managing-accounts/rollback-migration.png rename to images/channels/google/rollback-migration.png diff --git a/images/channels/google/accounts/account-setup/unverified-app-warning.png b/images/channels/google/unverified-app-warning.png similarity index 100% rename from images/channels/google/accounts/account-setup/unverified-app-warning.png rename to images/channels/google/unverified-app-warning.png diff --git a/locale/admin-docs.pot b/locale/admin-docs.pot index bbe947dc..31516f22 100644 --- a/locale/admin-docs.pot +++ b/locale/admin-docs.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Zammad Admin Documentation pre-release\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-09 20:51+0500\n" +"POT-Creation-Date: 2024-09-20 12:42+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -156,13 +156,11 @@ msgid "The final result will look like the following:" msgstr "" #: ../channels/email/accounts.rst:2 -#: ../channels/google/accounts.rst:2 #: ../channels/microsoft365/accounts.rst:2 msgid "Accounts" msgstr "" #: ../channels/email/accounts.rst:18 -#: ../channels/google/accounts.rst:32 #: ../channels/microsoft365/accounts.rst:32 msgid ":doc:`accounts/account-setup`" msgstr "" @@ -178,32 +176,27 @@ msgid "New Email Account dialog" msgstr "" #: ../channels/email/accounts.rst:27 -#: ../channels/google/accounts.rst:50 #: ../channels/microsoft365/accounts.rst:50 msgid ":doc:`accounts/secondary-addresses`" msgstr "" #: ../channels/email/accounts.rst:21 -#: ../channels/google/accounts.rst:44 #: ../channels/microsoft365/accounts.rst:44 msgid "Send and receive email at **additional email addresses**, all through the same mailbox/account." msgstr "" #: ../channels/email/accounts.rst:37 -#: ../channels/google/accounts.rst:58 #: ../channels/microsoft365/accounts.rst:58 msgid ":doc:`accounts/managing-accounts`" msgstr "" #: ../channels/email/accounts.rst:30 -#: ../channels/google/accounts.rst:53 #: ../channels/microsoft365/accounts.rst:53 msgid "Edit the configuration of existing accounts in the **Accounts Panel**." msgstr "" #: ../channels/email/accounts.rst:0 #: ../channels/email/accounts/managing-accounts.rst:None -#: ../channels/google/accounts.rst:0 #: ../channels/email/accounts/managing-accounts.rst:None #: ../channels/microsoft365/accounts.rst:0 #: ../channels/email/accounts/managing-accounts.rst:None @@ -219,7 +212,6 @@ msgid "Configure the outgoing mail provider for **system notifications**. (Self- msgstr "" #: ../channels/email/accounts/account-setup.rst:2 -#: ../channels/google/accounts/account-setup.rst:2 #: ../channels/microsoft365/accounts/account-setup.rst:2 msgid "Account Setup" msgstr "" @@ -229,7 +221,7 @@ msgid "Setting up a new email account? Here's what all the settings do." msgstr "" #: ../channels/email/accounts/account-setup.rst:6 -#: ../channels/google/accounts/account-setup.rst:8 +#: ../channels/google/basic-setup.rst:118 #: ../channels/microsoft365/accounts/account-setup.rst:7 msgid "☠️ **But first, a word of warning!** The import process does things you might not expect:" msgstr "" @@ -247,7 +239,7 @@ msgid "**Gmail / G Suite users:**" msgstr "" #: ../channels/email/accounts/account-setup.rst:25 -msgid "Google is in the process of upgrading its security policies. To stay up-to-date, do **not** add your account as an email channel — instead, create a :doc:`Google channel `." +msgid "Google is in the process of upgrading its security policies. To stay up-to-date, do **not** add your account as an email channel — instead, create a :doc:`Google channel `." msgstr "" #: ../channels/email/accounts/account-setup.rst:33 @@ -263,7 +255,7 @@ msgid "Basic" msgstr "" #: ../channels/email/accounts/account-setup.rst:39 -msgid "In most cases, Zammad is smart enough to figure out your email provider's configuration based on your email address alone. If the correct configuration could not be retreived, Zammad asks you to provide the correct parameters manually." +msgid "In most cases, Zammad is smart enough to figure out your email provider's configuration based on your email address alone. If the correct configuration could not be retrieved, Zammad asks you to provide the correct parameters manually." msgstr "" #: ../channels/email/accounts/account-setup.rst:49 @@ -490,7 +482,7 @@ msgid "Your email server's port (usu. ``993`` for IMAP, or ``995`` for POP3)." msgstr "" #: ../channels/email/accounts/account-setup.rst:173 -#: ../channels/google/accounts/account-setup.rst:73 +#: ../channels/google/basic-setup.rst:152 #: ../channels/microsoft365/accounts/account-setup.rst:130 msgid "Folder" msgstr "" @@ -512,39 +504,41 @@ msgid "If this folder does not receive incoming messages automatically, you may msgstr "" #: ../channels/email/accounts/account-setup.rst:197 -#: ../channels/google/accounts/account-setup.rst:95 +#: ../channels/google/basic-setup.rst:173 #: ../channels/microsoft365/accounts/account-setup.rst:152 msgid "Keep messages on server" msgstr "" #: ../channels/email/accounts/account-setup.rst:176 -#: ../channels/google/accounts/account-setup.rst:76 +#: ../channels/google/basic-setup.rst:155 #: ../channels/microsoft365/accounts/account-setup.rst:133 msgid "Specify what happens to your emails after Zammad imports them:" msgstr "" #: ../channels/email/accounts/account-setup.rst:178 +#: ../channels/google/basic-setup.rst:157 msgid "``no``: Zammad deletes all imported messages" msgstr "" #: ../channels/email/accounts/account-setup.rst:180 +#: ../channels/google/basic-setup.rst:158 msgid "``yes``: Zammad marks imported messages as read. With this option, Zammad will only import unread messages. This means Zammad may miss messages if the mailbox is externally modified." msgstr "" #: ../channels/email/accounts/account-setup.rst:185 -#: ../channels/google/accounts/account-setup.rst:85 +#: ../channels/google/basic-setup.rst:162 #: ../channels/microsoft365/accounts/account-setup.rst:142 msgid "🤔 **Why does Zammad delete messages by default?**" msgstr "" #: ../channels/email/accounts/account-setup.rst:187 -#: ../channels/google/accounts/account-setup.rst:87 +#: ../channels/google/basic-setup.rst:164 #: ../channels/microsoft365/accounts/account-setup.rst:144 msgid "If you never clean out your inbox, it'll eventually reach its storage limit, and your mail server will start **rejecting incoming messages**. Most Zammad users never even look at their inbox once it's set up, so they rely on Zammad to keep it clean for them." msgstr "" #: ../channels/email/accounts/account-setup.rst:193 -#: ../channels/google/accounts/account-setup.rst:93 +#: ../channels/google/basic-setup.rst:170 #: ../channels/microsoft365/accounts/account-setup.rst:150 msgid "If you choose **yes** here, remember that it's your responsibility to clean out your inbox from time to time to keep it below its storage limit." msgstr "" @@ -663,27 +657,23 @@ msgstr "" #: ../channels/email/accounts/account-setup-group-hint.include.rst:1 #: ../channels/email/accounts/account-setup-group-hint.include.rst:1 #: ../channels/email/accounts/account-setup-group-hint.include.rst:1 -#: ../channels/email/accounts/account-setup-group-hint.include.rst:1 msgid "🤓 **Don't forget to set the outgoing email address**" msgstr "" #: ../channels/email/accounts/account-setup-group-hint.include.rst:3 #: ../channels/email/accounts/account-setup-group-hint.include.rst:3 #: ../channels/email/accounts/account-setup-group-hint.include.rst:3 -#: ../channels/email/accounts/account-setup-group-hint.include.rst:3 msgid "In Zammad each group decides about the email address that's used for outgoing emails. The incoming group technically has no effect on it." msgstr "" #: ../channels/email/accounts/account-setup-group-hint.include.rst:6 #: ../channels/email/accounts/account-setup-group-hint.include.rst:6 #: ../channels/email/accounts/account-setup-group-hint.include.rst:6 -#: ../channels/email/accounts/account-setup-group-hint.include.rst:6 msgid "For this reason make sure to also adjust each affected :doc:`groups setting `." msgstr "" #: ../channels/email/accounts/account-setup.rst:292 -#: ../channels/google/accounts/account-setup.rst:113 -#: ../channels/google/accounts/register-app.rst:116 +#: ../channels/google/basic-setup.rst:231 #: ../channels/microsoft365/accounts/account-setup.rst:170 #: ../settings/security/third-party/saml.rst:203 #: ../system/integrations/cti/includes/troubleshooting.include.rst:2 @@ -786,15 +776,14 @@ msgid "Click on the group name to reassign the account." msgstr "" #: ../channels/email/accounts/managing-accounts.rst:0 -#: ../channels/google/accounts/account-setup.rst:0 #: ../channels/email/accounts/managing-accounts.rst:0 +#: ../channels/google/basic-setup.rst:None #: ../channels/microsoft365/accounts/account-setup.rst:0 #: ../channels/email/accounts/managing-accounts.rst:0 msgid "Location of \"Destination Group\" setting for existing accounts" msgstr "" #: ../channels/email/accounts/managing-accounts.rst:21 -#: ../channels/google/accounts/account-setup.rst:106 #: ../channels/email/accounts/managing-accounts.rst:21 #: ../channels/microsoft365/accounts/account-setup.rst:163 #: ../channels/email/accounts/managing-accounts.rst:21 @@ -802,7 +791,6 @@ msgid "Only **active** groups will be displayed." msgstr "" #: ../channels/email/accounts/managing-accounts.rst:23 -#: ../channels/google/accounts/account-setup.rst:108 #: ../channels/email/accounts/managing-accounts.rst:23 #: ../channels/microsoft365/accounts/account-setup.rst:165 #: ../channels/email/accounts/managing-accounts.rst:23 @@ -963,7 +951,6 @@ msgid "The alias address to send outgoing messages as." msgstr "" #: ../channels/email/accounts/secondary-addresses.rst:38 -#: ../channels/google/accounts/account-setup.rst:57 #: ../channels/email/accounts/secondary-addresses.rst:38 #: ../channels/microsoft365/accounts/account-setup.rst:114 #: ../channels/email/accounts/secondary-addresses.rst:38 @@ -1833,7 +1820,6 @@ msgid "Set up a :doc:`Microsoft 365 channel ` inst msgstr "" #: ../channels/email/index.rst:None -#: ../channels/google/index.rst:None #: ../channels/microsoft365/index.rst:None msgid "Email settings panel" msgstr "" @@ -1847,7 +1833,7 @@ msgid "At this moment Zammad supports XOAUTH for the following providers:" msgstr "" #: ../channels/email/index.rst:31 -msgid ":doc:`Google `" +msgid ":ref:`Google `" msgstr "" #: ../channels/email/index.rst:32 @@ -1860,102 +1846,91 @@ msgstr "" #: ../channels/email/index.rst:44 #: ../channels/email/index.rst:8 -#: ../channels/email/index.rst:8 msgid ":doc:`👥 Accounts `" msgstr "" #: ../channels/email/index.rst:40 #: ../channels/email/index.rst:4 -#: ../channels/email/index.rst:4 msgid "**Connect Zammad to your email provider** so that it can watch your inbox, send auto-replies, and more." msgstr "" #: ../channels/email/index.rst:43 #: ../channels/email/index.rst:7 -#: ../channels/email/index.rst:7 msgid "(Self-hosted users may have already completed this step during new system setup.)" msgstr "" #: ../channels/email/index.rst:48 #: ../channels/email/index.rst:12 -#: ../channels/email/index.rst:12 msgid ":doc:`🗂️ Filters `" msgstr "" #: ../channels/email/index.rst:47 #: ../channels/email/index.rst:11 -#: ../channels/email/index.rst:11 msgid "**Make sure new tickets show up in the right place** with automated, if-this-then-that rules for all incoming email." msgstr "" #: ../channels/email/index.rst:51 #: ../channels/email/index.rst:15 -#: ../channels/email/index.rst:15 msgid ":doc:`📜 Signatures `" msgstr "" #: ../channels/email/index.rst:51 #: ../channels/email/index.rst:15 -#: ../channels/email/index.rst:15 msgid "Customize signatures for all outgoing email." msgstr "" #: ../channels/email/index.rst:63 #: ../channels/email/index.rst:27 -#: ../channels/email/index.rst:27 msgid ":doc:`⚙️ Settings `" msgstr "" #: ../channels/email/index.rst:54 -#: ../channels/email/index.rst:18 +#: ../channels/google/index.rst:42 #: ../channels/email/index.rst:18 msgid "Manage options like:" msgstr "" #: ../channels/email/index.rst:56 -#: ../channels/email/index.rst:20 +#: ../channels/google/index.rst:44 #: ../channels/email/index.rst:20 msgid "set the “From:” address on system notifications" msgstr "" #: ../channels/email/index.rst:57 -#: ../channels/email/index.rst:21 +#: ../channels/google/index.rst:45 #: ../channels/email/index.rst:21 msgid "raise the limit on attachment sizes" msgstr "" #: ../channels/email/index.rst:58 -#: ../channels/email/index.rst:22 +#: ../channels/google/index.rst:46 #: ../channels/email/index.rst:22 msgid "modify subject-line prefixes (*e.g.,* use “AW:” instead of “RE:”)" msgstr "" #: ../channels/email/index.rst:60 #: ../channels/email/index.rst:24 -#: ../channels/email/index.rst:24 msgid "Want to **manually edit email subjects** or **always copy parent messages into your replies**?" msgstr "" #: ../channels/email/index.rst:63 #: ../channels/email/index.rst:27 -#: ../channels/email/index.rst:27 msgid "Check the ✍️ :doc:`/misc/composer`." msgstr "" #: ../channels/email/index.rst:68 #: ../channels/email/index.rst:33 -#: ../channels/email/index.rst:33 msgid ":doc:`📇 Header based actions `" msgstr "" #: ../channels/email/index.rst:66 -#: ../channels/email/index.rst:30 +#: ../channels/google/index.rst:49 #: ../channels/email/index.rst:30 msgid "Manipulate auto response behavior or incoming routing." msgstr "" #: ../channels/email/index.rst:68 -#: ../channels/email/index.rst:32 +#: ../channels/google/index.rst:51 #: ../channels/email/index.rst:32 msgid "🤓 This is a very advanced topic." msgstr "" @@ -2875,464 +2850,417 @@ msgstr "" msgid "It's not recommended to delete form.js from it's location in that case, but to forbid access to it via your web server configuration." msgstr "" -#: ../channels/google/accounts.rst:22 -#: ../channels/microsoft365/accounts.rst:22 -msgid ":doc:`accounts/register-app`" -msgstr "" - -#: ../channels/google/accounts.rst:14 -msgid "Use the **Connect Google App** dialog to register Zammad as an OAuth app on Google." -msgstr "" - -#: ../channels/google/accounts.rst:17 -#: ../channels/microsoft365/accounts.rst:17 -msgid "(This step is **required**; read on to learn why.)" -msgstr "" - -#: ../channels/google/accounts.rst:0 -msgid "Registering Zammad as a Google OAuth app" -msgstr "" - -#: ../channels/google/accounts.rst:25 -#: ../channels/microsoft365/accounts.rst:25 -msgid "Use the **Add Account** dialog to connect your account." -msgstr "" - -#: ../channels/google/accounts.rst:27 -#: ../channels/microsoft365/accounts.rst:27 -msgid "You're migrating existing email channels? Look below!" -msgstr "" - -#: ../channels/google/accounts.rst:0 -#: ../channels/microsoft365/accounts.rst:0 -msgid "Adding your gmail account to Zammad" +#: ../channels/google/accounts/managing-accounts.rst:2 +msgid "Managing accounts in Google channels works nearly identically as for email channels. This is why the section has been adopted almost verbatim from :doc:`here `." msgstr "" -#: ../channels/google/accounts.rst:41 -#: ../channels/microsoft365/accounts.rst:41 -msgid ":doc:`accounts/migrate-from-email-channel`" +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:11 +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:10 +#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:11 +#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:10 +msgid "Fetch Preferences" msgstr "" -#: ../channels/google/accounts.rst:35 -msgid "Use the *Migrate now!* button within your email channels to quickly move your mailboxes to Google. You can roll back if things hit the fan!" +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:2 +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:2 +#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:2 +#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:2 +msgid "Click **Edit** on inbound account details to change how messages are retrieved from your account." msgstr "" -#: ../channels/google/accounts.rst:0 -#: ../channels/google/accounts/migrate-from-email-channel.rst:None -#: ../channels/google/accounts/migrate-from-email-channel.rst:0 -msgid "Migrate an existing email channel to Google" +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:5 +#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:5 +msgid "See :ref:`New Account Settings ` for a detailed description of each option." msgstr "" -#: ../channels/google/accounts.rst:0 -msgid "Adding new aliases to your gmail account in Zammad" +#: ../channels/google/accounts/managing-accounts.delete-note.rst:8 +#: ../channels/google/accounts/managing-accounts.delete-note.rst:8 +msgid "(There's no need to manage orphaned email addresses like you would on an email channel. In Google channels, aliases are connected to your Gmail account, which means they can be imported and purged automatically.)" msgstr "" -#: ../channels/google/accounts.rst:60 -msgid "🤔 **How do I use my Gmail account for outgoing system notifications?**" +#: ../channels/google/accounts/secondary-addresses.rst:3 +msgid "Secondary addresses for accounts in Google channels work the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/accounts.rst:62 -msgid "On **subscription/cloud-hosted instances**, you can’t. Notifications will always come from “Notification Master ”." +#: ../channels/google/accounts/secondary-addresses.warning.rst:1 +#: ../channels/google/accounts/secondary-addresses.warning.rst:1 +msgid "👀 **Secondary addresses must be added and verified in your Gmail settings first.**" msgstr "" -#: ../channels/google/accounts.rst:66 -msgid "On **self-hosted instances**, we still don’t recommend it. Using a Gmail account for automated, outgoing messages is risky: users who exceed Google’s `email sending limits `_ can have their accounts suspended." +#: ../channels/google/accounts/secondary-addresses.warning.rst:3 +#: ../channels/google/accounts/secondary-addresses.warning.rst:3 +msgid "Gmail has its own process for adding and verifying aliases (under **Settings > Accounts and Import > Send mail as**). If you add an alias here before adding it in your Gmail settings, Google will refuse to dispatch it." msgstr "" -#: ../channels/google/accounts.rst:72 -msgid "Set up a generic :doc:`email channel ` instead and use the :ref:`Email Notification ` setting." +#: ../channels/google/accounts/secondary-addresses.warning.rst:8 +#: ../channels/google/accounts/secondary-addresses.warning.rst:8 +msgid "G Suite users may need to contact their administrators in order to add aliases in their Gmail settings." msgstr "" -#: ../channels/google/accounts/account-setup.rst:4 -msgid "After you've :doc:`registered Zammad as an OAuth app ` in your Google Developer settings, you can begin connecting Gmail accounts to Zammad." +#: ../channels/google/basic-setup.rst:2 +msgid "Basic Setup" msgstr "" -#: ../channels/google/accounts/account-setup.rst:12 -msgid "By default, Zammad will **delete all emails** in your inbox during the import process. Use the *Keep Messages on Server* setting to :ref:`disable this behavior `." +#: ../channels/google/basic-setup.rst:4 +msgid "To set up a new Gmail or G Suite channel in Zammad, you first have to create an **OAuth app** in Google's Cloud console. Then you can connect Zammad with your Google account and add as many Gmail accounts to Zammad as you want, using only active Gmail browser sessions (no usernames or passwords required)." msgstr "" -#: ../channels/google/accounts/account-setup.rst:15 -msgid "Zammad will send an auto-reply message to every email it imports (including the old ones!). Make sure to :doc:`disable this behavior ` prior adding an email account and to turn it back on once all your messages have been imported." +#: ../channels/google/basic-setup.rst:10 +msgid "If you already set up Google email channels in Zammad, you can easily migrate them to a Google channel. Follow the steps below but skip the step \"Add Account\" and proceed with :ref:`migrate-channel`." msgstr "" -#: ../channels/google/accounts/account-setup.rst:22 -#: ../channels/microsoft365/accounts/account-setup.rst:26 -msgid "🚛 Migrate an Existing Email Channel" +#: ../channels/google/basic-setup.rst:17 +#: ../channels/microsoft365/accounts/register-app.rst:2 +msgid "Register an OAuth App" msgstr "" -#: ../channels/google/accounts/account-setup.rst:24 -msgid "If you've already added your Google account as a regular email channel, you'll have to convert it to a Google channel eventually: Google is planning to end support for simple password authentication in third-party email clients (like Zammad)." +#: ../channels/google/basic-setup.rst:19 +msgid "Sign in to the `Google Cloud console `_. You should see a dashboard where you can add a new project. If you already have an app which is in production, create a new one and follow the steps below." msgstr "" -#: ../channels/google/accounts/account-setup.rst:29 -#: ../channels/microsoft365/accounts/account-setup.rst:33 -msgid "Please refer the :doc:`migrate-from-email-channel` guide." +#: ../channels/google/basic-setup.rst:25 +msgid "Create an OAuth Consent Screen" msgstr "" -#: ../channels/google/accounts/account-setup.rst:32 -#: ../channels/microsoft365/accounts/account-setup.rst:80 -msgid "Add a New Account" +#: ../channels/google/basic-setup.rst:27 +msgid "In the left sidebar of your project's \"APIs & Services\" section, select OAuth consent screen and provide the requested information." msgstr "" -#: ../channels/google/accounts/account-setup.rst:None -#: ../channels/google/accounts/account-setup.rst:None -msgid "Click on Add Account to add your Google account to Zammad" +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot shows OAuth consent screen creation in Google Cloud console" msgstr "" -#: ../channels/google/accounts/account-setup.rst:39 -msgid "Click **Add Account** to connect your Gmail / G Suite accounts to Zammad. You will be redirected to a Google sign-in and confirmation page." +#: ../channels/google/basic-setup.rst:33 +msgid "In the first screen, select \"Internal\" as User Type and click on \"Create\"." msgstr "" -#: ../channels/google/accounts/account-setup.rst:42 -msgid "Any aliases registered in your Gmail settings will be imported automatically." +#: ../channels/google/basic-setup.rst:35 +msgid "Provide the following information in the next screen:" msgstr "" -#: ../channels/google/accounts/account-setup.rst:0 -msgid "Google warning for unverified OAuth apps" +#: ../channels/google/basic-setup.rst:37 +msgid "**App name**: enter a suitable name for this app" msgstr "" -#: ../channels/google/accounts/account-setup.rst:51 -msgid "Google has a stringent verification process to protect users from third-party websites that use OAuth to access their data. Since you *are* the third-party website here, you can safely ignore this warning." +#: ../channels/google/basic-setup.rst:38 +msgid "**User support email**: select an email address from the dropdown" msgstr "" -#: ../channels/google/accounts/account-setup.rst:67 -#: ../channels/microsoft365/accounts/account-setup.rst:124 -msgid "Specify which folder (or *label*) to fetch from, or leave empty to fetch from ``INBOX``." +#: ../channels/google/basic-setup.rst:39 +msgid "**Authorized domain**: the domain of your Zammad without http or https prefix" msgstr "" -#: ../channels/google/accounts/account-setup.rst:70 -#: ../channels/microsoft365/accounts/account-setup.rst:127 -msgid "If specifying a nested folder, be sure to use the full path; *e.g.,* ``Inquiries/Tech-Support``." +#: ../channels/google/basic-setup.rst:40 +msgid "**Developer contact information**: enter a valid email address" msgstr "" -#: ../channels/google/accounts/account-setup.rst:78 -#: ../channels/microsoft365/accounts/account-setup.rst:135 -msgid "``no`` Zammad deletes all imported messages" +#: ../channels/google/basic-setup.rst:42 +msgid "After entering the information, click on \"Save and Continue\". You should be on the \"Scopes\" screen. Click on \"Add or Remove Scopes\" to see the dialog as in the following screenshot." msgstr "" -#: ../channels/google/accounts/account-setup.rst:80 -#: ../channels/microsoft365/accounts/account-setup.rst:137 -msgid "``yes`` Zammad marks imported messages as read" +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot with highlighted API selection" msgstr "" -#: ../channels/google/accounts/account-setup.rst:82 -#: ../channels/microsoft365/accounts/account-setup.rst:139 -msgid "(With this option, Zammad will only import unread messages. This means Zammad may miss messages if the mailbox is externally modified.)" +#: ../channels/google/basic-setup.rst:51 +msgid "Enter ``https://mail.google.com`` in the \"Manually add scopes\" text field" msgstr "" -#: ../channels/google/accounts/account-setup.rst:110 -#: ../channels/microsoft365/accounts/account-setup.rst:167 -msgid "After adding the account" +#: ../channels/google/basic-setup.rst:52 +msgid "Click on \"Add to Table\" to have it in the selectable scopes table above" msgstr "" -#: ../channels/google/accounts/account-setup.rst:98 -msgid "After successfully adding the Google mail account, you can adjust the default group Zammad is going to assign incoming new tickets to." +#: ../channels/google/basic-setup.rst:53 +msgid "Select it by checking the box" msgstr "" -#: ../channels/google/accounts/account-setup.rst:116 -#: ../channels/microsoft365/accounts/account-setup.rst:175 -msgid "I successfully added my account, but Zammad isn't fetching new email" +#: ../channels/google/basic-setup.rst:54 +msgid "Confirm by clicking the \"Update\" button" msgstr "" -#: ../channels/google/accounts/account-setup.rst:116 -msgid "If you specified a :ref:`custom folder/label to fetch from `, are you sure incoming mail is arriving in that folder?" +#: ../channels/google/basic-setup.rst:56 +msgid "Go on by clicking \"Save and Continue\". If your app is in \"Testing\" mode, add a user as which you want to sign in to your Google account. After that you see a summary screen where you can check the information. Confirm by clicking the \"Back to Dashboard\" button and go on with creating credentials for your app." msgstr "" -#: ../channels/google/accounts/managing-accounts.rst:2 -msgid "Managing accounts in Google channels works nearly identically as for email channels. This is why the section has been adopted almost verbatim from :doc:`here `." +#: ../channels/google/basic-setup.rst:63 +msgid "Create Credentials" msgstr "" -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:11 -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:10 -#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:11 -#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:10 -msgid "Fetch Preferences" +#: ../channels/google/basic-setup.rst:65 +msgid "Select \"Credentials\" in the left sidebar, click on \"➕ Create Credentials\" and choose \"OAuth client ID\"." msgstr "" -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:2 -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:2 -#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:2 -#: ../channels/microsoft365/accounts/managing-accounts.inbound-outbound.rst:2 -msgid "Click **Edit** on inbound account details to change how messages are retrieved from your account." +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot shows credentials screen with highlighted elements" msgstr "" -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:5 -#: ../channels/google/accounts/managing-accounts.inbound-outbound.rst:5 -msgid "See :ref:`New Account Settings ` for a detailed description of each option." +#: ../channels/google/basic-setup.rst:72 +msgid "Select \"Web application\" as Application type, give it a name and enter your redirect URL." msgstr "" -#: ../channels/google/accounts/managing-accounts.delete-note.rst:8 -#: ../channels/google/accounts/managing-accounts.delete-note.rst:8 -msgid "(There's no need to manage orphaned email addresses like you would on an email channel. In Google channels, aliases are connected to your Gmail account, which means they can be imported and purged automatically.)" +#: ../channels/google/basic-setup.rst:79 +msgid "The redirect URL is basically the domain of your Zammad instance, extended with ``/api/v1/external_credentials/google/callback``." msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:2 -msgid "Migrate From Email Channel to Google Channel" +#: ../channels/google/basic-setup.rst:82 +msgid "You can even find the complete redirect URL in Zammad's admin area under Channels > Google. Click on \"Configure App\" and find your URL under \"Your callback URL\"." msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:4 -msgid "Zammad provides a migration logic that allows you to migrate existing Google accounts from an email channel into a Google channel." +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot shows Zammad's configuration dialog for a Google app" msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:7 -#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:7 -msgid "🧐 **Zammad is expecting specific settings**" +#: ../channels/google/basic-setup.rst:91 +msgid "Click on \"Create\" after inserting the information. You will see a dialog with your client ID and client secret. You need both of them in the next step for configuring Zammad to connect it to Google." msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:9 -msgid "In order for Zammad to display the migration option, it expects the channels hostname to be ``imap.gmail.com`` for IMAP and ``smtp.gmail.com`` for SMTP." +#: ../channels/google/basic-setup.rst:96 +msgid "Configure App" msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:12 -msgid "The easiest way to start the migration is to :doc:`register-app` for your Google accounts before migrating. However, if you don't, Zammad will ask you to provide your app credentials before allowing you to continue." +#: ../channels/google/basic-setup.rst:98 +msgid "Go to Channels > Google in Zammad's admin area and click on \"Configure App\". Insert the client ID and client secret which you got in the step before." msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:16 -msgid "If you're ready to go, simply click on the *Migrate now!* button in the red banner of the email channel in question. Zammad will redirect you to Google and request you to authenticate and consent to said account." +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot shows dialogs from Google and Zammad with client ID and secret" msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:20 -msgid "After you pressed next you'll be redirect to Zammad's Google channel overview. Your channel, if successful, is now migrated to an Google channel." +#: ../channels/google/basic-setup.rst:106 +msgid "Confirm by clicking the \"Submit\" button. Now you can add a Google account as channel in Zammad, see next step." msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:28 -#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:31 -msgid "Rolling Back the Migration" +#: ../channels/google/basic-setup.rst:110 +msgid "Add Account" msgstr "" -#: ../channels/google/accounts/migrate-from-email-channel.rst:30 -#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:33 -msgid "In case something went wrong, Zammad allows you to roll back the migration for up to 7 days. For this time period Zammad will remember your original credentials and restore it if needed. These information will be removed entirely after 7 days." +#: ../channels/google/basic-setup.rst:112 +msgid "If you already have Google email channels, you can skip this step and head over to :ref:`migrate-channel`." msgstr "" -#: ../channels/google/accounts/register-app.rst:2 -#: ../channels/microsoft365/accounts/register-app.rst:2 -msgid "Register an OAuth App" +#: ../channels/google/basic-setup.rst:115 +msgid "After you've registered Zammad as an OAuth app, you can connect Gmail accounts to Zammad." msgstr "" -#: ../channels/google/accounts/register-app.rst:4 -msgid "Setting up a new Gmail / G Suite account? Because of Google's strict security policies, it's not as simple as entering your username and password." +#: ../channels/google/basic-setup.rst:122 +msgid "By default, Zammad will **delete all emails** in your inbox during the import process. Use the *Keep Messages on Server* setting to :ref:`disable this behavior `." msgstr "" -#: ../channels/google/accounts/register-app.rst:8 -msgid "First, you'll have to connect Zammad to your Google account as an **OAuth app** via the Google Developer settings panel. Once that's done, you'll be able to connect as many Gmail accounts to Zammad as you want, using only active Gmail browser sessions (no usernames or passwords required)." +#: ../channels/google/basic-setup.rst:125 +msgid "Zammad will send an auto-reply message to every email it imports (including the old ones!). Make sure to :doc:`disable this behavior ` prior adding an email account and to turn it back on once all your messages have been imported." msgstr "" -#: ../channels/google/accounts/register-app.rst:14 -#: ../channels/microsoft365/accounts/register-app.rst:14 -msgid "🤔 **What the heck is OAuth?**" +#: ../channels/google/basic-setup.rst:131 +msgid "To connect you Google account, click on \"Add Account\" in Zammad. You will be redirected to a consent dialog. Click through the screens and and make sure to select the desired Google account as well as to grant the permission for email handling as you can see in the following screenshot." msgstr "" -#: ../channels/google/accounts/register-app.rst:16 -msgid "If you've ever used a website that lets you “Sign in with Google/Facebook/Twitter”, you've used OAuth. OAuth is a way for you to let a third-party website see a tiny slice of your Google/Facebook/Twitter account data without giving them your password (which would let them see *everything*)." +#: ../channels/google/basic-setup.rst:None +msgid "Screenshot shows Google's consent screen with checked email permission" msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -#: ../channels/microsoft365/accounts/register-app.rst:0 -msgid "Screenshot of website with various OAuth sign-in options" +#: ../channels/google/basic-setup.rst:141 +msgid "After clicking on \"Continue\", you are redirected to Zammad where you can see a dialog for specifying a folder and if you want to keep messages on the server." msgstr "" -#: ../channels/google/accounts/register-app.rst:26 -msgid "When a third-party website wants to use OAuth, it has to **register with the provider first** (*i.e.,* Google). This way, the provider knows who's receiving its users' data, and can give users a way to revoke access if they change their minds." +#: ../channels/google/basic-setup.rst:147 +msgid "Specify which folder (or *label*) to fetch from, or leave empty to fetch from ``INBOX``. If specifying a nested folder, be sure to use the full path, e.g. ``Inquiries/Tech-Support``." msgstr "" -#: ../channels/google/accounts/register-app.rst:31 -msgid "In this case, **Zammad is that third-party website**. That's why adding a Gmail account is a two-stage process: first, you have to register Zammad as a website that wishes to access Google user data; then, you have to add yourself as a Google user who agrees to let Zammad fetch your email." +#: ../channels/google/basic-setup.rst:175 +msgid "After successfully adding the Google account, you can adjust the default group Zammad is going to assign incoming new tickets to." msgstr "" -#: ../channels/google/accounts/register-app.rst:38 -#: ../channels/microsoft365/accounts/register-app.rst:40 -msgid "Step-by-Step" +#: ../channels/google/basic-setup.rst:183 +msgid "Only **active** groups will be displayed. Changing this setting will not reassign existing tickets to the new group." msgstr "" -#: ../channels/google/accounts/register-app.rst:40 -msgid "To get started, head over to `Google's Developer settings panel `_." +#: ../channels/google/basic-setup.rst:189 +msgid "Migrate from Email Channel" msgstr "" -#: ../channels/google/accounts/register-app.rst:43 -msgid "**Create a new project**" +#: ../channels/google/basic-setup.rst:192 +msgid "Convert Email Channel to Google Channel" msgstr "" -#: ../channels/google/accounts/register-app.rst:45 -msgid "For the purposes of this guide, a “project” and an OAuth app are the same thing. You may name it whatever you wish." +#: ../channels/google/basic-setup.rst:194 +msgid "Zammad provides a migration logic that allows you to migrate existing Google accounts from an email channel into a Google channel." msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -msgid "Screencast demo of new project creation in Google Developer settings" +#: ../channels/google/basic-setup.rst:197 +#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:7 +msgid "🧐 **Zammad is expecting specific settings**" msgstr "" -#: ../channels/google/accounts/register-app.rst:52 -msgid "**Enable & add the Gmail API**" +#: ../channels/google/basic-setup.rst:199 +msgid "In order for Zammad to display the migration option, it expects the channels hostname to be ``imap.gmail.com`` for IMAP and ``smtp.gmail.com`` for SMTP." msgstr "" -#: ../channels/google/accounts/register-app.rst:54 -msgid "Use the **➕ Enable APIs and Services** button to start your search." +#: ../channels/google/basic-setup.rst:202 +msgid "The easiest way to start the migration is to :ref:`register-oauth-google` for your Google accounts before migrating. However, if you don't, Zammad will ask you to provide your app credentials before allowing you to continue." msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -msgid "Screencast demo of enabling Gmail API in Google Developer settings" +#: ../channels/google/basic-setup.rst:206 +msgid "If you're ready to go, simply click on the *Migrate now!* button in the red banner of the email channel in question. Zammad will redirect you to Google and request you to authenticate and consent to said account." msgstr "" -#: ../channels/google/accounts/register-app.rst:60 -msgid "**Set up the OAuth consent screen**" +#: ../channels/google/basic-setup.rst:210 +msgid "After you pressed next you'll be redirect to Zammad's Google channel overview. Your channel, if successful, is now migrated to an Google channel." msgstr "" -#: ../channels/google/accounts/register-app.rst:62 -msgid "Configure who can use your app, what kind of access it's asking for, and a few fine print details (like a link to Zammad's privacy policy)." +#: ../channels/google/basic-setup.rst:None +#: ../channels/google/basic-setup.rst:0 +msgid "Migrate an existing email channel to Google" msgstr "" -#: ../channels/google/accounts/register-app.rst:65 -msgid "This information will be displayed in the process of connecting a Gmail account to Zammad, when users are redirected to Google for sign-in/confirmation." +#: ../channels/google/basic-setup.rst:218 +#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:31 +msgid "Rolling Back the Migration" msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -msgid "Screencast demo of OAuth consent screen setup in Google Developer\n" -"settings" +#: ../channels/google/basic-setup.rst:220 +#: ../channels/microsoft365/accounts/migrate-from-email-channel.rst:33 +msgid "In case something went wrong, Zammad allows you to roll back the migration for up to 7 days. For this time period Zammad will remember your original credentials and restore it if needed. These information will be removed entirely after 7 days." msgstr "" -#: ../channels/google/accounts/register-app.rst:79 -msgid "User Type" +#: ../channels/google/basic-setup.rst:235 +msgid "My OAuth credentials stopped working" msgstr "" -#: ../channels/google/accounts/register-app.rst:75 -msgid "This option is only available to G Suite users." +#: ../channels/google/basic-setup.rst:234 +msgid "Did you recently change your Google password? Google invalidates all your OAuth tokens whenever you change it." msgstr "" -#: ../channels/google/accounts/register-app.rst:77 -msgid "If you have the option, choose **Internal** (unless you plan on creating channels for Gmail addresses from outside your G Suite domain)." +#: ../channels/google/basic-setup.rst:249 +msgid "How to use the Gmail account for outgoing system notifications?" msgstr "" -#: ../channels/google/accounts/register-app.rst:82 -msgid "Scopes for Google APIs" +#: ../channels/google/basic-setup.rst:238 +msgid "On **subscription/cloud-hosted instances**, you can't do that. Notifications will always come from “Notification Master ”." msgstr "" -#: ../channels/google/accounts/register-app.rst:82 -msgid "Add **Gmail API: https://mail.google.com**." +#: ../channels/google/basic-setup.rst:242 +msgid "On **self-hosted instances**, we still don't recommend it. Using a Gmail account for automated, outgoing messages is risky: users who exceed Google's `email sending limits `_ can have their accounts suspended." msgstr "" -#: ../channels/google/accounts/register-app.rst:84 -msgid "**Generate OAuth credentials**" +#: ../channels/google/basic-setup.rst:248 +msgid "Set up a generic :doc:`email channel ` instead and use the :ref:`Email Notification ` setting." msgstr "" -#: ../channels/google/accounts/register-app.rst:86 -msgid "Click on **➕ Create credentials > OAuth client ID** to begin." +#: ../channels/google/basic-setup.rst:252 +msgid "I successfully added my account, but Zammad isn't fetching new emails" msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -msgid "Screencast demo of OAuth app creation in Google Developer settings" +#: ../channels/google/basic-setup.rst:252 +msgid "If you specified a :ref:`custom folder/label to fetch from `, are you sure incoming mail is arriving in that folder?" msgstr "" -#: ../channels/google/accounts/register-app.rst:93 -msgid "Application type" +#: ../channels/google/email-headers.rst:3 +msgid "Header based actions in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/accounts/register-app.rst:93 -msgid "Choose **Web application**." +#: ../channels/google/filters.rst:3 +msgid "Filters in Google channels work in the same way as filters in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/accounts/register-app.rst:100 -msgid "Authorized redirect URIs" +#: ../channels/google/filters/system-filters.rst:3 +msgid "System Filters in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/accounts/register-app.rst:96 -msgid "*E.g.,* ``https://your-domain.com/api/v1/external_credentials/google/callback``" +#: ../channels/google/index.rst:2 +#: ../settings/security/third-party/google.rst:2 +msgid "Google" msgstr "" -#: ../channels/google/accounts/register-app.rst:99 -msgid "Find it in the Zammad admin panel under **Channels > Google > Connect Google App > Your callback URL**." +#: ../channels/google/index.rst:15 +msgid "Connect a Gmail or G Suite account to Zammad." msgstr "" -#: ../channels/google/accounts/register-app.rst:102 -msgid "**Connect your Google app in Zammad**" +#: ../channels/google/index.rst:None +msgid "Google channel settings panel" msgstr "" -#: ../channels/google/accounts/register-app.rst:104 -msgid "Copy your new OAuth app's credentials (**client ID** and **client secret**) into Zammad in the admin panel, under **Channels > Google > Connect Google App**." +#: ../channels/google/index.rst:21 +msgid "Google channels are a specialized kind of :doc:`📨 email channel `." msgstr "" -#: ../channels/google/accounts/register-app.rst:0 -msgid "Screencast demo of entering Gmail OAuth credentials in Zammad\n" -"admin panel" +#: ../channels/google/index.rst:24 +msgid "If you're already familiar with email channels, you can skip most of this. However, you should have a look at the :doc:`./basic-setup` to get started." msgstr "" -#: ../channels/google/accounts/register-app.rst:113 -msgid "🍾 Congratulations! Now you're ready to connect Gmail accounts to Zammad." +#: ../channels/google/index.rst:32 +msgid ":doc:`basic-setup`" msgstr "" -#: ../channels/google/accounts/register-app.rst:121 -msgid "My OAuth credentials stopped working all of a sudden" +#: ../channels/google/index.rst:29 +msgid "Connect Zammad to Google and add an account to fetch emails from." msgstr "" -#: ../channels/google/accounts/register-app.rst:119 -msgid "Did you recently reset your Google password?" +#: ../channels/google/index.rst:31 +msgid "Self-hosted users may have already completed this step during new system setup." msgstr "" -#: ../channels/google/accounts/register-app.rst:121 -msgid "(Google invalidates all your OAuth tokens whenever you change your password. Generate a new one per Steps 4 and 5 above.)" +#: ../channels/google/index.rst:36 +msgid ":doc:`Filters `" msgstr "" -#: ../channels/google/accounts/secondary-addresses.rst:3 -msgid "Secondary addresses for accounts in Google channels work the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/google/index.rst:35 +msgid "Make sure new tickets show up in the right place with automated, if-this-then-that rules for all incoming email." msgstr "" -#: ../channels/google/accounts/secondary-addresses.warning.rst:1 -#: ../channels/google/accounts/secondary-addresses.warning.rst:1 -msgid "👀 **Secondary addresses must be added and verified in your Gmail settings first.**" +#: ../channels/google/index.rst:39 +msgid ":doc:`Signatures `" msgstr "" -#: ../channels/google/accounts/secondary-addresses.warning.rst:3 -#: ../channels/google/accounts/secondary-addresses.warning.rst:3 -msgid "Gmail has its own process for adding and verifying aliases (under **Settings > Accounts and Import > Send mail as**). If you add an alias here before adding it in your Gmail settings, Google will refuse to dispatch it." +#: ../channels/google/index.rst:39 +msgid "Customize signatures for all outgoing emails." msgstr "" -#: ../channels/google/accounts/secondary-addresses.warning.rst:8 -#: ../channels/google/accounts/secondary-addresses.warning.rst:8 -msgid "G Suite users may need to contact their administrators in order to add aliases in their Gmail settings." +#: ../channels/google/index.rst:46 +msgid ":doc:`Settings `" msgstr "" -#: ../channels/google/email-headers.rst:3 -msgid "Header based actions in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/google/index.rst:50 +msgid ":doc:`Header based actions `" msgstr "" -#: ../channels/google/filters.rst:3 -msgid "Filters in Google channels work in the same way as filters in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/google/settings.rst:3 +msgid "Settings in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/filters/system-filters.rst:3 -msgid "System Filters in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/google/signatures.rst:3 +msgid "Signatures in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." msgstr "" -#: ../channels/google/index.rst:2 -#: ../settings/security/third-party/google.rst:2 -msgid "Google" +#: ../channels/microsoft365/accounts.rst:22 +msgid ":doc:`accounts/register-app`" msgstr "" -#: ../channels/google/index.rst:13 -msgid "Connect a Gmail or G Suite account to Zammad." +#: ../channels/microsoft365/accounts.rst:14 +msgid "Use the **Connect Microsoft 365 App** dialog to register Zammad as an OAuth app on Microsoft." msgstr "" -#: ../channels/google/index.rst:19 -msgid "Google channels are a specialized kind of :doc:`📨 email channel `." +#: ../channels/microsoft365/accounts.rst:17 +msgid "(This step is **required**; read on to learn why.)" msgstr "" -#: ../channels/google/index.rst:22 -msgid "If you're already familiar with email channels, you can skip most of this - but **watch out for the “Accounts” section**, which has a few extra quirks due to Google's strict security measures." +#: ../channels/microsoft365/accounts.rst:0 +msgid "Registering Zammad as a Microsoft OAuth app" msgstr "" -#: ../channels/google/settings.rst:3 -msgid "Settings in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/microsoft365/accounts.rst:25 +msgid "Use the **Add Account** dialog to connect your account." msgstr "" -#: ../channels/google/signatures.rst:3 -msgid "Signatures in Google channels work in the same way as in email channels. This is why the section has been adopted verbatim from :doc:`here `." +#: ../channels/microsoft365/accounts.rst:27 +msgid "You're migrating existing email channels? Look below!" msgstr "" -#: ../channels/microsoft365/accounts.rst:14 -msgid "Use the **Connect Microsoft 365 App** dialog to register Zammad as an OAuth app on Microsoft." +#: ../channels/microsoft365/accounts.rst:0 +msgid "Adding your gmail account to Zammad" msgstr "" -#: ../channels/microsoft365/accounts.rst:0 -msgid "Registering Zammad as a Microsoft OAuth app" +#: ../channels/microsoft365/accounts.rst:41 +msgid ":doc:`accounts/migrate-from-email-channel`" msgstr "" #: ../channels/microsoft365/accounts.rst:35 @@ -3385,10 +3313,18 @@ msgstr "" msgid "For this to function ensure to set a password for the account in question. You'll need these credentials to authenticate against later during adding the account." msgstr "" +#: ../channels/microsoft365/accounts/account-setup.rst:26 +msgid "🚛 Migrate an Existing Email Channel" +msgstr "" + #: ../channels/microsoft365/accounts/account-setup.rst:28 msgid "If you've already added your Microsoft 365 account as a regular email channel, you'll have to convert it to a Microsoft 365 channel eventually: Microsoft is planning to end support for simple password authentication in third-party email clients (like Zammad)." msgstr "" +#: ../channels/microsoft365/accounts/account-setup.rst:33 +msgid "Please refer the :doc:`migrate-from-email-channel` guide." +msgstr "" + #: ../channels/microsoft365/accounts/account-setup.rst:36 msgid "Requesting Administrator Consent" msgstr "" @@ -3439,6 +3375,10 @@ msgid "Within Enterprise applications grant requests within admin consent\n" "requests" msgstr "" +#: ../channels/microsoft365/accounts/account-setup.rst:80 +msgid "Add a New Account" +msgstr "" + #: ../channels/microsoft365/accounts/account-setup.rst:86 msgid "Below shown screencast shows the authentication process with enabled admin consent and already tenant wide granted permission." msgstr "" @@ -3471,10 +3411,38 @@ msgstr "" msgid "Click on Add Account to add your Microsoft 365 account to Zammad" msgstr "" +#: ../channels/microsoft365/accounts/account-setup.rst:124 +msgid "Specify which folder (or *label*) to fetch from, or leave empty to fetch from ``INBOX``." +msgstr "" + +#: ../channels/microsoft365/accounts/account-setup.rst:127 +msgid "If specifying a nested folder, be sure to use the full path; *e.g.,* ``Inquiries/Tech-Support``." +msgstr "" + +#: ../channels/microsoft365/accounts/account-setup.rst:135 +msgid "``no`` Zammad deletes all imported messages" +msgstr "" + +#: ../channels/microsoft365/accounts/account-setup.rst:137 +msgid "``yes`` Zammad marks imported messages as read" +msgstr "" + +#: ../channels/microsoft365/accounts/account-setup.rst:139 +msgid "(With this option, Zammad will only import unread messages. This means Zammad may miss messages if the mailbox is externally modified.)" +msgstr "" + +#: ../channels/microsoft365/accounts/account-setup.rst:167 +msgid "After adding the account" +msgstr "" + #: ../channels/microsoft365/accounts/account-setup.rst:155 msgid "After successfully adding the Microsoft 365 mail account, you can adjust the default group Zammad is going to assign incoming new tickets to." msgstr "" +#: ../channels/microsoft365/accounts/account-setup.rst:175 +msgid "I successfully added my account, but Zammad isn't fetching new email" +msgstr "" + #: ../channels/microsoft365/accounts/account-setup.rst:173 msgid "If you specified a :ref:`custom folder/label to fetch from `, are you sure incoming mail is arriving in that folder?" msgstr "" @@ -3537,10 +3505,18 @@ msgstr "" msgid "First, you'll have to connect Zammad to your Microsoft account as an **OAuth app** via the Microsoft Azure Portal. Once that's done, you'll be able to connect as many Microsoft 365 accounts to Zammad as you want, using only active Microsoft 365 browser sessions (no usernames or passwords required)." msgstr "" +#: ../channels/microsoft365/accounts/register-app.rst:14 +msgid "🤔 **What the heck is OAuth?**" +msgstr "" + #: ../channels/microsoft365/accounts/register-app.rst:16 msgid "If you've ever used a website that lets you “Sign in with Google/Facebook/Twitter”, you've used OAuth. OAuth is a way for you to let a third-party website see a tiny slice of your Microsoft/Facebook/Twitter account data without giving them your password (which would let them see *everything*)." msgstr "" +#: ../channels/microsoft365/accounts/register-app.rst:0 +msgid "Screenshot of website with various OAuth sign-in options" +msgstr "" + #: ../channels/microsoft365/accounts/register-app.rst:26 msgid "When a third-party website wants to use OAuth, it has to **register with the provider first** (*i.e.,* Microsoft). This way, the provider knows who's receiving its users' data, and can give users a way to revoke access if they change their minds." msgstr "" @@ -3549,6 +3525,10 @@ msgstr "" msgid "In this case, **Zammad is that third-party website**. That's why adding a Microsoft account is a two-stage process: first, you have to register Zammad as a website that wishes to access Microsoft user data; then, you have to add yourself as a Microsoft user who agrees to let Zammad fetch your email." msgstr "" +#: ../channels/microsoft365/accounts/register-app.rst:40 +msgid "Step-by-Step" +msgstr "" + #: ../channels/microsoft365/accounts/register-app.rst:42 msgid "To get started, head over to `Microsoft's Azure Portal `_. Make sure to use an admin account for your organization. Otherwise, an admin will have to approve your changes before they can take effect." msgstr ""