Click here to Skip to main content
Click here to Skip to main content
Go to top

IMAP Client library using C#

, 20 Sep 2012
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

 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command [modified] PinmemberJavier Suero3-Jul-13 2:43 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command PinmemberMember 800245418-Mar-14 0:26 
AnswerRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command PinmemberRohit Joshi8-Jun-13 15:51 
GeneralRe: Failure searching IMAP with the given criteria. IMAP004 BAD Could not parse command PinmemberJavier Suero3-Jul-13 6:35 
QuestionCan't obtain email body Pinmembereladfrn16-Oct-12 4:46 
GeneralMessage Removed Pinmemberrk.tedlapu8-Oct-12 2:19 
GeneralRe: My vote of 4 PinmemberRohit Joshi8-Oct-12 3:44 
QuestionHow to save the mail in "sent items" folder Pinmemberrk.tedlapu8-Oct-12 2:14 
Hi Rohit,
 
Its really nice script and its very helpful.
 
I am looking for saving the mail in "sent items" in exchange server using IMAP. could you please help me on this?
 

 
Thanks in advance,
Ravi
AnswerRe: How to save the mail in "sent items" folder PinmemberRohit Joshi8-Oct-12 3:43 
GeneralRe: How to save the mail in "sent items" folder Pinmemberrk.tedlapu8-Oct-12 4:00 
Questionhelp me using IMAP Client library Pinmembersupperthin022-Oct-12 21:38 
AnswerRe: help me using IMAP Client library PinmemberRohit Joshi8-Oct-12 3:33 
QuestionCannot read email send using any smartphone (blackberry,iphone, android) Pinmembereveniza23-Sep-12 17:47 
AnswerRe: Cannot read email send using any smartphone (blackberry,iphone, android) PinmemberRohit Joshi8-Oct-12 3:29 
Questionhow to search gmail spam folder PinmemberHoeKeat19-Sep-12 17:53 
AnswerRe: how to search gmail spam folder PinmemberRohit Joshi20-Sep-12 5:21 
GeneralRe: how to search gmail spam folder PinmemberBrian High29-Sep-13 3:17 
Questionhow to mark email to UNREAD Pinmembereveniza13-Aug-12 16:19 
AnswerRe: how to mark email to UNREAD PinmemberRoysten181819-Sep-12 1:19 
AnswerRe: how to mark email to UNREAD PinmemberRohit Joshi19-Sep-12 6:44 
GeneralHow to get plan text mail Pinmembersajiunni26-Jun-12 2:59 
GeneralRe: How to get plan text mail PinmemberRohit Joshi26-Jun-12 11:29 
GeneralRe: How to get plan text mail Pinmembersajiunni26-Jun-12 21:54 
QuestionIndexOutOfRangeException problem PinmemberAces11715-Jun-12 9:55 
QuestionHow I can get all the messages Pinmembercesar823-May-12 17:02 

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 | Mobile
Web01 | 2.8.140905.1 | Last Updated 20 Sep 2012
Article Copyright 2004 by Rohit Joshi
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid