Google Mail
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.
Prerequisites
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. These are not the same as the one for Google Calendar. If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions.
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
- The wizard will ask you to choose a project to manage your application. Select a project and select Continue.
- Verify that your Gmail API was enabled and select Go to credentials.
- Navigate to APIs & Services (left sidebar) > Credentials
- Click on the field on the left of the screen, 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. To do this, from the dropdown menu, select your email address.
- You finally need to complete the section: Developer contact information. To do this, 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, or it may enable additional review.
- You will then be automatically taken to the Scopes page. You do not need to add any scopes here, so select Save and Continue to move to the Optional info page. You do not need to add anything to the Optional info page, so select Save and Continue, which will take you to the Summary page. Select Back to Dashboard.
- Select OAuth consent screen again and set Publish Status to Production. Otherwise your credentials will expire every 7 days.
- Make sure Publishing status is set to production.
- Select Credentials in the menu on the left-hand side of the screen, 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”).
- Add
https://my.home-assistant.io/redirect/oauthto Authorized redirect URIs then select Create. This is not a placeholder and 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.
- Double-check that the Gmail API has been automatically enabled. To do this, select Library from the menu, then search for Gmail API. If it is enabled, you will see API Enabled with a green tick next to it. If it is not enabled, then enable it.
Configuration
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:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select Google Mail.
-
Follow the instructions on screen to complete the setup.
The integration setup will next give you instructions to enter the Application Credentials (OAuth Client ID and Client Secret) and authorize Home Assistant to access your 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.
Troubleshooting
If you have an error with your credentials you can delete them in the Application Credentials user interface.
Service google_mail.set_vacation
You can use the service google_mail.set_vacation to set vacation options.
| Service data attribute | Optional | Description | Example |
|---|---|---|---|
enabled |
yes | Turn this off to end vacation responses. | True |
title |
no | The subject for the email. | |
message |
yes | Body of the email. | I am on vacation. |
plain_text |
no | Choose to send message in plain text or HTML. | True |
restrict_contacts |
no | Restrict automatic reply to contacts. | True |
restrict_domain |
no | Restrict automatic reply to domain. This only affects GSuite accounts. | False |
start |
no | First day of the vacation. | 11-20-2022 |
end |
no | Last day of the vacation. | 11-26-2022 |
The added 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 notify.example_gmail_com.
Google Mail Notify Service Data
The following attributes can be placed inside the data key of the service call for extended functionality:
| Attribute | Optional | Description |
|---|---|---|
cc |
yes | List of recipients to be carbon copied. |
bcc |
yes | List of recipients to be back carbon copied. |
from |
yes | Default is current authenticated user. Typically only applies to GSuite accounts where the user has delegate access to a shared mailbox. |
send |
yes | Default is true. Set this to false to create a draft instead. Recipients are not required in this instance. |
Examples
This is the full service call to send an email:
service: notify.example_gmail_com
data:
message: "test"
title: "test email"
target:
- "[email protected]"
data:
cc:
- "[email protected]"
bcc:
- "[email protected]"
from: "[email protected]"
Video Tutorial
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.