29b41a7638
Add support to the mailing profiles for specifying a "from" address. Closes GitLab issue #522. This commit adds a new backend class property "class_fields" which differs from the normal "fields" property. The "class_fields" property specifies which of the backend fields will be used to initialize a backend's driver class. This is to avoid passing fields that the driver doesn't expect and getting an error. When sending emails, the "send" method will attempt to get a "from" key from the backend data and use that when sending emails. If no "from" key is found a None is passes. Django's behavior in this situation dictates that the "from" value will then be taken from the DEFAULT_FROM_EMAIL setting. Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
123 lines
4.4 KiB
Python
123 lines
4.4 KiB
Python
from __future__ import unicode_literals
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from .classes import MailerBackend
|
|
|
|
__all__ = ('DjangoFileBased', 'DjangoSMTP')
|
|
|
|
|
|
class DjangoSMTP(MailerBackend):
|
|
"""
|
|
Backend that wraps Django's SMTP backend
|
|
"""
|
|
class_fields = (
|
|
'host', 'port', 'use_tls', 'use_ssl', 'user', 'password'
|
|
)
|
|
class_path = 'django.core.mail.backends.smtp.EmailBackend'
|
|
field_order = (
|
|
'host', 'port', 'use_tls', 'use_ssl', 'user', 'password', 'from'
|
|
)
|
|
fields = {
|
|
'from': {
|
|
'label': _('From'),
|
|
'class': 'django.forms.CharField', 'default': '',
|
|
'help_text': _(
|
|
'The sender\'s address. Some system will refuse to send '
|
|
'messages if this value is not set.'
|
|
), 'kwargs': {
|
|
'max_length': 48
|
|
}, 'required': False
|
|
}, 'host': {
|
|
'label': _('Host'),
|
|
'class': 'django.forms.CharField', 'default': 'localhost',
|
|
'help_text': _('The host to use for sending email.'),
|
|
'kwargs': {
|
|
'max_length': 48
|
|
}, 'required': False
|
|
}, 'port': {
|
|
'label': _('Port'),
|
|
'class': 'django.forms.IntegerField', 'default': 25,
|
|
'help_text': _('Port to use for the SMTP server.'),
|
|
'required': False
|
|
}, 'use_tls': {
|
|
'label': _('Use TLS'),
|
|
'class': 'django.forms.BooleanField', 'default': False,
|
|
'help_text': _(
|
|
'Whether to use a TLS (secure) connection when talking to '
|
|
'the SMTP server. This is used for explicit TLS connections, '
|
|
'generally on port 587.'
|
|
), 'required': False
|
|
}, 'use_ssl': {
|
|
'label': _('Use SSL'),
|
|
'class': 'django.forms.BooleanField', 'default': False,
|
|
'help_text': _(
|
|
'Whether to use an implicit TLS (secure) connection when '
|
|
'talking to the SMTP server. In most email documentation '
|
|
'this type of TLS connection is referred to as SSL. It is '
|
|
'generally used on port 465. If you are experiencing '
|
|
'problems, see the explicit TLS setting "Use TLS". Note '
|
|
'that "Use TLS" and "Use SSL" are mutually exclusive, '
|
|
'so only set one of those settings to True.'
|
|
), 'required': False
|
|
}, 'user': {
|
|
'label': _('Username'),
|
|
'class': 'django.forms.CharField', 'default': '',
|
|
'help_text': _(
|
|
'Username to use for the SMTP server. If empty, '
|
|
'authentication won\'t attempted.'
|
|
), 'kwargs': {
|
|
'max_length': 48
|
|
}, 'required': False
|
|
}, 'password': {
|
|
'label': _('Password'),
|
|
'class': 'django.forms.CharField', 'default': '',
|
|
'help_text': _(
|
|
'Password to use for the SMTP server. This setting is used '
|
|
'in conjunction with the username when authenticating to '
|
|
'the SMTP server. If either of these settings is empty, '
|
|
'authentication won\'t be attempted.'
|
|
), 'kwargs': {
|
|
'max_length': 48
|
|
}, 'required': False
|
|
},
|
|
}
|
|
label = _('Django SMTP backend')
|
|
widgets = {
|
|
'password': {
|
|
'class': 'django.forms.widgets.PasswordInput',
|
|
'kwargs': {
|
|
'render_value': True
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
class DjangoFileBased(MailerBackend):
|
|
"""
|
|
Mailing backend that wraps Django's file based email backend
|
|
"""
|
|
class_fields = ('file_path',)
|
|
class_path = 'django.core.mail.backends.filebased.EmailBackend'
|
|
field_order = (
|
|
'file_path', 'from'
|
|
)
|
|
fields = {
|
|
'file_path': {
|
|
'label': _('File path'),
|
|
'class': 'django.forms.CharField', 'kwargs': {
|
|
'max_length': 48
|
|
}
|
|
}, 'from': {
|
|
'label': _('From'),
|
|
'class': 'django.forms.CharField', 'default': '',
|
|
'help_text': _(
|
|
'The sender\'s address. Some system will refuse to send '
|
|
'messages if this value is not set.'
|
|
), 'kwargs': {
|
|
'max_length': 48
|
|
}, 'required': False
|
|
}
|
|
}
|
|
label = _('Django file based backend')
|