src.report_generation.SendEmail Namespace Reference

Functions
	send_report (receiver_email_address, link, month)
	send_unmatched_report (receiver_email_address, month, link, lines, files)
	send_statement_report (receiver_email_address, month, csv_link, pdf_link)
	send_email (receiver_email_address, email_subject, text)

Constants
	t = BodyEmail

Function Documentation

send_email()

src.report_generation.SendEmail.send_email	(		receiver_email_address,
			email_subject,
			text )

Sends the download link via email to client 

Args:
    receiver_email_address (str): client_email
    email_subject (str): receiver email
    text (str): body email
Returns: response (str)

Definition at line 54 of file SendEmail.py.

Here is the caller graph for this function:

send_report()

src.report_generation.SendEmail.send_report	(		receiver_email_address,
			link,
			month )

Build the header and body email for monthly report

Args:
    receiver_email_address (str): client_email
    link (str): download link
    month (str): month and year when sales were processed
Returns: Nothing

Definition at line 10 of file SendEmail.py.

Here is the call graph for this function:

send_statement_report()

src.report_generation.SendEmail.send_statement_report	(		receiver_email_address,
			month,
			csv_link,
			pdf_link )

Builds the body for statements email. The format used is html

Args:
    period (str): month and year when sales were processed
    csv_link (str): presigned link to download csv statement
    pdf_link (str): presigned link to download pdf statement
Returns: Nothing

Definition at line 40 of file SendEmail.py.

Here is the call graph for this function:

send_unmatched_report()

src.report_generation.SendEmail.send_unmatched_report	(		receiver_email_address,
			month,
			link,
			lines,
			files )

Build the header and body email for unmatched report

Args:
    receiver_email_address (str): client_email
    link (str): download link
    month (str): month and year when sales were processed
    lines (int): total lines which don't match with catalogue
    files (int): files which have lines not matched
Returns: Nothing

Definition at line 24 of file SendEmail.py.

Here is the call graph for this function:

Constant Documentation

t

src.report_generation.SendEmail.t = BodyEmail

Definition at line 9 of file SendEmail.py.