HowTo Use Gmail API to send emails - Revision history

Rwh: /* Install Required Package Using pip */

2025-07-22T18:30:31Z

Install Required Package Using pip

← Older revision		Revision as of 14:30, 22 July 2025
Line 176:		Line 176:

	If you are using a different operating system, you should be able to use "pip" to install the necessary python packages. The example belows show the required python packages using: "pip" in a python virtual environment:		If you are using a different operating system, you should be able to use "pip" to install the necessary python packages. The example belows show the required python packages using: "pip" in a python virtual environment:

			<syntaxhighlight lang="bash" line>
			pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
			</syntaxhighlight>

	‎<syntaxhighlight lang="bash" line>		‎<syntaxhighlight lang="bash" line>

Rwh: /* Enable Gmail API */

2024-08-29T00:27:06Z

Enable Gmail API

← Older revision		Revision as of 20:27, 28 August 2024
Line 7:		Line 7:
	== Enable Gmail API ==		== Enable Gmail API ==

	You will need to select or create a Google project and add the "Gmail API" to the list of APIs & Services panel as shown on the Google Cloud panel below. One can get to your Google Project here: [https://console.cloud.google.com/ Google Project]. Then navigate within the Google Cloud console using the following: Go to Menu > APIs & Services > OAuth consent screen. ~~Then~~, navigate to Menu > APIs & Services > Credentials and click Create Credentials > OAuth client ID. Enter a name for the credential.		You will need to select or create a Google project and add the "Gmail API" to the list of APIs & Services panel as shown on the Google Cloud panel below. One can get to your Google Project here: [https://console.cloud.google.com/ Google Project]. Then navigate within the Google Cloud console using the following: Go to Menu > APIs & Services > OAuth consent screen. Next, navigate to Menu > APIs & Services > Credentials and click Create Credentials > OAuth client ID. Enter a name for the credential.

Rwh: /* Enable Gmail API */

2024-08-29T00:26:31Z

Enable Gmail API

← Older revision		Revision as of 20:26, 28 August 2024
Line 7:		Line 7:
	== Enable Gmail API ==		== Enable Gmail API ==

	You will need to select or create a Google project and add the "Gmail API" to the list of APIs & Services panel as shown on the Google Cloud panel below. One can get to your Google Project here: [https://console.cloud.google.com/ Google Project]		You will need to select or create a Google project and add the "Gmail API" to the list of APIs & Services panel as shown on the Google Cloud panel below. One can get to your Google Project here: [https://console.cloud.google.com/ Google Project]. Then navigate within the Google Cloud console using the following: Go to Menu > APIs & Services > OAuth consent screen. Then, navigate to Menu > APIs & Services > Credentials and click Create Credentials > OAuth client ID. Enter a name for the credential.


	[[File:Apis-and-services.png\|800px\|alt=APIs & Services panel shows that the Gmail API has been enabled for the project\|APIs & Services panel shows that the Gmail API has been enabled for the project]]		[[File:Apis-and-services.png\|800px\|alt=APIs & Services panel shows that the Gmail API has been enabled for the project\|APIs & Services panel shows that the Gmail API has been enabled for the project]]

Rwh: /* Initial Run Confirmation */

2024-08-29T00:23:04Z

Initial Run Confirmation

← Older revision		Revision as of 20:23, 28 August 2024
Line 226:		Line 226:
	== Initial Run Confirmation ==		== Initial Run Confirmation ==

	Try running the script initially by hand.		Try running the script initially by hand. This is best done on a desktop since a browser will be required to grant permissions.

	‎<syntaxhighlight lang="bash" line>		‎<syntaxhighlight lang="bash" line>

Rwh: /* Install Required Package Using pip */

2024-08-29T00:21:06Z

Install Required Package Using pip

← Older revision		Revision as of 20:21, 28 August 2024
Line 210:		Line 210:
	</syntaxhighlight>		</syntaxhighlight>

	To create a python virtual environment use the following:		A virtual python environment may be required to install the required packages using "pip". To create a python virtual environment use the following:
	<syntaxhighlight lang="bash" line>		<syntaxhighlight lang="bash" line>
	python3 -m venv path/to/ven		python3 -m venv path/to/ven

Rwh: /* Install DNF Packages */

2024-08-29T00:19:37Z

Install DNF Packages

← Older revision		Revision as of 20:19, 28 August 2024
Line 163:		Line 163:
	* Easier to create the initial authentication file on a desktop for the user because a browser will be used for this purpose.		* Easier to create the initial authentication file on a desktop for the user because a browser will be used for this purpose.

	== Install DNF Packages ==		== Install Required DNF Packages ==

	The NST distribution does not have all of the Python packages required to run this script by default. You should be able to add the necessary packages via the		The NST distribution does not have all of the Python packages required to run this script by default. You should be able to add the necessary packages via the
Line 171:		Line 171:
	sudo dnf install python3-google-api-client python3-oauth2client		sudo dnf install python3-google-api-client python3-oauth2client
	</syntaxhighlight>		</syntaxhighlight>

			== Install Required Package Using pip ==

	If you are using a different operating system, you should be able to use "pip" to install the necessary python packages. The example belows show the required python packages using: "pip" in a python virtual environment:		If you are using a different operating system, you should be able to use "pip" to install the necessary python packages. The example belows show the required python packages using: "pip" in a python virtual environment:

Rwh: /* Sample Python Script */

2024-08-29T00:18:09Z

Sample Python Script

← Older revision		Revision as of 20:18, 28 August 2024
Line 161:		Line 161:
	* It expects to find the oauth credentials JSON file that you downloaded at $HOME/.local/credentials/email-project-secret.json (feel free to change).		* It expects to find the oauth credentials JSON file that you downloaded at $HOME/.local/credentials/email-project-secret.json (feel free to change).
	* The initial authentication will create a new $HOME/.local/credentials/gmail-api-email-send.json file that will then be used during subsequent invocations.		* The initial authentication will create a new $HOME/.local/credentials/gmail-api-email-send.json file that will then be used during subsequent invocations.
			* Easier to create the initial authentication file on a desktop for the user because a browser will be used for this purpose.

	== Install DNF Packages ==		== Install DNF Packages ==

Rwh: /* Sample Python Script */

2024-08-29T00:13:26Z

Sample Python Script

← Older revision		Revision as of 20:13, 28 August 2024
Line 142:		Line 142:
	http = credentials.authorize(httplib2.Http())		http = credentials.authorize(httplib2.Http())
	service = build('gmail', 'v1', http=http)		service = build('gmail', 'v1', http=http)
			#
			# HTML Content
	send_email(service, 'FROM_USER@DOMAIN', 'TO_USER@DOMAIN', 'My Subject', '<p>My Email <b>Body</b></p>')		send_email(service, 'FROM_USER@DOMAIN', 'TO_USER@DOMAIN', 'My Subject', '<p>My Email <b>Body</b></p>')
	#		#

Rwh: /* Sample Python Script */

2024-08-29T00:12:04Z

Sample Python Script

← Older revision		Revision as of 20:12, 28 August 2024
Line 145:		Line 145:
	#		#
	# Read a plain text file - Send content using a Fixed Font (<pre> - Tag)		# Read a plain text file - Send content using a Fixed Font (<pre> - Tag)
			# TEXT_PATH_FILE_NAME = "/opt/devel/logs/stats.log"
	# with open(TEXT_PATH_FILE_NAME, "r") as src:		# with open(TEXT_PATH_FILE_NAME, "r") as src:
	# contents = src.read()		# contents = src.read()
	# ~~send_email_fixed_font(service,~~ '~~FROM_USER~~@~~DOMAIN~~', '~~TO_USER~~@~~DOMAIN~~', '~~My Subject~~', content)		# fromAddr = 'tom.smith@gmail.com'
			# toAddr = 'bill.frame@verizon.net'
			# subject = 'Stats Log'
			# send_email_fixed_font(service, toAddr, fromAddr, subject, content)
	</syntaxhighlight>		</syntaxhighlight>

Rwh: /* Sample Python Script */

2024-08-29T00:07:07Z

Sample Python Script

← Older revision		Revision as of 20:07, 28 August 2024
Line 54:		Line 54:
	‎<syntaxhighlight lang="python" line>		‎<syntaxhighlight lang="python" line>
	#!/usr/bin/python3		#!/usr/bin/python3
			#
			# Virtual Environment:
			#!/home/<user>/path/to/venv/bin/python3
	#		#
	# NOTE: In order to run this you need to add the following packages to the system		# NOTE: In order to run this you need to add the following packages to the system