etutorialspoint
  • Home
  • PHP
  • MySQL
  • MongoDB
  • HTML
  • Javascript
  • Node.js
  • Express.js
  • Python
  • Jquery
  • R
  • Kotlin
  • DS
  • Blogs
  • Theory of Computation

How to Retrieve Emails from Gmail using PHP IMAP

In this article, you will learn how to retrieve emails from Gmail using PHP IMAP.

Email is fast and most important part of communication. We can easily access it from every communication device. It has great importance in small to large organizations. Everyday, they deal with hundreds or thousands of mails. They may also demand to read the emails mailbox from their applications. Gmail is a free email service provided by Google. Clients can get to Gmail on the web and utilizing third party program that synchronize email content through POP or IMAP protocols.

PHP provides IMAP function to access emails from a remote web server to locally end user client. The IMAP stands for Internet Message Access Protocol. It is an Internet standard protocol used to access email messages from mail server. This provides functionality to access email box by multiple clients and create a web based email client. There are more than 70 different functions starting with imap_* provided by PHP.

How to Retrieve Emails from Gmail using PHP IMAP

Configuration of IMAP in PHP server

Before using IMAP in your script, make sure that imap library is installed on your server and enabled in the configuration file. This is by default provided with WAMP server. You can easily check this in the 'php.ini' file. For this, run the following script and check which ini file is assigned in 'Loaded Configuration File' -

<?php php_info(); ?>

Open the 'php.ini' file and search for line number to load imap-

;extension=imap

If the extension is commented like above, remove the semi column like this and restart the WAMP server to make this effective -

extension=imap

You can check whether IMAP is configured or not using the following code-

if (! function_exists('imap_open')) {
  echo "Error: IMAP is not configured.";
  exit();
} 

It is also necessary to enable the IMAP in Gmail account. For this, go to Gmail Settings->Forwarding and POP/IMAP and enable IMAP checkbox.



IMAP Functions

These are the IMAP functions with descriptions that we will use in script to access emails from Gmail account.

imap_open() function

The mostly used function is imap_open(). This allows to create the connection object with the mail server. This requires the following parameters-

imap_open($mailbox, $username, $password)

$mailbox - It consists of the mailbox path of the server.
$username - It contains the username of mail account.
$password - It contains password of mail account.

Example- Connect to GMAIL Account

imap_open('{imap.gmail.com:993/imap/ssl}INBOX','username','password');

The above code opens an IMAP connection to the GMAIL server named imap.gmail.com on port 993. It also passes along with a username and password as the second and third arguments. If you want to connect to the Yahoo account, the IMAP connection code is -

imap_open('{imap.mail.yahoo.com:993/imap/ssl}INBOX','username','password');

You can also connect to the local mail server using the following code-

imap_open('{localhost:993/imap/ssl}INBOX','username','password');

imap_search()

This function returns messages in an array matching the given search criteria.

imap_search($stream, $criteria)

$stream- It is the IMAP connection object returned by the imap_open() function.
$criteria- It is the search criteria delimited by the spaces. It has some pre-defined constants, like - ALL, ANSWERED, BODY, BCC, CC, etc.


imap_fetch_overview()

It reads an overview of the information in the headers of given message.

imap_fetch_overview($stream, $sequence)

$stream- It is the IMAP connection object returned by the imap_open() function.
$sequence- It is a message sequence description.


imap_fetchbody()

It is used to fetch a particular section of the message body.

imap_fetchbody($stream, $number, $section)

$stream- It is the IMAP connection object returned by the imap_open() function.
$number - It is the number of returning messages.
$section - It is the message part number delimited by the period.




PHP IMAP Example

Here is the simple code for retrieving emails from the GMAIL account. In the search criteria, we have passed keyword 'JOB' to fetch all mails having 'JOB' keyword in mail subject.

<html>
<head>How to Retrieve Emails from Gmail using PHP IMAP</head>
<body>
<h1>Gmail Email Inbox using PHP with IMAP</h1>
<?php
    if (! function_exists('imap_open')) {
        echo "IMAP is not configured.";
        exit();
    } else {
?>
<div class="container">
    <?php 
	/* IMAP Connection code with GMAIL IMAP */
	$imap_conn = imap_open('{imap.gmail.com:993/imap/ssl}INBOX', 'username', 'password') or die('Cannot connect to Gmail: ' . imap_last_error());
	
	/* SET email subject filter criteria */
	$inbox = imap_search($imap_conn, 'SUBJECT "JOB"');
	
	if (! empty($inbox)) {
	?>
    <table class="table table-striped">
	<?php
	foreach ($inbox as $email) {
		// Get email header information
		$overview = imap_fetch_overview($imap_conn, $email, 0);
		// Get email body
		$message = imap_fetchbody($imap_conn, $email, '2');
		$date = date("d F, Y", strtotime($overview[0]->date));
	?>
	<tr>
		<td>
		<?php echo $overview[0]->from; ?>
		</td>
		<td>
		<?php echo $overview[0]->subject; ?> - <?php echo $message; ?>
		</td>
		<td>
		<?php echo $date; ?>
		</td>
	</tr>
	<?php
	} 
	?>
	</table>
<?php
 } 
 // Close imap connection
 imap_close($imap_conn);
}
?>
</div>
</body>
</html>


Related Articles

How to send emojis in email subject and body using PHP
Sending form data to an email using PHP
Simple way to send SMTP mail using Node.js PHP code to send email using SMTP
JavaScript display PDF in the browser using Ajax call
jQuery loop over JSON result after AJAX Success
Simple star rating system using PHP, jQuery and Ajax
jQuery File upload progress bar with file size validation
Print section of page using javascript
Submit a form data without page refresh using PHP, Ajax and Javascript




Most Popular Development Resources
Characteristics of a Good Computer Program
-----------------
Retrieve Data From Database Without Page refresh Using AJAX, PHP and Javascript
-----------------
PHP MySQL PDO Database Connection and CRUD Operations
-----------------
How to get data from XML file in PHP
-----------------
Hypertext Transfer Protocol Overview
-----------------
PHP code to send email using SMTP
-----------------
PHP Create Word Document from HTML
-----------------
How to encrypt password in PHP
-----------------
Splitting MySQL Results Into Two Columns Using PHP
-----------------
Create Dynamic Pie Chart using Google API, PHP and MySQL
-----------------
How to get current directory, filename and code line number in PHP
-----------------
Dynamically Add/Delete HTML Table Rows Using Javascript
-----------------
Get current visitor\'s location using HTML5 Geolocation API and PHP
-----------------
How to Sort Table Data in PHP and MySQL
-----------------
PHP MYSQL Advanced Search Feature
-----------------
Simple star rating system using PHP, jQuery and Ajax
-----------------
Simple pagination in PHP with MySQL
-----------------
Fibonacci Series Program in PHP
-----------------
jQuery loop over JSON result after AJAX Success
-----------------
PHP user registration and login/ logout with secure password encryption
-----------------
How to add multiple custom markers on google map
-----------------
Submit a form data using PHP, AJAX and Javascript
-----------------
Recover forgot password using PHP7 and MySQLi
-----------------
Php file based authentication
-----------------
jQuery File upload progress bar with file size validation
-----------------
PHP Secure User Registration with Login/logout
-----------------
Polling system using PHP, Ajax and MySql
-----------------
Simple PHP File Cache
-----------------
SQL Injection Prevention Techniques
-----------------
CSS Simple Menu Navigation Bar
-----------------
Simple File Upload Script in PHP
-----------------
Preventing Cross Site Request Forgeries(CSRF) in PHP
-----------------
PHP User Authentication by IP Address
-----------------
How to generate QR Code in PHP
-----------------
Calculate the distance between two locations using PHP
-----------------
Simple way to send SMTP mail using Node.js
-----------------
Detect Mobile Devices in PHP
-----------------
Set and Get Cookies in PHP
-----------------
PHP Server Side Form Validation
-----------------
To check whether a year is a leap year or not in php
-----------------
Date Timestamp Formats in PHP
-----------------
Get Visitor\'s location and TimeZone
-----------------
Convert MySQL to JSON using PHP
-----------------
Simple Show Hide Menu Navigation
-----------------
PHP Programming Error Types
-----------------
PHP Sending HTML form data to an Email
-----------------
Driving route directions from source to destination using HTML5 and Javascript
-----------------
How to print specific part of a web page in javascript
-----------------
Google Street View API Example
-----------------
How to select/deselect all checkboxes using Javascript
-----------------
How to add google map on your website and display address on click marker
-----------------
PHP Getting Document of Remote Address
-----------------
PHP Connection and File Handling on FTP Server
-----------------
File Upload Validation in PHP
-----------------
R Plot Types
-----------------


Most Popular Blogs
Most in demand programming languages
Best mvc PHP frameworks in 2019
MariaDB vs MySQL
Most in demand NoSQL databases for 2019
Best AI Startups In India
Kotlin : Android App Development Choice
Kotlin vs Java which one is better
Top Android App Development Languages in 2019
Web Robots
Data Science Recruitment of Freshers - 2019


Interview Questions Answers
Basic PHP Interview
Advanced PHP Interview
MySQL Interview
Javascript Interview
HTML Interview
CSS Interview
Programming C Interview
Programming C++ Interview
Java Interview
Computer Networking Interview
NodeJS Interview
ExpressJS Interview
R Interview


Popular Tutorials
PHP Tutorial (Basic & Advance)
MySQL Tutorial & Exercise
MongoDB Tutorial
Python Tutorial & Exercise
Kotlin Tutorial & Exercise
R Programming Tutorial
HTML Tutorial
jQuery Tutorial
NodeJS Tutorial
ExpressJS Tutorial
Theory of Computation Tutorial
Data Structure Tutorial
Javascript Tutorial




General Knowledge

listen
listen
listen
listen
listen
listen
listen
listen
listen


Learn Popular Language

listen
listen
listen
listen
listen

Blogs

  • Jan 27

    Best AI Startups In India

    Artificial Intelligence is a process of making an intelligent computer machine that does tasks intelligently...

  • Jan 23

    Most in demand programming languages for 2019

    In this article, we have mentioned the analyzed results of the most in demand programming language for 2019...

  • Jan 15

    Web Robots

    Web robots is an internet robot or simply crawlers, or spiders and do not relate this with hardware robots...

  • Jan 12

    Most in demand NoSQL databases software for 2019

    In this article, we have mentioned the analyzed result of most in demand NoSQL database softwares for 2019...

  • Jan 10

    Kotlin : Android App Development Choice

    Kotlin is a general-purpose open-source programming language. It runs on the JVM and its syntax is much like Java...

Follow us

  • etutorialspoint facebook
  • etutorialspoint twitter
  • etutorialspoint linkedin
etutorialspoint youtube
About Us      Contact Us


  • eTutorialsPoint©Copyright 2016-2021. All Rights Reserved.