Sunday, July 21, 2024
HomePHPStep-by-Step Information for Integrating Gmail Performance in PHP

Step-by-Step Information for Integrating Gmail Performance in PHP

On this PHP Gmail API tutorial, We’ll have a look at find out how to combine Google’s Gmail API’s to your PHP purposes. You could entry and management emails, labels, draughts, and plenty of different capabilities by way of the Gmail API, which affords a wealthy vary of functionalities.

By the top of this tutorial, You’ll have the data and code samples to work together with Gmail utilizing PHP and unlock a variety of potentialities to your purposes.

I’ve already shared Ship E-mail From Localhost Utilizing SMTP and PHP.

  1. Arrange the Gmail API:
    • Allow the Gmail API within the Google Builders Console.
    • Create OAuth 2.0 consumer credentials and arrange the required scopes.
    • Configure the mission and procure the required credentials.
  2. Set up the required dependencies:
    • Set up the Google API PHP Consumer Library or the related library to your chosen programming language.
  3. Authenticate and authorize:
    • Arrange the authentication circulate to acquire an entry token for the Gmail API.
    • Implement the OAuth 2.0 authorization course of and procure the required permissions to ship emails.
  4. Assemble the e-mail:
    • Create a brand new Message object and set the required e mail headers resembling sender, recipient, topic, and different optionally available headers.
    • Set the e-mail content material as plain textual content or HTML, relying in your wants.
  5. Ship the e-mail:
    • Use the Gmail API’s customers.messages.ship technique or the equal technique in your chosen programming language’s library to ship the e-mail.
    • Move the constructed Message object as a parameter to the ship technique.

What’s Distinction between SMTP and Gmail APIs

A longtime protocol for transmitting emails is named SMTP (Easy Mail Switch Protocol). By establishing a reference to an SMTP server and coming into the required information, together with the sender, recipient, matter, message, and attachments, it lets you ship emails. SMTP is an easy and broadly used approach for sending emails, nevertheless, it focuses totally on sending features and lacks superior options like e mail administration, enhancing draughts, and accessing in depth message metadata.

Alternatively, the Gmail API affords a wealthy assortment of features made particularly for incorporating Gmail performance into purposes. It permits refined e mail administration, together with entry to and enhancing of message content material, labels, draughts, and attachments. Compared to SMTP, the Gmail API offers extra management, flexibility, and automation potentialities, making it acceptable for apps.

Setting Up the Gmail API

Let’s arrange the Gmail API within the Google Builders Console. We’ll create a brand new mission and allow the Gmail API, and procure the required credentials.

Right here, I’ll let you already know the step-by-step course of to configure Gmail API together with your apps, together with creating OAuth 2.0 consumer credentials, establishing the required scopes, and configuring the mission.

  • Go to Google Builders Console
  • Select “Choose a mission”, it’ll open a brand new modal field and enter hare Title and hit the “Create” button.
  • Go to the API Library web page by deciding on “Library” from the left-hand menu. Search for Gmail API and choose it. Allow the API for the mission of your selection.Sponsored Hyperlinks
  • You’ll be dropped at a Credentials dashboard after the API has been enabled. From the Create Credentials dropdown record, select “OAuth Consumer ID” from the menu.Sponsored Hyperlinks
  • When you attain the web page, you’ll discover a button labeled “Configure consent.” By clicking on this button, you’ll be directed to a web page the place you may simply present the title of your utility and point out the licensed domains.
  • After clicking on “Save,” choose your app sort from the choices supplied (Net App, Android, Chrome App, iOS, or different). Subsequent, assign a reputation to your OAuth Consumer ID. Moreover, present the JavaScript sources and redirect domains that shall be used for requests originating from the browser or internet server. Lastly, click on on “Create” to finalize the method.

Putting in the Google API PHP Consumer Library

The Google API PHP Consumer Library goes to be put in. This library affords easy-to-use lessons and strategies for interacting with Google APIs, together with the Gmail API. We’ll undergo set up and record any stipulations which can be required.


  • php should be put in in your system
  • set up composer into your system

Let’s set up Gmail API libs utilizing composer.

Sponsored Hyperlinks

composer require google/apiclient:"^2.0"

Authenticating with the Gmail API

With a view to present our PHP programme permission to make use of a consumer’s account to entry the Gmail API, we are going to construct the authentication circulate. We’ll undergo find out how to get entry and refresh tokens and find out how to retailer them safely as a part of the OAuth 2.0 authorization course of.

To grant entry to your Gmail account out of your PHP app, you have to to create a file inside your present working listing:

Listing: gmail/quickstart/
Code pattern
Run with: php quickstart.php

You’ll be requested to login in to your Google account or select one account to authorise whenever you run the above code. Code pattern for PHP is offered in this GitHub listing.

Sending Emails with the Gmail API

I’ll now implement e mail sending with PHP. We’ll stroll you thru creating and sending emails, together with selecting the recipients, the topic, the physique, and any attachments.

We will ship to the recipient utilizing instructions messages.ship or draft.ship.

perform sendMessage($service, $userId, $message) {
attempt {
 $message = $service->users_messages->ship($userId, $message);
 print 'Message with ID: ' . $message->getId() . ' despatched mail.';
 return $message;
} catch (Exception $e) {
 print 'An error occurred: ' . $e->getMessage();
 return null;

The total supply code:

perform sendMessage() {
	// Instantiate the Gmail API consumer
	$consumer = new Google_Client();

	// Authenticate and authorize
	$accessToken = getAccessToken(); // Implement your individual technique to acquire the entry token

	// Create the Gmail service
	$service = new Google_Service_Gmail($consumer);

	// Assemble the e-mail
	$e mail = new Google_Service_Gmail_Message();
	$email->setRaw(base64_encode("From: sender@instance.comrn" .
								"To: recipient@instance.comrn" .
								"Topic: Your topic herern" .
								"rn" .
								"E-mail content material goes right here"));

	// Ship the e-mail
	$end result = $service->users_messages->ship("me", $e mail);

	if ($end result) {
		echo "E-mail despatched efficiently!";
	} else {
		echo "Didn't ship the e-mail.";

Make sure that to switch path/to/credentials.json with the precise path to your consumer credentials file, and implement the getAccessToken() technique to acquire the entry token.


You’ve realized find out how to combine the Gmail API into your PHP purposes. You could enhance your purposes with sturdy e mail performance by making use of the Gmail API’s capabilities. By combining PHP and the Gmail API, you may construct and develop distinctive e mail workflows. You can too go over superior capabilities like managing inline images and sending HTML emails.



Please enter your comment!
Please enter your name here

Most Popular

Recent Comments