Skip to content

PR – Support Multiple Attachments on Mailer #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 2, 2025
Merged

PR – Support Multiple Attachments on Mailer #4

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
474704a
Mailer Update for multiples attachments __init__.py
Darkfoxjj12 Apr 18, 2025
a60545c
Improve PR #4 by allowing empty filename lists to be populated
deajan Apr 23, 2025
765555c
ofunctions: Make linter happy
deajan Apr 23, 2025
a49b2c2
Reformat file with black
deajan Apr 23, 2025
cb47a31
mailer: Refactor attachment filename handling
deajan May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 57 additions & 34 deletions ofunctions/mailer/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
__copyright__ = "Copyright (C) 2014-2025 Orsiris de Jong"
__description__ = "Mail sending class that handles encryption, authentication, bulk and split mail sending"
__licence__ = "BSD 3 Clause"
__version__ = "1.2.2"
__build__ = "2025040401"
__version__ = "1.3.0"
__build__ = "2025050201"
__compat__ = "python2.7+"

import logging
Expand Down Expand Up @@ -65,7 +65,7 @@ class ConnectionResetError(ConnectionError):
pass


logger = logging.getLogger(__intname__)
logger = logging.getLogger()


class Mailer:
Expand Down Expand Up @@ -124,8 +124,8 @@ def send_email(
recipient_mails=None, # type: Union[str, List[str]]
subject=None, # type: str
body=None, # type: str
attachment=None, # type: str
filename=None, # type: str
attachment=None, # type: Optional[Union[str, bytes, List[str], List[bytes]]]
filename=None, # type: Optional[Union[str, List[str]]]
html_enabled=False, # type: bool
bcc_mails=None, # type: str
priority=False, # type: bool
Expand All @@ -144,12 +144,13 @@ def send_email(

def _send_email(
recipient_mail, # type: Union[str,List[str]]
attachment=None, # type: Optional[Union[str, bytes, List[str], List[bytes]]]
filename=None, # type: Optional[Union[str, List[str]]]
):
# type: (...) -> bool
"""
Actual mail sending function
"""

# Create a multipart message and set headers
message = MIMEMultipart()
message["From"] = sender_mail
Expand Down Expand Up @@ -177,33 +178,55 @@ def _send_email(
else:
message.attach(MIMEText(body, "plain", self.encoding))

default_attachment_name = "attachment"
attachments = []
filenames = []

if attachment is not None:
att_filename = filename
if isinstance(attachment, bytes):
# Let's suppose we directly attach binary data
payload = attachment
if isinstance(attachment, list):
attachments = attachment
if isinstance(filename, list):
if len(attachments) != len(filename):
raise ValueError(
"Mismatch between attachments and filenames list sizes"
)
filenames = filename
else:
with open(attachment, "rb") as f_attachment:
payload = f_attachment.read()
attachments = [attachment]

if not filenames:
for index in range(0, len(attachments)):
if isinstance(attachment[index], (bytes, bytearray)):
filenames.append(
"{}_{}".format(index, default_attachment_name)
)
elif isinstance(attachment[index], str):
filenames.append(os.path.basename(attachment[index]))
else:
filenames.append(
"{}.{}".format(index, default_attachment_name)
)

for attachment, filename in zip(attachments, filenames):
if isinstance(attachment, (bytes, bytearray)):
payload = attachment
if not filename:
att_filename = os.path.basename(attachment)

# Add file as application/octet-stream
# Email client can usually download this automatically as attachment
part = MIMEBase("application", "octet-stream")
part.set_payload(payload)

# Encode file in ASCII characters to send by email
encoders.encode_base64(part)

# Add header as key/value pair to attachment part
part.add_header(
"Content-Disposition",
"attachment; filename=%s" % att_filename,
)

# Add attachment to message and convert message to string
message.attach(part)
filename = default_attachment_name
filename = filename if filename else default_attachment_name
else:
with open(attachment, "rb") as f_attachment:
payload = f_attachment.read()
filename = (
filename if filename else os.path.basename(attachment)
)

part = MIMEBase("application", "octet-stream")
part.set_payload(payload)
encoders.encode_base64(part)
part.add_header(
"Content-Disposition", "attachment; filename=%s" % filename
)
message.attach(part)

text = message.as_string()

Expand Down Expand Up @@ -270,11 +293,11 @@ def _send_email(

if split_mails:
for recipient in rfc822_addresses:
_result = _send_email(recipient)
_result = _send_email(recipient, attachment, filename)
if not _result:
result = _result
else:
_result = _send_email(rfc822_addresses)
_result = _send_email(rfc822_addresses, attachment, filename)
if not _result:
result = _result

Expand Down Expand Up @@ -308,8 +331,8 @@ def send_email(
security=None, # type: Optional[str]
subject=None, # type: str
body=None, # type: str
attachment=None, # type: str
filename=None, # type: str
attachment=None, # type: Optional[Union[str, bytes, List[str], List[bytes]]]
filename=None, # type: Optional[Union[str, List[str]]]
html_enabled=False, # type: bool
bcc_mails=None, # type: str
priority=False, # type: bool
Expand Down
Loading