1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
from typing import Any, Generator, Optional, Union
from ..errors import ErrorInvalidOperation
from ..properties import CreateRuleOperation, DeleteRuleOperation, InboxRules, Operations, Rule, SetRuleOperation
from ..util import MNS, add_xml_child, create_element, get_xml_attr, set_xml_value
from .common import EWSAccountService
class GetInboxRules(EWSAccountService):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/getinboxrules-operation
The GetInboxRules operation uses Exchange Web Services to retrieve Inbox rules in the identified user's mailbox.
"""
SERVICE_NAME = "GetInboxRules"
element_container_name = InboxRules.response_tag()
ERRORS_TO_CATCH_IN_RESPONSE = EWSAccountService.ERRORS_TO_CATCH_IN_RESPONSE + (ErrorInvalidOperation,)
def call(self, mailbox: Optional[str] = None) -> Generator[Union[Rule, Exception, None], Any, None]:
if not mailbox:
mailbox = self.account.primary_smtp_address
payload = self.get_payload(mailbox=mailbox)
elements = self._get_elements(payload=payload)
return self._elems_to_objs(elements)
def _elem_to_obj(self, elem):
return Rule.from_xml(elem=elem, account=self.account)
def get_payload(self, mailbox):
payload = create_element(f"m:{self.SERVICE_NAME}")
add_xml_child(payload, "m:MailboxSmtpAddress", mailbox)
return payload
def _get_element_container(self, message, name=None):
if name:
response_class = message.get("ResponseClass")
response_code = get_xml_attr(message, f"{{{MNS}}}ResponseCode")
if response_class == "Success" and response_code == "NoError" and message.find(name) is None:
return []
return super()._get_element_container(message, name)
class UpdateInboxRules(EWSAccountService):
"""
MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateinboxrules-operation
The UpdateInboxRules operation updates the authenticated user's Inbox rules by applying the specified operations.
UpdateInboxRules is used to create an Inbox rule, to set an Inbox rule, or to delete an Inbox rule.
When you use the UpdateInboxRules operation, Exchange Web Services deletes client-side send rules.
Client-side send rules are stored on the client in the rule Folder Associated Information (FAI) Message and nowhere
else. EWS deletes this rule FAI message by default, based on the expectation that Outlook will recreate it.
However, Outlook can't recreate rules that don't also exist as an extended rule, and client-side send rules don't
exist as extended rules. As a result, these rules are lost. We suggest you consider this when designing your
solution.
"""
SERVICE_NAME = "UpdateInboxRules"
ERRORS_TO_CATCH_IN_RESPONSE = EWSAccountService.ERRORS_TO_CATCH_IN_RESPONSE + (ErrorInvalidOperation,)
def call(self, rule: Rule, remove_outlook_rule_blob: bool = True):
payload = self.get_payload(rule=rule, remove_outlook_rule_blob=remove_outlook_rule_blob)
return self._get_elements(payload=payload)
def _get_operation(self, rule):
raise NotImplementedError()
def get_payload(self, rule: Rule, remove_outlook_rule_blob: bool = True):
payload = create_element(f"m:{self.SERVICE_NAME}")
add_xml_child(payload, "m:RemoveOutlookRuleBlob", remove_outlook_rule_blob)
operations = self._get_operation(rule)
set_xml_value(payload, operations, version=self.account.version)
return payload
class CreateInboxRule(UpdateInboxRules):
"""
MSDN:
https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateinboxrules-operation#updateinboxrules-create-rule-request-example
"""
def _get_operation(self, rule):
return Operations(create_rule_operation=CreateRuleOperation(rule=rule))
class SetInboxRule(UpdateInboxRules):
"""
MSDN:
https://learn.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateinboxrules-operation#updateinboxrules-set-rule-request-example
"""
def _get_operation(self, rule):
return Operations(set_rule_operation=SetRuleOperation(rule=rule))
class DeleteInboxRule(UpdateInboxRules):
"""
MSDN:
https://learn.microsoft.com/en-us/exchange/client-developer/web-service-reference/updateinboxrules-operation#updateinboxrules-delete-rule-request-example
"""
def _get_operation(self, rule):
return Operations(delete_rule_operation=DeleteRuleOperation(id=rule.id))
|
