Click here to Skip to main content
11,412,833 members (71,381 online)
Click here to Skip to main content

IMAP Client library using C#

, 20 Sep 2012 MPL
Rate this:
Please Sign up or sign in to vote.
IMAPLibrary supports the basic IMAP protocol functions to fetch messages from the mailbox.

Introduction

The Internet Message Access Protocol (IMAP) allows a client to access and manipulate electronic mail messages on a server. It includes operations for creating, deleting, and renaming mailboxes; checking for new messages; permanently removing messages; setting and clearing flags; [RFC-822] and [MIME-IMB] parsing; searching; and selective fetching of message attributes, texts, and portions thereof. For more information: here.

I have written an IMAP client library which allows basic functionalities like login, select/examine folder, search messages, fetch message (Header, Body), get storage quota, and logout.

This is my first application developed in C#, so don't expect too much in terms of efficiency. It demonstrates the use of sockets, XML writer, and user defined exception handling. Please feel free to modify and use this code.

The attached zip file contains three directories.

IMAP Library: It contains three source files.

  • ImapBase.cs: contains the IMAP commands related to string, and socket related functionality.
  • ImapException.cs: defines the user defined IMAP related error messages.
  • Imap.cs: IMAP client library functions. It has the following public functions:
    • Login: Login to IMAP server. It requires IMAP hostname, port, username, and password.
      <COMMAND_PREFIX> LOGIN <USERID> <PASSWORD>\r\n
    • Logout: Logout and close the socket.
      <COMMAND_PREFIX> LOGOUT\r\n
    • SelectFolder: It selects the folder. It requires folder name as parameter.
      <COMMAND_PREFIX> SELECT <FOLDER>\r\n
    • ExamineFolder: It is similar to SelectFolder, but it does examine.
      <COMMAND_PREFIX> EXAMINE <FOLDER>\r\n
    • GetQuota: Get the quota of the mailbox.
      <COMMAND_PREFIX> GETQUOTAROOT <FOLDER>\r\n
    • SearchMessage: You can search the messages. It will return the UID of messages. E.g., From rjoshi.
      <COMMAND_PREFIX> SEARCH <SEARCH STRING>\r\n
    • FetchMessage: It retrieves the complete message with attachments and writes into an XML file. The XML file will be generated in your current directory with file name as <MessageUID>.xml. You need to pass the XmlTextWriter object, message UID, and flag to fetch body.
      <COMMAND_PREFIX> UID FETCH  <MSG UID> BODY[HEADER]
    • FetchPartBody: Fetch the body for a specific part. It requires message UID, part number as parameter.
    • FetchPartHeader: Fetch the header of message.

Documentation: HTML Documentation for IMAP Library generated using Visual Studio .NET.

IMAP Library test program: The IMAP test program allows users to test the following functionalities.

  • Login
  • Select/Examine folder
  • Search
  • Fetch Message
  • Get Quota
  • Logout
  • Delete Message
  • Mark Message UnRead 
  • Move Message

   
 

Update: Added support for

  1. SSL Connection and verified with gmail
  2. Copy Message
  3. Move Message
  4. Delete Message 
  5. Mark Message Unread  
Please don't forget to Vote if you like this library !!

License

This article, along with any associated source code and files, is licensed under The Mozilla Public License 1.1 (MPL 1.1)

Share

About the Author

Rohit Joshi
Software Developer
United States United States
Rohit Joshi is a software engineer working for a telecom company in USA. He has development expirience using C, C++ ,C#, VoiceXML, ASR, IMAP, LDAP, HTTP, SIP, H323 on unix/linux and platforms.

