github.com/jordwest/imap-server@v0.0.0-20200627020849-1cf758ba359f/README.md (about)

     1  ![go-IMAP Logo](https://raw.githubusercontent.com/jordwest/imap-server/master/assets/logo.png)
     2  
     3  # This project is no longer active
     4  
     5  Check out this much more active and mature project instead:
     6  
     7  https://github.com/emersion/go-imap
     8  
     9  
    10  Go IMAP Server
    11  ==============
    12  
    13  [![Travis CI Build Status](https://travis-ci.org/jordwest/imap-server.svg)](https://travis-ci.org/jordwest/imap-server)
    14  
    15  Barebones IMAP4rev1 server for golang. Designed for integration into a
    16  backend app to provide email client access.
    17  
    18  Features a simple API for implementing your own email storage by implementing
    19  golang interfaces. Currently a dummy (in-memory) storage is included, with plans
    20  to include MySQL storage. This would make it simple to integrate into a backend
    21  application to allow users to drag-drop emails into the application, without
    22  messing around with maildir.
    23  
    24  Although it would be possible to implement and plug in a maildir storage
    25  interface, that would defeat the purpose of this project and there are much
    26  better, tried and tested open source and commercial solutions that have been
    27  around for a long time (Courier, Dovecot etc).
    28  The goal of this project is to provide simple IMAP access to some kind of existing
    29  system without the overhead of installing a full-blown IMAP/POP3 mail server.
    30  
    31  
    32  ### NOT READY FOR PRODUCTION USE
    33  Currently only plaintext authentication is implemented. This is really bad,
    34  don't use it in any kind of environment where actual passwords or sensitive
    35  emails exists. Actually don't use it anywhere.
    36  
    37  Supported Commands
    38  ------------------
    39  Command       | Planned  | Implemented  | Tests
    40  ------------- | -------  | -----------  | -----
    41  CAPABILITY    | ✓       | ✓           | ✓
    42  NOOP          | ✓       | ✗           | ✗
    43  LOGOUT        | ✓       | ✓           | ✓
    44  AUTHENTICATE  | ✓       | ✓            | ✗
    45  LOGIN         | ✓       | ✓           | ✗
    46  STARTTLS      | ✓       | ✗           | ✗
    47  EXAMINE       | ✓       | ✓           | ✗
    48  CREATE        | ✓       | ✗            | ✗
    49  DELETE        | ✓       | ✗            | ✗
    50  RENAME        | ✓       | ✗            | ✗
    51  SUBSCRIBE     | ✗       | -            | -
    52  UNSUBSCRIBE   | ✗       | -            | -
    53  LIST          | ✓       | ✓           | ✓
    54  LSUB          | ✓       | ✓           | ✓
    55  STATUS        | ✓       | ✓           | ✓
    56  APPEND        | ✓       | ✓           | ✓
    57  CHECK         | ?        | ✗           | ✗
    58  CLOSE         | ✓       | ✓           | ✗
    59  EXPUNGE       | ✓       | ✓           | ✓
    60  SEARCH        | ✓       | ✗           | ✗
    61  FETCH         | ✓       | ✓           | ✓
    62  STORE         | ✓       | ✓           | ✓
    63  COPY          | ✓       | ✓           | ✓
    64  UID           | ✓       | ✓           | ✓