exchangelib 2.0.1

Exchange Web服务客户端库

这个模块提供了一个良好的性能，良好的行为， 独立于平台的简单接口，用于与 使用Exchange Web的Microsoft Exchange 2007-2016服务器或Office365 服务（EWS）。它目前实现了自动发现和 搜索、创建、更新、删除、导出和上载 日历、邮箱、任务、联系人和通讯组列表项。

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

安装

您可以从pypi安装此软件包：

pip install exchangelib

默认安装不支持kerberos或sspi。对于其他kerberos或sspi支持， 使用额外的kerberos或sspi依赖项安装（请注意，sspi仅在 窗口）：

pip install exchangelib[kerberos]
pip install exchangelib[sspi]

要同时获得这两个，请安装为：

pip install exchangelib[complete]

要安装最新的代码，请直接从github安装：

pip install git+https://github.com/ecederstrand/exchangelib.git

exchangelib使用lxml包和pykerberos来支持kerberos身份验证。 要安装这些软件，您可能需要安装一些附加的操作系统软件包。

在ubuntu上：

apt-get install libxml2-dev libxslt1-dev

# For Kerberos support, also install these:
apt-get install libkrb5-dev build-essential libssl-dev libffi-dev python-dev

在CentOS上：

# For Kerberos support, install these:
yum install gcc python-devel krb5-devel krb5-workstation python-devel

在freebsd上，pip需要一些帮助：

pkg install libxml2 libxslt
CFLAGS=-I/usr/local/include pip install lxml

# For Kerberos support, also install these:
pkg install krb5
CFLAGS=-I/usr/local/include pip install kerberos pykerberos

对于其他操作系统，请参考python包的文档 无法安装。

设置和连接

fromexchangelibimportDELEGATE,IMPERSONATION,Account,Credentials,FaultTolerance, \
    Configuration,NTLM,GSSAPI,SSPI,Build,Version# Specify your credentials. Username is usually in WINDOMAIN\username format, where WINDOMAIN is# the name of the Windows Domain your username is connected to, but some servers also# accept usernames in PrimarySMTPAddress ('myusername@example.com') format (Office365 requires it).# UPN format is also supported, if your server expects that.credentials=Credentials(username='MYWINDOMAIN\\myusername',password='topsecret')# If you're running long-running jobs, you may want to enable fault-tolerance. Fault-tolerance# means that requests to the server do an exponential backoff and sleep for up to a certain# threshold before giving up, if the server is unavailable or responding with error messages.# This prevents automated scripts from overwhelming a failing or overloaded server, and hides# intermittent service outages that often happen in large Exchange installations.# An Account is the account on the Exchange server that you want to connect to. This can be# the account associated with the credentials you connect with, or any other account on the# server that you have been granted access to. If, for example, you want to access a shared# folder, create an Account instance using the email address of the account that the shared # folder belongs to, and access the shared folder through this account.# 'primary_smtp_address' is the primary SMTP address assigned the account. If you enable# autodiscover, an alias address will work, too. In this case, 'Account.primary_smtp_address'# will be set to the primary SMTP address.my_account=Account(primary_smtp_address='myusername@example.com',credentials=credentials,autodiscover=True,access_type=DELEGATE)johns_account=Account(primary_smtp_address='john@example.com',credentials=credentials,autodiscover=True,access_type=DELEGATE)marys_account=Account(primary_smtp_address='mary@example.com',credentials=credentials,autodiscover=True,access_type=DELEGATE)still_marys_account=Account(primary_smtp_address='alias_for_mary@example.com',credentials=credentials,autodiscover=True,access_type=DELEGATE)# Set up a target account and do an autodiscover lookup to find the target EWS endpoint.account=Account(primary_smtp_address='john@example.com',credentials=credentials,autodiscover=True,access_type=DELEGATE)# If your credentials have been given impersonation access to the target account, set a# different 'access_type':account=Account(primary_smtp_address='john@example.com',credentials=credentials,autodiscover=True,access_type=IMPERSONATION)# If the server doesn't support autodiscover, or you want to avoid the overhead of autodiscover,# use a Configuration object to set the server location instead:config=Configuration(server='mail.example.com',credentials=credentials)account=Account(primary_smtp_address='john@example.com',config=config,autodiscover=False,access_type=DELEGATE)# 'exchangelib' will attempt to guess the server version and authentication method. If you# have a really bizarre or locked-down installation and the guessing fails, or you want to avoid# the extra network traffic, you can set the auth method and version explicitly instead:version=Version(build=Build(15,0,12,34))config=Configuration(server='example.com',credentials=credentials,version=version,auth_type=NTLM)# By default, we fail on all exceptions from the server. If you want to enable fault# tolerance, add a retry policy to your configuration. We will then retry on certain# transient errors. By default, we back off exponentially and retry for up to an hour.# This is configurable:config=Configuration(retry_policy=FaultTolerance(max_wait=3600),credentials=credentials)account=Account(primary_smtp_address='john@example.com',config=config)# Kerberos and SSPI authentication are supported via the 'gssapi' and 'sspi' auth types.config=Configuration(server='example.com',auth_type=GSSAPI)config=Configuration(server='example.com',auth_type=SSPI)# If you're connecting to the same account very often, you can cache the autodiscover result for# later so you can skip the autodiscover lookup:ews_url=account.protocol.service_endpointews_auth_type=account.protocol.auth_typeprimary_smtp_address=account.primary_smtp_address# You can now create the Account without autodiscovering, using the cached values:config=Configuration(service_endpoint=ews_url,credentials=credentials,auth_type=ews_auth_type)account=Account(primary_smtp_address=primary_smtp_address,config=config,autodiscover=False,access_type=DELEGATE,)# Autodiscover can take a lot of time, specially the part that figures out the autodiscover # server to contact for a specific email domain. For this reason, we will create a persistent, # per-user, on-disk cache containing a map of previous, successful domain -> autodiscover server# lookups. This cache is shared between processes and is not deleted when your program exits.# A cache entry for a domain is removed automatically if autodiscovery fails for an email in that# domain. It's possible to clear the entire cache completely if you want:fromexchangelib.autodiscoverimport_autodiscover_cache_autodiscover_cache.clear()

