django-imapauth 0.1

===============
django-imapauth
===============

django-imapauth是django的一个简单的IMAP认证后端。


快速入门
-----------

需求
* Django 1.4.3（已测试）。


1. 安装应用

PyPI版本

```
pip安装django-imapauth
```

开发版本

```
pip install -e git+http://github.com/ouhouhsami/django-imapauth.git#egg=django-imapauth
```

2. 将```'imapauth.backends.IMAPBackend'```添加到您的```AUTHENTICATION_BACKENDS```设置中

```
AUTHENTICATION_BACKENDS = (
'imapauth.backends.IMAPBackend',
'django.contrib.auth.backends.ModelBackend',
)
```

3. 在您的设置中添加```IMAPAUTH_HOST```

```
IMAPAUTH_HOST = 'my_imap_host'
```


用法
-----

使用django-imapauth，当用户尝试在您的系统中进行认证时，```IMAPBackend```将尝试使用其凭据连接到```IMAPAUTH_HOST```。
请注意，用户认证并不意味着他可以访问管理站点。有关示例，请参阅下面的示例，并在```AUTHENTICATION_BACKENDS```中使用```CustomIMAPBackend```


from imapauth.backends import IMAPBackend

class CustomIMAPBackend(IMAPBackend)
def authenticate(self, username=None, password=None)
user = super(CustomIMAPBackend, self).authenticate(username, password)
if user is None
return None
user.is_staff = True
user.save()
return user


更多信息
-------------------

IMAPBackend复制自http://www.djangorocks.com/tutorials/creating-a-custom-authentication-backend/creating-the-imap-authentication-backend.html