Comments and Discussions

 
BugBug with large attachments Pin
Alexey T at 9-Mar-15 21:31
memberAlexey T9-Mar-15 21:31 
QuestionAuthenication Failed Error [modified] Pin
Santhakumari S at 26-Feb-15 1:33
memberSanthakumari S26-Feb-15 1:33 
QuestionNew E-Mail Check. Pin
Member 11163511 at 20-Oct-14 12:07
memberMember 1116351120-Oct-14 12:07 
QuestionCrashing at logout with polish mail serivce Pin
Darek22 at 29-Sep-14 2:35
memberDarek2229-Sep-14 2:35 
NewsNuGet Package Pin
CiganoMorrison at 9-Mar-14 21:21
professionalCiganoMorrison9-Mar-14 21:21 
GeneralMy vote of 5 Pin
thaiphong.pham at 15-Dec-13 23:12
memberthaiphong.pham15-Dec-13 23:12 
QuestionIntegration of gmail mails into asp.net using IMAP protocol Pin
surbhinewaskar at 21-Oct-13 0:01
membersurbhinewaskar21-Oct-13 0:01 
AnswerRe: Integration of gmail mails into asp.net using IMAP protocol Pin
Ravi Bhavnani at 5-Nov-13 10:58
professionalRavi Bhavnani5-Nov-13 10:58 
Questioncannot fetch body message on yahoomail Pin
rondrac78 at 29-Jul-13 15:04
memberrondrac7829-Jul-13 15:04 
AnswerRe: cannot fetch body message on yahoomail Pin
Ravi Bhavnani at 5-Nov-13 10:58
professionalRavi Bhavnani5-Nov-13 10:58 
Questionhow to get all the emails in the folder? Pin
sista at 4-Jul-13 23:07
membersista4-Jul-13 23:07 
GeneralMy vote of 5 Pin
Impenneteri at 22-Mar-13 11:01
memberImpenneteri22-Mar-13 11:01 
GeneralRe: My vote of 5 Pin
Rohit Joshi at 8-Jun-13 16:55
memberRohit Joshi8-Jun-13 16:55 
QuestionUnable to find the Message Body while fetching the mail Pin
ramya.km at 29-Jan-13 23:03
memberramya.km29-Jan-13 23:03 
AnswerRe: Unable to find the Message Body while fetching the mail Pin
Rohit Joshi at 8-Jun-13 16:55
memberRohit Joshi8-Jun-13 16:55 
QuestionProblem with attachment fileName Pin
Member 9687806 at 2-Jan-13 3:59
memberMember 96878062-Jan-13 3:59 
AnswerRe: Problem with attachment fileName Pin
Rohit Joshi at 24-Jan-13 5:18
memberRohit Joshi24-Jan-13 5:18 
QuestionMissing parameter in Restore Func Pin
Ikarus76 at 31-Dec-12 1:28
memberIkarus7631-Dec-12 1:28 
Hi,
the re-login in Restore(bool) is done without the ssl flag. I assume the line should look like:

Login(m_sHost, m_nPort, m_sUserId, m_sPassword, m_bSSLEnabled);

