autograder.api.courses.admin.email

Send an email to course users.

View Source

 1"""
 2Send an email to course users.
 3"""
 4
 5import typing
 6
 7import autograder.api.common
 8import autograder.api.config
 9import autograder.model.config
10
11API_ENDPOINT: str = 'courses/admin/email'
12API_WRITE: bool = True
13API_PARAMS: typing.List[autograder.api.config.APIParam] = [
14    autograder.api.config.PARAM_SERVER,
15    autograder.api.config.PARAM_USER_EMAIL,
16    autograder.api.config.PARAM_USER_PASS,
17
18    autograder.api.config.PARAM_COURSE,
19    autograder.api.config.PARAM_DRY_RUN,
20
21    autograder.api.config.PARAM_EMAIL_COURSE_TO,
22    autograder.api.config.PARAM_EMAIL_COURSE_CC,
23    autograder.api.config.PARAM_EMAIL_COURSE_BCC,
24    autograder.api.config.PARAM_EMAIL_SUBJECT,
25    autograder.api.config.PARAM_EMAIL_BODY,
26    autograder.api.config.PARAM_EMAIL_HTML,
27]
28
29def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
30    """ Send a request to the autograder. """
31
32    return autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)

API_ENDPOINT: str = 'courses/admin/email'

API_WRITE: bool = True

def send(config: autograder.model.config.Config, **kwargs: Any) -> Dict[str, Any]: View Source

30def send(config: autograder.model.config.Config, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
31    """ Send a request to the autograder. """
32
33    return autograder.api.common.make_api_request(API_ENDPOINT, config, API_PARAMS, write = API_WRITE, **kwargs)

Send a request to the autograder.