Click here to Skip to main content
15,867,453 members
Articles / Web Development / HTML

IMAP Client library using C#

Rate me:
Please Sign up or sign in to vote.
4.65/5 (88 votes)
20 Sep 2012MPL2 min read 1.4M   31.9K   184   406
IMAPLibrary supports the basic IMAP protocol functions to fetch messages from the mailbox.

GitHub Link: https://github.com/rohitjoshi/ImapLibrary

 

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

   Image 1
 

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 and PR welcome at github repository!!

 

 

 

 

License

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


Written By
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: notepad attachement [modified] Pin
Rohit Joshi21-Apr-08 13:17
Rohit Joshi21-Apr-08 13:17 
GeneralRe: notepad attachement Pin
joekey6-May-08 0:05
joekey6-May-08 0:05 
GeneralRe: notepad attachement Pin
jymitra28-Jul-10 4:00
jymitra28-Jul-10 4:00 
QuestionMove a message into a folder? Pin
tbrewer11-Apr-08 11:01
tbrewer11-Apr-08 11:01 
AnswerRe: Move a message into a folder? Pin
Atmospherian11-Apr-08 11:54
Atmospherian11-Apr-08 11:54 
GeneralRe: Move a message into a folder? Pin
garryihill5-Oct-11 4:12
garryihill5-Oct-11 4:12 
NewsNew version of library coming soon Pin
Atmospherian11-Apr-08 0:46
Atmospherian11-Apr-08 0:46 
GeneralThe future of this library, Rohit, please respond Pin
Atmospherian8-Apr-08 4:55
Atmospherian8-Apr-08 4:55 
GeneralRe: The future of this library, Rohit, please respond Pin
Rohit Joshi9-Apr-08 3:50
Rohit Joshi9-Apr-08 3:50 
QuestionWorks with gmail? Pin
b_raja7-Apr-08 5:26
b_raja7-Apr-08 5:26 
GeneralRe: Works with gmail? Pin
Atmospherian7-Apr-08 6:10
Atmospherian7-Apr-08 6:10 
AnswerRe: Works with gmail? Pin
sekhar vikram29-May-08 5:30
sekhar vikram29-May-08 5:30 
GeneralAdded SSL support Pin
Atmospherian7-Apr-08 4:24
Atmospherian7-Apr-08 4:24 
GeneralRe: Added SSL support Pin
Member 32792227-Mar-10 22:46
Member 32792227-Mar-10 22:46 
GeneralSelecting Sent Items folder using Select command Pin
Sivasankari Jayaraj27-Mar-08 2:05
Sivasankari Jayaraj27-Mar-08 2:05 
GeneralRe: Selecting Sent Items folder using Select command Pin
Atmospherian23-Apr-08 15:51
Atmospherian23-Apr-08 15:51 
GeneralRe: Selecting Sent Items folder using Select command Pin
Member 473069915-Dec-08 22:52
Member 473069915-Dec-08 22:52 
QuestionList of Folders? Pin
Catalin MAICAN10-Mar-08 3:09
Catalin MAICAN10-Mar-08 3:09 
AnswerRe: List of Folders? Pin
Atmospherian7-Apr-08 15:36
Atmospherian7-Apr-08 15:36 
GeneralRe: List of Folders? [modified] Pin
jymitra22-Jul-10 2:11
jymitra22-Jul-10 2:11 
GeneralRe: List of Folders? Pin
jymitra22-Jul-10 4:00
jymitra22-Jul-10 4:00 
Questionwhat is a Message UID Pin
Usans25-Feb-08 0:22
Usans25-Feb-08 0:22 
GeneralRe: what is a Message UID Pin
Rohit Joshi28-Feb-08 13:31
Rohit Joshi28-Feb-08 13:31 
GeneralReceiveBuffer Pin
Anon1234514-Dec-07 3:16
Anon1234514-Dec-07 3:16 
GeneralRe: ReceiveBuffer Pin
eugeneshklyar14-Dec-07 10:56
eugeneshklyar14-Dec-07 10:56 

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

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