API reference

Python method documentation

maildown.utilities

get_client

get_client() -> <function client at 0x10632d158>

Returns an authenticated boto3.ses client

verify_address

verify_address(email: str) -> bool

Asks Amazon to send an email to a given email address to verify the user’s ownership of that address.

Email addresses must be verified by Amazon before you can send emails from them with SES

Parameters:

verify_auth

verify_auth(access_key: str, secret_key: str, region_name: str = 'us-east-1') -> bool

Checks that the given credentials are valid by performing a simple call on the SES API

Parameters:

get_config

get_config() -> dict

Returns the existing configuration from the local environment

write_config

write_config(**config: Dict[str, Union[str, SupportsFloat, bool]]) -> None

Updates the existing local config with the given additional arguments

Parameters:

login

login(access_key: Union[str, NoneType] = None, secret_key: Union[str, NoneType] = None, region_name: str = 'us-east-1', aws_config_file: str = '/Users/christopherdavies/.aws/credentials') -> None

Checks your AWS credentials are valid, and stores them locally if so for future re use.

If you provide the access key/secret key arguments directly to this function, then these credentials will be taken in the first instance.

If these arguments are NOT supplied, then this method will first check to see if the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environmental variables have been set.

If not, this method will attempt to read the file kept at aws_config_file, which is the default location of the Amazon CLI config file.

If this method cannot find credentials via any one of these methods, or if the credentials it does find are invalid, then an Exception is raised.

However, if valid credentials can be found, these are stored locally

Parameters:

send_message

send_message(sender: str, subject: str, to: list, content: Union[str, NoneType] = None, file_path: Union[str, NoneType] = None, context: Union[dict, NoneType] = None, theme=None)

Sends an email to a given list of recipients

Parameters: