Coverage for src/backend/InvenTree/plugin/base/mail/mixins.py: 69%

1"""Plugin mixin class for mails.""" 

2 

3from django.core.mail import EmailMessage 

4 

5from plugin import PluginMixinEnum 

6from plugin.helpers import MixinNotImplementedError 

7 

8 

9class MailMixin: 

10 """Mixin that provides support for processing mails before/after going to the sending/receiving commands. 

11 

12 Implementing classes must provide a "process_mail_out" and "process_mail_in" function: 

13 """ 

14 

15 def process_mail_out(self, mail: EmailMessage, *args, **kwargs) -> None: 

16 """Function to handle a mail that is going to be send. 

17 

18 Must be overridden by plugin. 

19 """ 

20 # Default implementation does not do anything 

21 raise MixinNotImplementedError 

22 

23 def process_mail_in(self, mail: EmailMessage, *args, **kwargs) -> None: 

24 """Function to handle a mail that was received. 

25 

26 Must be overridden by plugin. 

27 """ 

28 # Default implementation does not do anything 

29 raise MixinNotImplementedError 

30 

31 class MixinMeta: 

32 """Meta options for this mixin.""" 

33 

34 MIXIN_NAME = 'Mail' 

35 

36 def __init__(self): 

37 """Register the mixin.""" 

38 super().__init__() 

39 self.add_mixin(PluginMixinEnum.MAIL, True, __class__)