Version Emailer¶
-
class
version_emailer.HTMLEmail¶ Bases:
object-
static
Send(templateFilePath: str, commits: list) → error_code.ErrorCode¶ Send an HTML email of the given commits in the style of the given template file. Use the email settings (subject, to, from) from the config.json.
Parameters: - templateFilePath (str) – The path to the email template file.
- commits (list) – The list of commits to list in the email.
Returns: An ErrorCode object telling what the outcome of calling the function was.
-
static
-
class
version_emailer.TextEmail¶ Bases:
object-
static
Send(templateFilePath: str, commits: list) → error_code.ErrorCode¶ Send a text email of the given commits in the style of the given template file. Use the email settings (subject, to, from) from the config.json.
Parameters: - templateFilePath (str) – The path to the email template file.
- commits (list) – The list of commits to list in the email.
Returns: An ErrorCode object telling what the outcome of calling the function was.
-
static
-
version_emailer.HandleCommand(argv: list, argc: int) → error_code.ErrorCode¶ Handle a command given to this module
Parameters: - argv (list) – The given arguments.
- argc (int) – The count of given arguments
Returns: An ErrorCode object telling what the outcome of calling the function was.