代理和自定义TLS验证

如果需要代理支持或自定义TLS验证，可以提供 自定义"请求"传输适配器类，如中所述 http://docs.python requests.org/en/master/user/advanced/传输适配器

下面是一个使用不同自定义根证书的示例，具体取决于 要连接到的服务器：

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

这是一个n添加代理支持的示例：

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

exchangelib提供忽略tls验证的示例适配器 错误。自担风险使用。

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

文件夹

所有已知文件夹都可用作帐户的属性，例如account.root，account.calendar， account.trash，account.inbox，account.outbox，account.sent，account.junk，account.tasks和 帐户.联系人

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

日期、日期时间和时区

EWS对日期时间和时区有一些特殊要求。你需要 要使用特殊的类 处理日期时。

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

创建、更新、删除、发送和移动

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

批量操作

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

搜索

搜索是根据django queryset api建模的，并且 支持API。就像在Django，Queryset很懒 在迭代queryset之前获取任何内容。QuerySets支持 链接，以便您可以在多个步骤中构建最终查询，并且 可以对多个子搜索重复使用基本查询集。查询集 返回一个迭代器，当QuerySet完全 第一次迭代。

下面是一些使用api的示例：

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

分页

寻呼EWS服务（例如finditem和）的默认页面大小为100。你可以 如果需要，请全局更改此值：

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

如果您使用的是非常小或非常大的项目，这可能不合理 价值。例如，如果要检索和保存带有大型附件的电子邮件， 您可以根据每个查询集更改此值：

fromexchangelibimportCredentials,Accountcredentials=Credentials('john@example.com','topsecret')account=Account('john@example.com',credentials=credentials,autodiscover=True)foriteminaccount.inbox.all().order_by('-datetime_received')[:100]:print(item.subject,item.sender,item.datetime_received)

最后，在account类中定义的bulk方法有一个可选的块大小 参数，可用于在获取、创建、更新时设置非默认页大小。 或删除项目。

pip install exchangelib

会议

日历项类允许您发送会议请求 您发起或取消以前已开始的会议。它 也可以处理接收到的会议请求消息。 您可以使用acceptitem回复这些消息， tentivelyacceptitem和declineitem类。如果你收到 取消您的会议（classmeeting cancellation） 已经接受，然后您也可以通过删除条目来处理这些 从日历中。

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib

pip install exchangelib[kerberos]
pip install exchangelib[sspi]

pip install exchangelib[kerberos]
pip install exchangelib[sspi]

pip install exchangelib[kerberos]
pip install exchangelib[sspi]

pip install exchangelib[kerberos]
pip install exchangelib[sspi]