regards,
Michael
AnswerRe: Missing parameter in Restore Func Pin
Rohit Joshi at 24-Jan-13 5:15
memberRohit Joshi24-Jan-13 5:15 
QuestionGMail problem, only for GoogleApp account Pin
roberto.roncato at 11-Dec-12 22:24
memberroberto.roncato11-Dec-12 22:24 
AnswerRe: GMail problem, only for GoogleApp account Pin
roberto.roncato at 11-Dec-12 22:38
memberroberto.roncato11-Dec-12 22:38 
GeneralRe: GMail problem, only for GoogleApp account Pin
Rohit Joshi at 24-Jan-13 5:15
memberRohit Joshi24-Jan-13 5:15 
QuestionSearching email subject vlues Pin
thetra at 30-Nov-12 4:43
memberthetra30-Nov-12 4:43 
AnswerRe: Searching email subject vlues [modified] Pin
Rohit Joshi at 30-Nov-12 7:30
memberRohit Joshi30-Nov-12 7:30 
GeneralRe: Searching email subject vlues Pin
thetra at 5-Dec-12 23:20
memberthetra5-Dec-12 23:20 
GeneralRe: Searching email subject vlues Pin
Rohit Joshi at 24-Jan-13 5:17
memberRohit Joshi24-Jan-13 5:17 
QuestionHow to use SearchMessage Pin
Christian A Berczely at 26-Oct-12 8:27
memberChristian A Berczely26-Oct-12 8:27 
AnswerRe: How to use SearchMessage Pin
Rohit Joshi at 29-Oct-12 11:08
memberRohit Joshi29-Oct-12 11:08 
QuestionAdd mail to sent items Pin
RenoMarseille at 20-Oct-12 0:40
memberRenoMarseille20-Oct-12 0:40 
QuestionSTORE command failure Pin
Michael Mak at 16-Oct-12 19:10
memberMichael Mak16-Oct-12 19:10 
AnswerRe: STORE command failure Pin
Rohit Joshi at 17-Oct-12 5:03
memberRohit Joshi17-Oct-12 5:03 
GeneralRe: STORE command failure Pin
Michael Mak at 17-Oct-12 13:00
memberMichael Mak17-Oct-12 13:00 
QuestionFailure bodystructure command Pin
Member 8002454 at 16-Oct-12 6:44
memberMember 800245416-Oct-12 6:44 
QuestionFailure fetching message from IMAP folder/mailbox. BODY[HEADER] Pin
Member 8002454 at 16-Oct-12 6:30
memberMember 800245416-Oct-12 6:30 
QuestionFailure searching IMAP with the given criteria. IMAP004 BAD Could not parse command Pin
Member 8002454 at 16-Oct-12 6:24
memberMember 800245416-Oct-12 6:24 
AnswerRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command Pin
PooranPrasad at 30-May-13 23:07
memberPooranPrasad30-May-13 23:07 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command [modified] Pin
Javier Suero at 3-Jul-13 3:43
memberJavier Suero3-Jul-13 3:43 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command Pin
Member 8002454 at 18-Mar-14 1:26
memberMember 800245418-Mar-14 1:26 
AnswerRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command Pin
Rohit Joshi at 8-Jun-13 16:51
memberRohit Joshi8-Jun-13 16:51 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command Pin
Javier Suero at 3-Jul-13 7:35
memberJavier Suero3-Jul-13 7:35 
QuestionCan't obtain email body Pin
eladfrn at 16-Oct-12 5:46
membereladfrn16-Oct-12 5:46 
GeneralMessage Removed Pin
rk.tedlapu at 8-Oct-12 3:19
memberrk.tedlapu8-Oct-12 3:19 
GeneralRe: My vote of 4 Pin
Rohit Joshi at 8-Oct-12 4:44
memberRohit Joshi8-Oct-12 4:44 
QuestionHow to save the mail in "sent items" folder Pin
rk.tedlapu at 8-Oct-12 3:14
memberrk.tedlapu8-Oct-12 3:14 
AnswerRe: How to save the mail in "sent items" folder Pin
Rohit Joshi at 8-Oct-12 4:43
memberRohit Joshi8-Oct-12 4:43 
GeneralRe: How to save the mail in "sent items" folder Pin
rk.tedlapu at 8-Oct-12 5:00
memberrk.tedlapu8-Oct-12 5:00 
Questionhelp me using IMAP Client library Pin
supperthin02 at 2-Oct-12 22:38
membersupperthin022-Oct-12 22:38 
AnswerRe: help me using IMAP Client library Pin
Rohit Joshi at 8-Oct-12 4:33
memberRohit Joshi8-Oct-12 4:33 
QuestionCannot read email send using any smartphone (blackberry,iphone, android) Pin
eveniza at 23-Sep-12 18:47
membereveniza23-Sep-12 18:47 
AnswerRe: Cannot read email send using any smartphone (blackberry,iphone, android) Pin
Rohit Joshi at 8-Oct-12 4:29
memberRohit Joshi8-Oct-12 4:29 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.150427.1 | Last Updated 20 Sep 2012
Article Copyright 2004 by Rohit Joshi
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid