Skip to main content

IMAP with CFIMAP

What is IMAP?
IMAP stands for Internet Message Access Protocol. IMAP is one of the two most prevalent Internet standard protocols for e-mail retrieval, the other being the Post Office Protocol (POP). Virtually all modern e-mail clients and mail servers support both protocols as a means of transferring e-mail messages from a server.







An IMAP connection is a live connection to the server. If folders are created, they exist on your account on the server. If messages are moved or deleted, then they are moved or deleted on the server.
With POP3, your mail is saved in a mailbox on the remote server until you check your mail. When you check your mail, all of the mail is immediately downloaded to your computer and is no longer maintained on the server.
IMAP can be thought of as a remote file server, while POP3 can be thought of as a “store-and-forward” service. Ultimately they both accomplish similar tasks but often one will suit your needs better than the other.


CFIMAP:
With CFIMAP tag one can manage mails on an IMAP server.


Syntax:



 action =”DELETE | DELETEFOLDER | CREATEFOLDER | OPEN | CLOSE | RENAMEFOLDER | LISTALLFOLDERS
| MAKREAD | MOVEMAIL | GETALL | GETHEADERONLY”
attachmentpath = “string”
connection = “string”
folder = “string”
generateuniquefilenames = “yes|no”
maxrows = “integer”
messagenumber =”integer”
name = “string”
newfolder = “string”
password = “string”
port = “integer”
recurse = “true|false”
secure = “yes|no”
server = “IMAP server address”
startrow = “integer”
secure = “yes|no”
stoponerror = “true|false”
uid = “integer or comma-delimited list of integers”
username = “SMTP user ID” />

Example:

The below example demonstrates how one can retrieve mail from Gmail using CFIMAP. To do this one needs to enable IMAP in Gmail. Please follow these steps:

  • Login to Gmail with your credentials.
  • Click on the settings link.
  • Click on Select forwarding and POP/IMAP.
  • Here in the IMAP access section click on enable IMAP.

This is it and you are ready to try CFIMAP.
First open a connection with the server, this can be done by specifying server details with action="open".

server = “imap.gmail.com”
username = “yourusername”
action=”open”
secure=”yes”
password = “yourpassword”
connection = “gmailconnection” />


Please note Gmail uses SSL therefore one needs to specify secure="yes". This may vary with other email providers.
Now once the connection is available you can use the connection variable in subsequent calls. To retrieve say all the mails from the INBOX one can use CFIMAP tag with action="getAll".

action=”getAll”
connection = “gmailconnection”
name = "mails" />


Please note one can omit the step of creating an open connection and directly CFIMAP action="getAll" to retrieve mails by specifying various connection details in the same tag.
Now if one needs to close a connection and ensure that the connection is not available in the subsequent calls then use CFIMAP with action="close":

action=”close”
connection = “gmailconnection” />

Comments

Popular posts from this blog

How to use the APP_INITIALIZER token to hook into the Angular bootstrap process

I've been building applications using Angular as a framework of choice for more than a year and this post is not about another React vs Angular or the quirks of each framework. Honestly, I like Angular and every day I discover something new which makes development easier and makes me look like a guy who built something very complex in a matter of hours which would've taken a long time to put the correct architecture in place if I had chosen a different framework. The first thing that I learned in Angular is the use of the APP_INITIALIZER token.

On GraphQL and building an application using React Apollo

When I visualize building an application, I would think of using React and Redux on the front-end which talks to a set of RESTful services built with Node and Hapi (or Express). However, over a period of time, I've realized that this approach does not scale well when you add new features to the front-end. For example, consider a page that displays user information along with courses that a user has enrolled in. At a later point, you decide to add a section that displays popular book titles that one can view and purchase. If every entity is considered as a microservice then to get data from three different microservices would require three http  requests to be sent by the front-end app. The performance of the app would degrade with the increase in the number of http requests. I read about GraphQL and knew that it is an ideal way of building an app and I need not look forward to anything else. The GraphQL layer can be viewed as a facade which sits on top of your RESTful services o...

Using MobX to manage application state in a React application

I have been writing applications using React and Redux for quite some time now and thought of trying other state management solutions out there. It's not that I have faced any issues with Redux; however, I wanted to explore other approaches to state management. I recently came across MobX  and thought of giving it a try. The library uses the premise of  `Observables` to tie the application state with the view layer (React). It's also an implementation of the Flux pattern wherein it uses multiple stores to save the application state; each store referring to a particular entity. Redux, on the other hand, uses a single store with top-level state variables referring to various entities.