mailtrap-python/examples/sandbox/sandboxes.py at main · mailtrap/mailtrap-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
import os
from typing import Optional

import mailtrap as mt
from mailtrap.models.sandboxes import Sandbox

API_KEY = os.environ["MAILTRAP_API_KEY"]
ACCOUNT_ID = os.environ["MAILTRAP_ACCOUNT_ID"]

client = mt.MailtrapClient(token=API_KEY, account_id=ACCOUNT_ID)
sandboxes_api = client.sandbox_api.sandboxes


def list_sandboxes() -> list[Sandbox]:
    return sandboxes_api.get_list()


def create_sandbox(project_id: int, sandbox_name: str) -> Sandbox:
    return sandboxes_api.create(
        project_id=project_id, sandbox_params=mt.CreateSandboxParams(name=sandbox_name)
    )


def get_sandbox_by_id(sandbox_id: int) -> Sandbox:
    return sandboxes_api.get_by_id(sandbox_id)


def update_sandbox(
    sandbox_id: int,
    new_name: Optional[str] = None,
    new_email_username: Optional[str] = None,
) -> Sandbox:
    return sandboxes_api.update(
        sandbox_id,
        mt.UpdateSandboxParams(name=new_name, email_username=new_email_username),
    )


def clean_sandbox(sandbox_id: int) -> Sandbox:
    return sandboxes_api.clean(sandbox_id)


def mark_sandbox_as_read(sandbox_id: int) -> Sandbox:
    return sandboxes_api.mark_as_read(sandbox_id)


def reset_sandbox_credentials(sandbox_id: int) -> Sandbox:
    return sandboxes_api.reset_credentials(sandbox_id)


def enable_sandbox_email_address(sandbox_id: int) -> Sandbox:
    return sandboxes_api.enable_email_address(sandbox_id)


def reset_sandbox_email_username(sandbox_id: int) -> Sandbox:
    return sandboxes_api.reset_email_username(sandbox_id)


def delete_sandbox(sandbox_id: int):
    return sandboxes_api.delete(sandbox_id)


if __name__ == "__main__":
    sandboxes = list_sandboxes()
    print(sandboxes)

    projects = client.sandbox_api.projects.get_list()
    if not projects:
        raise SystemExit("Create a project before running this example.")
    created = create_sandbox(
        project_id=projects[0].id, sandbox_name="example-created-sandbox"
    )
    print(created)

    sandbox_id = created.id
    sandbox = get_sandbox_by_id(sandbox_id=sandbox_id)
    print(sandbox)

    updated = update_sandbox(sandbox_id=sandbox_id, new_name=f"{sandbox.name}-updated")
    print(updated)

    cleaned = clean_sandbox(sandbox_id=sandbox_id)
    print(cleaned)

    marked = mark_sandbox_as_read(sandbox_id=sandbox_id)
    print(marked)

    reset_creds = reset_sandbox_credentials(sandbox_id=sandbox_id)
    print(reset_creds)

    enabled = enable_sandbox_email_address(sandbox_id=sandbox_id)
    print(enabled)

    reset_username = reset_sandbox_email_username(sandbox_id=sandbox_id)
    print(reset_username)

    deleted = delete_sandbox(sandbox_id=sandbox_id)
    print(deleted)