The Google Mail integration allows you to connect your Google Mail to Home Assistant. The integration adds a service to allow you to set an email auto-response for when you go on vacation. A
notify service is also added, allowing you to draft or send emails in plain text.
You need to configure developer credentials to allow Home Assistant to access your Google Account. These credentials are the same as the ones for Nest and Google Sheets and YouTube. These are not the same as Device Auth credentials previously recommended for Google Calendar.
In this case, all you need to do is enable the API:
- Go the Google Developers Console Gmail API .
- Confirm the project and Enable the API.
- Continue with the steps described in the Configuration section.
In this case, you need to generate a client secret first:
This section explains how to generate a client ID and client secret on Google Developers Console.
- First, go to the Google Developers Console to enable Gmail API .
- Select Create project, enter a project name and select Create.
- Enable the Gmail API.
- Navigate to APIs & Services (left sidebar) > Credentials.
- In the left sidebar, select OAuth consent screen.
- Select External and Create.
- Set the App name (the name of the application asking for consent) to anything you want, e.g., Home Assistant.
- You then need to select a Support email.
- From the dropdown menu, select your email address.
- Under Developer contact information, enter your email address (the same as above is fine).
- Scroll to the bottom and select Save and continue.
- You don’t have to fill out anything else here. Adding other information to this page (like an app logo) may trigger an additional review process from Google and delay setup by days.
- You will then be automatically taken to the Scopes page.
- You do not need to add any scopes here. Select Save and continue to move to the Test users page.
- You do not need to add anything to the Test users page. Select Save and continue, which will take you to the Summary page.
- Select Back to dashboard.
- Select OAuth consent screen again and under Publishing status, select Publish app.
- Otherwise your credentials will expire every 7 days.
- Make sure Publishing status is set to In production.
- In the left sidebar, select Credentials, then select Create credentials (at the top of the screen), then select OAuth client ID.
- Set the Application type to Web application and give this credential set a name (like “Home Assistant Credentials”).
https://my.home-assistant.io/redirect/oauthto Authorized redirect URIs then select Create.
- This is not a placeholder. It is the URI that must be used.
- You will then be presented with a pop-up saying OAuth client created, showing Your client ID and Your client secret.
- Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly.
- Once you have noted these strings, select OK.
- If you need to find these credentials again at any point, then navigate to APIs & Services > Credentials, and you will see Home Assistant Credentials (or whatever you named them in the previous step) under OAuth 2.0 Client IDs.
- To view both the Client ID and Client secret, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page.
- Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few moments. However, Google states that activation may take up to five hours in some circumstances.
To add the Google Mail integration to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
The integration setup will next give you instructions to enter the Application Credentials (OAuth Client ID and Client Secret) and authorize Home Assistant to connect to Google Mail.
Continue through the steps of selecting the account you want to authorize.
NOTE: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed.
You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select Continue.
The page will now display Link account to Home Assistant?, note Your instance URL. If this is not correct, refer to My Home Assistant. If everything looks good, select Link Account.
You may close the window, and return back to Home Assistant where you should see a Success! message from Home Assistant.
If you have an error with your credentials you can delete them in the Application Credentials user interface.
You can use the service
google_mail.set_vacation to set vacation options.
|Service data attribute||Optional||Description||Example|
||yes||Turn this off to end vacation responses.||True|
||no||The subject for the email.||Vacation|
||yes||Body of the email.||I am on vacation.|
||no||Choose to send message in plain text or HTML.||True|
||no||Restrict automatic reply to contacts.||True|
||no||Restrict automatic reply to domain. This only affects GSuite accounts.||False|
||no||First day of the vacation.||11-20-2022|
||no||Last day of the vacation.||11-26-2022|
notify service will be named after the email address you chose on the consent screen. For example, an email address named “[email protected]” wil display as
The following attributes can be placed inside the
data key of the service call for extended functionality:
||yes||List of recipients to be carbon copied.|
||yes||List of recipients to be back carbon copied.|
||yes||Default is current authenticated user. Typically only applies to GSuite accounts where the user has delegate access to a shared mailbox.|
||yes||Default is true. Set this to false to create a draft instead. Recipients are not required in this instance.|
This is the full service call to send an email:
This video tutorial explains how to set up Gmail in Home Assistant and how you can create a dashboard and automations to send e-mail and toggle your out-of-office notice.