webscout 8.3.7__py3-none-any.whl → 2025.10.11__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of webscout might be problematic. Click here for more details.

Files changed (273) hide show
  1. webscout/AIauto.py +250 -250
  2. webscout/AIbase.py +379 -379
  3. webscout/AIutel.py +60 -60
  4. webscout/Bard.py +1012 -1012
  5. webscout/Bing_search.py +417 -417
  6. webscout/DWEBS.py +529 -529
  7. webscout/Extra/Act.md +309 -309
  8. webscout/Extra/GitToolkit/__init__.py +10 -10
  9. webscout/Extra/GitToolkit/gitapi/README.md +110 -110
  10. webscout/Extra/GitToolkit/gitapi/__init__.py +11 -11
  11. webscout/Extra/GitToolkit/gitapi/repository.py +195 -195
  12. webscout/Extra/GitToolkit/gitapi/user.py +96 -96
  13. webscout/Extra/GitToolkit/gitapi/utils.py +61 -61
  14. webscout/Extra/YTToolkit/README.md +375 -375
  15. webscout/Extra/YTToolkit/YTdownloader.py +956 -956
  16. webscout/Extra/YTToolkit/__init__.py +2 -2
  17. webscout/Extra/YTToolkit/transcriber.py +475 -475
  18. webscout/Extra/YTToolkit/ytapi/README.md +44 -44
  19. webscout/Extra/YTToolkit/ytapi/__init__.py +6 -6
  20. webscout/Extra/YTToolkit/ytapi/channel.py +307 -307
  21. webscout/Extra/YTToolkit/ytapi/errors.py +13 -13
  22. webscout/Extra/YTToolkit/ytapi/extras.py +118 -118
  23. webscout/Extra/YTToolkit/ytapi/https.py +88 -88
  24. webscout/Extra/YTToolkit/ytapi/patterns.py +61 -61
  25. webscout/Extra/YTToolkit/ytapi/playlist.py +58 -58
  26. webscout/Extra/YTToolkit/ytapi/pool.py +7 -7
  27. webscout/Extra/YTToolkit/ytapi/query.py +39 -39
  28. webscout/Extra/YTToolkit/ytapi/stream.py +62 -62
  29. webscout/Extra/YTToolkit/ytapi/utils.py +62 -62
  30. webscout/Extra/YTToolkit/ytapi/video.py +232 -232
  31. webscout/Extra/autocoder/__init__.py +9 -9
  32. webscout/Extra/autocoder/autocoder.py +1105 -1105
  33. webscout/Extra/autocoder/autocoder_utiles.py +332 -332
  34. webscout/Extra/gguf.md +429 -429
  35. webscout/Extra/gguf.py +1213 -1213
  36. webscout/Extra/tempmail/README.md +487 -487
  37. webscout/Extra/tempmail/__init__.py +27 -27
  38. webscout/Extra/tempmail/async_utils.py +140 -140
  39. webscout/Extra/tempmail/base.py +160 -160
  40. webscout/Extra/tempmail/cli.py +186 -186
  41. webscout/Extra/tempmail/emailnator.py +84 -84
  42. webscout/Extra/tempmail/mail_tm.py +360 -360
  43. webscout/Extra/tempmail/temp_mail_io.py +291 -291
  44. webscout/Extra/weather.md +281 -281
  45. webscout/Extra/weather.py +193 -193
  46. webscout/Litlogger/README.md +10 -10
  47. webscout/Litlogger/__init__.py +15 -15
  48. webscout/Litlogger/formats.py +13 -13
  49. webscout/Litlogger/handlers.py +121 -121
  50. webscout/Litlogger/levels.py +13 -13
  51. webscout/Litlogger/logger.py +134 -134
  52. webscout/Provider/AISEARCH/Perplexity.py +332 -332
  53. webscout/Provider/AISEARCH/README.md +279 -279
  54. webscout/Provider/AISEARCH/__init__.py +16 -1
  55. webscout/Provider/AISEARCH/felo_search.py +206 -206
  56. webscout/Provider/AISEARCH/genspark_search.py +323 -323
  57. webscout/Provider/AISEARCH/hika_search.py +185 -185
  58. webscout/Provider/AISEARCH/iask_search.py +410 -410
  59. webscout/Provider/AISEARCH/monica_search.py +219 -219
  60. webscout/Provider/AISEARCH/scira_search.py +316 -316
  61. webscout/Provider/AISEARCH/stellar_search.py +177 -177
  62. webscout/Provider/AISEARCH/webpilotai_search.py +255 -255
  63. webscout/Provider/Aitopia.py +314 -314
  64. webscout/Provider/Apriel.py +306 -0
  65. webscout/Provider/ChatGPTClone.py +236 -236
  66. webscout/Provider/ChatSandbox.py +343 -343
  67. webscout/Provider/Cloudflare.py +324 -324
  68. webscout/Provider/Cohere.py +208 -208
  69. webscout/Provider/Deepinfra.py +370 -366
  70. webscout/Provider/ExaAI.py +260 -260
  71. webscout/Provider/ExaChat.py +308 -308
  72. webscout/Provider/Flowith.py +221 -221
  73. webscout/Provider/GMI.py +293 -0
  74. webscout/Provider/Gemini.py +164 -164
  75. webscout/Provider/GeminiProxy.py +167 -167
  76. webscout/Provider/GithubChat.py +371 -372
  77. webscout/Provider/Groq.py +800 -800
  78. webscout/Provider/HeckAI.py +383 -383
  79. webscout/Provider/Jadve.py +282 -282
  80. webscout/Provider/K2Think.py +307 -307
  81. webscout/Provider/Koboldai.py +205 -205
  82. webscout/Provider/LambdaChat.py +423 -423
  83. webscout/Provider/Nemotron.py +244 -244
  84. webscout/Provider/Netwrck.py +248 -248
  85. webscout/Provider/OLLAMA.py +395 -395
  86. webscout/Provider/OPENAI/Cloudflare.py +393 -393
  87. webscout/Provider/OPENAI/FalconH1.py +451 -451
  88. webscout/Provider/OPENAI/FreeGemini.py +296 -296
  89. webscout/Provider/OPENAI/K2Think.py +431 -431
  90. webscout/Provider/OPENAI/NEMOTRON.py +240 -240
  91. webscout/Provider/OPENAI/PI.py +427 -427
  92. webscout/Provider/OPENAI/README.md +959 -959
  93. webscout/Provider/OPENAI/TogetherAI.py +345 -345
  94. webscout/Provider/OPENAI/TwoAI.py +465 -465
  95. webscout/Provider/OPENAI/__init__.py +33 -18
  96. webscout/Provider/OPENAI/base.py +248 -248
  97. webscout/Provider/OPENAI/chatglm.py +528 -0
  98. webscout/Provider/OPENAI/chatgpt.py +592 -592
  99. webscout/Provider/OPENAI/chatgptclone.py +521 -521
  100. webscout/Provider/OPENAI/chatsandbox.py +202 -202
  101. webscout/Provider/OPENAI/deepinfra.py +318 -314
  102. webscout/Provider/OPENAI/e2b.py +1665 -1665
  103. webscout/Provider/OPENAI/exaai.py +420 -420
  104. webscout/Provider/OPENAI/exachat.py +452 -452
  105. webscout/Provider/OPENAI/friendli.py +232 -232
  106. webscout/Provider/OPENAI/{refact.py → gmi.py} +324 -274
  107. webscout/Provider/OPENAI/groq.py +364 -364
  108. webscout/Provider/OPENAI/heckai.py +314 -314
  109. webscout/Provider/OPENAI/llmchatco.py +337 -337
  110. webscout/Provider/OPENAI/netwrck.py +355 -355
  111. webscout/Provider/OPENAI/oivscode.py +290 -290
  112. webscout/Provider/OPENAI/opkfc.py +518 -518
  113. webscout/Provider/OPENAI/pydantic_imports.py +1 -1
  114. webscout/Provider/OPENAI/scirachat.py +535 -535
  115. webscout/Provider/OPENAI/sonus.py +308 -308
  116. webscout/Provider/OPENAI/standardinput.py +442 -442
  117. webscout/Provider/OPENAI/textpollinations.py +340 -340
  118. webscout/Provider/OPENAI/toolbaz.py +419 -416
  119. webscout/Provider/OPENAI/typefully.py +362 -362
  120. webscout/Provider/OPENAI/utils.py +295 -295
  121. webscout/Provider/OPENAI/venice.py +436 -436
  122. webscout/Provider/OPENAI/wisecat.py +387 -387
  123. webscout/Provider/OPENAI/writecream.py +166 -166
  124. webscout/Provider/OPENAI/x0gpt.py +378 -378
  125. webscout/Provider/OPENAI/yep.py +389 -389
  126. webscout/Provider/OpenGPT.py +230 -230
  127. webscout/Provider/Openai.py +243 -243
  128. webscout/Provider/PI.py +405 -405
  129. webscout/Provider/Perplexitylabs.py +430 -430
  130. webscout/Provider/QwenLM.py +272 -272
  131. webscout/Provider/STT/__init__.py +16 -1
  132. webscout/Provider/Sambanova.py +257 -257
  133. webscout/Provider/StandardInput.py +309 -309
  134. webscout/Provider/TTI/README.md +82 -82
  135. webscout/Provider/TTI/__init__.py +33 -18
  136. webscout/Provider/TTI/aiarta.py +413 -413
  137. webscout/Provider/TTI/base.py +136 -136
  138. webscout/Provider/TTI/bing.py +243 -243
  139. webscout/Provider/TTI/gpt1image.py +149 -149
  140. webscout/Provider/TTI/imagen.py +196 -196
  141. webscout/Provider/TTI/infip.py +211 -211
  142. webscout/Provider/TTI/magicstudio.py +232 -232
  143. webscout/Provider/TTI/monochat.py +219 -219
  144. webscout/Provider/TTI/piclumen.py +214 -214
  145. webscout/Provider/TTI/pixelmuse.py +232 -232
  146. webscout/Provider/TTI/pollinations.py +232 -232
  147. webscout/Provider/TTI/together.py +288 -288
  148. webscout/Provider/TTI/utils.py +12 -12
  149. webscout/Provider/TTI/venice.py +367 -367
  150. webscout/Provider/TTS/README.md +192 -192
  151. webscout/Provider/TTS/__init__.py +33 -18
  152. webscout/Provider/TTS/parler.py +110 -110
  153. webscout/Provider/TTS/streamElements.py +333 -333
  154. webscout/Provider/TTS/utils.py +280 -280
  155. webscout/Provider/TeachAnything.py +237 -237
  156. webscout/Provider/TextPollinationsAI.py +310 -310
  157. webscout/Provider/TogetherAI.py +356 -356
  158. webscout/Provider/TwoAI.py +312 -312
  159. webscout/Provider/TypliAI.py +311 -311
  160. webscout/Provider/UNFINISHED/ChatHub.py +208 -208
  161. webscout/Provider/UNFINISHED/ChutesAI.py +313 -313
  162. webscout/Provider/UNFINISHED/GizAI.py +294 -294
  163. webscout/Provider/UNFINISHED/Marcus.py +198 -198
  164. webscout/Provider/UNFINISHED/Qodo.py +477 -477
  165. webscout/Provider/UNFINISHED/VercelAIGateway.py +338 -338
  166. webscout/Provider/UNFINISHED/XenAI.py +324 -324
  167. webscout/Provider/UNFINISHED/Youchat.py +330 -330
  168. webscout/Provider/UNFINISHED/liner.py +334 -0
  169. webscout/Provider/UNFINISHED/liner_api_request.py +262 -262
  170. webscout/Provider/UNFINISHED/puterjs.py +634 -634
  171. webscout/Provider/UNFINISHED/samurai.py +223 -223
  172. webscout/Provider/UNFINISHED/test_lmarena.py +119 -119
  173. webscout/Provider/Venice.py +250 -250
  174. webscout/Provider/VercelAI.py +256 -256
  175. webscout/Provider/WiseCat.py +231 -231
  176. webscout/Provider/WrDoChat.py +366 -366
  177. webscout/Provider/__init__.py +33 -18
  178. webscout/Provider/ai4chat.py +174 -174
  179. webscout/Provider/akashgpt.py +331 -331
  180. webscout/Provider/cerebras.py +446 -446
  181. webscout/Provider/chatglm.py +394 -301
  182. webscout/Provider/cleeai.py +211 -211
  183. webscout/Provider/elmo.py +282 -282
  184. webscout/Provider/geminiapi.py +208 -208
  185. webscout/Provider/granite.py +261 -261
  186. webscout/Provider/hermes.py +263 -263
  187. webscout/Provider/julius.py +223 -223
  188. webscout/Provider/learnfastai.py +309 -309
  189. webscout/Provider/llama3mitril.py +214 -214
  190. webscout/Provider/llmchat.py +243 -243
  191. webscout/Provider/llmchatco.py +290 -290
  192. webscout/Provider/meta.py +801 -801
  193. webscout/Provider/oivscode.py +309 -309
  194. webscout/Provider/scira_chat.py +383 -383
  195. webscout/Provider/searchchat.py +292 -292
  196. webscout/Provider/sonus.py +258 -258
  197. webscout/Provider/toolbaz.py +370 -367
  198. webscout/Provider/turboseek.py +273 -273
  199. webscout/Provider/typefully.py +207 -207
  200. webscout/Provider/yep.py +372 -372
  201. webscout/__init__.py +30 -31
  202. webscout/__main__.py +5 -5
  203. webscout/auth/api_key_manager.py +189 -189
  204. webscout/auth/config.py +175 -175
  205. webscout/auth/models.py +185 -185
  206. webscout/auth/routes.py +664 -664
  207. webscout/auth/simple_logger.py +236 -236
  208. webscout/cli.py +523 -523
  209. webscout/conversation.py +438 -438
  210. webscout/exceptions.py +361 -361
  211. webscout/litagent/Readme.md +298 -298
  212. webscout/litagent/__init__.py +28 -28
  213. webscout/litagent/agent.py +581 -581
  214. webscout/litagent/constants.py +59 -59
  215. webscout/litprinter/__init__.py +58 -58
  216. webscout/models.py +181 -181
  217. webscout/optimizers.py +419 -419
  218. webscout/prompt_manager.py +288 -288
  219. webscout/sanitize.py +1078 -1078
  220. webscout/scout/README.md +401 -401
  221. webscout/scout/__init__.py +8 -8
  222. webscout/scout/core/__init__.py +6 -6
  223. webscout/scout/core/crawler.py +297 -297
  224. webscout/scout/core/scout.py +706 -706
  225. webscout/scout/core/search_result.py +95 -95
  226. webscout/scout/core/text_analyzer.py +62 -62
  227. webscout/scout/core/text_utils.py +277 -277
  228. webscout/scout/core/web_analyzer.py +51 -51
  229. webscout/scout/element.py +599 -599
  230. webscout/scout/parsers/__init__.py +69 -69
  231. webscout/scout/parsers/html5lib_parser.py +172 -172
  232. webscout/scout/parsers/html_parser.py +236 -236
  233. webscout/scout/parsers/lxml_parser.py +178 -178
  234. webscout/scout/utils.py +37 -37
  235. webscout/swiftcli/Readme.md +323 -323
  236. webscout/swiftcli/__init__.py +95 -95
  237. webscout/swiftcli/core/__init__.py +7 -7
  238. webscout/swiftcli/core/cli.py +308 -308
  239. webscout/swiftcli/core/context.py +104 -104
  240. webscout/swiftcli/core/group.py +241 -241
  241. webscout/swiftcli/decorators/__init__.py +28 -28
  242. webscout/swiftcli/decorators/command.py +221 -221
  243. webscout/swiftcli/decorators/options.py +220 -220
  244. webscout/swiftcli/decorators/output.py +302 -302
  245. webscout/swiftcli/exceptions.py +21 -21
  246. webscout/swiftcli/plugins/__init__.py +9 -9
  247. webscout/swiftcli/plugins/base.py +135 -135
  248. webscout/swiftcli/plugins/manager.py +269 -269
  249. webscout/swiftcli/utils/__init__.py +59 -59
  250. webscout/swiftcli/utils/formatting.py +252 -252
  251. webscout/swiftcli/utils/parsing.py +267 -267
  252. webscout/update_checker.py +117 -117
  253. webscout/version.py +1 -1
  254. webscout/webscout_search.py +1183 -1183
  255. webscout/webscout_search_async.py +649 -649
  256. webscout/yep_search.py +346 -346
  257. webscout/zeroart/README.md +89 -89
  258. webscout/zeroart/__init__.py +134 -134
  259. webscout/zeroart/base.py +66 -66
  260. webscout/zeroart/effects.py +100 -100
  261. webscout/zeroart/fonts.py +1238 -1238
  262. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/METADATA +937 -937
  263. webscout-2025.10.11.dist-info/RECORD +300 -0
  264. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  265. webscout/Provider/OPENAI/Qwen3.py +0 -303
  266. webscout/Provider/OPENAI/qodo.py +0 -630
  267. webscout/Provider/OPENAI/xenai.py +0 -514
  268. webscout/tempid.py +0 -134
  269. webscout-8.3.7.dist-info/RECORD +0 -301
  270. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/WHEEL +0 -0
  271. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/entry_points.txt +0 -0
  272. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/licenses/LICENSE.md +0 -0
  273. {webscout-8.3.7.dist-info → webscout-2025.10.11.dist-info}/top_level.txt +0 -0
@@ -1,488 +1,488 @@
1
- <div align="center">
2
- <a href="https://github.com/OEvortex/Webscout">
3
- <img src="https://img.shields.io/badge/WebScout-TempMail%20Module-blue?style=for-the-badge&logo=mail&logoColor=white" alt="WebScout TempMail">
4
- </a>
5
-
6
- <h1>📧 TempMail</h1>
7
-
8
- <p><strong>Powerful Temporary Email Generation & Management</strong></p>
9
-
10
- <p>
11
- Create disposable email addresses, manage messages, and automate email verification workflows with multiple providers and both synchronous and asynchronous APIs.
12
- </p>
13
-
14
- <!-- Badges -->
15
- <p>
16
- <a href="https://pypi.org/project/webscout/"><img src="https://img.shields.io/pypi/v/webscout.svg?style=flat-square&logo=pypi&label=PyPI" alt="PyPI Version"></a>
17
- <a href="#"><img src="https://img.shields.io/badge/No%20API%20Key-Required-success?style=flat-square" alt="No API Key Required"></a>
18
- <a href="#"><img src="https://img.shields.io/badge/Python-3.7%2B-blue?style=flat-square&logo=python" alt="Python Version"></a>
19
- </p>
20
- </div>
21
-
22
- > [!NOTE]
23
- > TempMail provides disposable email addresses for testing, verification, and privacy protection. It supports multiple providers and offers both synchronous and asynchronous interfaces.
24
-
25
- ## ✨ Key Features
26
-
27
- ### Email Management
28
-
29
- * **Multiple Provider Support**
30
- * Native integration with Mail.TM and TempMail.io services
31
- * Extensible architecture for adding new providers
32
- * Consistent interface across all providers
33
-
34
- * **Privacy Protection**
35
- * Generate disposable email addresses on demand
36
- * Protect your primary inbox from spam
37
- * Automatic cleanup after use
38
-
39
- ### Developer Experience
40
-
41
- * **Dual API Support**
42
- * Synchronous interface for simple scripts
43
- * Asynchronous interface for high-performance applications
44
- * Complete feature parity between both interfaces
45
-
46
- * **Automation Tools**
47
- * Helper utilities for common workflows
48
- * Email verification automation
49
- * Message waiting and processing
50
-
51
- * **Command Line Interface**
52
- * Direct terminal access to all features
53
- * Real-time message monitoring
54
- * Simple and detailed output modes
55
-
56
- ## 🚀 Installation
57
-
58
- Install or update Webscout to get access to the TempMail module:
59
-
60
- ```bash
61
- pip install -U webscout
62
- ```
63
-
64
- ## 🖥️ Usage
65
-
66
- ### Basic Synchronous Example
67
-
68
- ```python
69
- from webscout.Extra.tempmail import get_random_email
70
-
71
- # 1. Create a new temporary email (provider chosen automatically)
72
- email, provider = get_random_email()
73
- print(f"[*] Your temporary email: {email}")
74
- print(f"[*] Provider: {type(provider).__name__}")
75
-
76
- try:
77
- # 2. Check for incoming messages
78
- print("[*] Waiting for messages...")
79
- # Add a small delay or implement a loop if checking immediately
80
- import time
81
- time.sleep(10)
82
-
83
- messages = provider.get_messages()
84
- if not messages:
85
- print("[*] No messages received yet.")
86
- else:
87
- print(f"[*] Received {len(messages)} message(s):")
88
- for i, message in enumerate(messages):
89
- print(f"\n--- Message {i+1} ---")
90
- print(f" From: {message.get('from', 'N/A')}")
91
- print(f" Subject: {message.get('subject', 'N/A')}")
92
- # Optionally print body, be mindful of length
93
- # print(f" Body: {message.get('body', 'N/A')[:100]}...")
94
-
95
- finally:
96
- # 3. Clean up: Delete the account/email when done
97
- print("[*] Deleting temporary email account...")
98
- provider.delete_account() # Adjust based on provider (delete_account or delete_email)
99
- print("[*] Account deleted.")
100
-
101
- ```
102
-
103
- ### Choosing a Specific Provider
104
-
105
- ```python
106
- from webscout.Extra.tempmail import get_provider
107
-
108
- # Use Mail.TM (default if unspecified in get_random_email)
109
- print("[*] Using Mail.TM Provider")
110
- mailtm_provider = get_provider("mailtm")
111
- # MailTM typically uses create_account() which generates email+token
112
- account_info = mailtm_provider.create_account()
113
- print(f"[*] Mail.TM Email: {account_info['address']}")
114
- # ... use mailtm_provider.get_messages(), etc. ...
115
- mailtm_provider.delete_account(account_info['id'], account_info['token']) # Requires ID and Token for deletion
116
- print("[*] Mail.TM account deleted.")
117
-
118
-
119
- # Use TempMail.io
120
- print("\n[*] Using TempMail.io Provider")
121
- tempmailio_provider = get_provider("tempmailio")
122
- # TempMail.io might have a different creation flow (check implementation)
123
- # Assuming it also uses create_account() that returns an email address
124
- email_info = tempmailio_provider.create_account() # Adapt if method/return differs
125
- temp_email_io_addr = email_info # Adjust based on actual return value
126
- print(f"[*] TempMail.io Email: {temp_email_io_addr}")
127
- # ... use tempmailio_provider.get_messages(), etc. ...
128
- tempmailio_provider.delete_account() # Adapt if deletion needs specific info
129
- print("[*] TempMail.io account deleted.")
130
- ```
131
-
132
- ### Asynchronous API Example
133
-
134
- ```python
135
- import asyncio
136
- from webscout.Extra.tempmail import get_provider
137
-
138
- async def manage_temp_email_async():
139
- # 1. Get an async provider instance (e.g., Mail.TM)
140
- provider = get_provider("mailtm", async_provider=True)
141
- await provider.initialize() # Important for async providers
142
- print("[*] Async Provider Initialized (Mail.TM)")
143
-
144
- try:
145
- # 2. Create a new email (async method)
146
- # Note: Method might be create_email or create_account depending on provider
147
- email_data = await provider.create_email() # Adjust if method/return differs
148
- email = email_data['address'] # Adjust based on actual return keys
149
- token = email_data.get('token') # Get token if applicable
150
- email_id = email_data.get('id') # Get ID if applicable
151
- print(f"[*] Your temporary email: {email}")
152
-
153
- # 3. Check for messages (async method)
154
- print("[*] Waiting for messages (async)...")
155
- await asyncio.sleep(15) # Wait a bit for potential incoming mail
156
-
157
- messages = await provider.get_messages()
158
- if not messages:
159
- print("[*] No messages received yet.")
160
- else:
161
- print(f"[*] Received {len(messages)} message(s):")
162
- for i, message in enumerate(messages):
163
- print(f"\n--- Message {i+1} ---")
164
- print(f" From: {message.get('from', 'N/A')}")
165
- print(f" Subject: {message.get('subject', 'N/A')}")
166
-
167
- finally:
168
- # 4. Clean up (async methods)
169
- print("[*] Deleting temporary email (async)...")
170
- # Deletion method and required arguments depend on the provider
171
- if token and email_id:
172
- await provider.delete_email(email_id, token) # Example for MailTM-like
173
- elif hasattr(provider, 'delete_email') and not token and not email_id:
174
- await provider.delete_email(email) # Example if only email needed
175
- else:
176
- print("[!] Could not determine deletion method/parameters. Manual cleanup might be needed.")
177
-
178
- await provider.close() # Close the underlying HTTP client
179
- print("[*] Provider closed.")
180
-
181
- # Run the async function
182
- if __name__ == "__main__":
183
- asyncio.run(manage_temp_email_async())
184
- ```
185
-
186
- ### Command Line Interface (CLI)
187
-
188
- Access temporary email features directly from your terminal:
189
-
190
- ```bash
191
- python -m webscout.Extra.tempmail.cli --help
192
- ```
193
-
194
- **Example: Get a temp email and watch for messages:**
195
-
196
- ```bash
197
- # This will generate an email and check for new messages every 15 seconds
198
- python -m webscout.Extra.tempmail.cli --wait 15
199
- ```
200
-
201
- **CLI Options:**
202
-
203
- * `--provider {mailtm,tempmailio}`: Specify the provider to use (default: mailtm).
204
- * `--wait SECONDS`: Wait time in seconds between checking for new messages (default: 10). Set to 0 to check once and exit.
205
- * `--output {simple,detailed}`: Control the level of detail in the output (default: simple). `detailed` usually shows message bodies.
206
-
207
- ## 📚 API Reference
208
-
209
- The module is built around abstract base classes for providers, ensuring a consistent interface.
210
-
211
- ### Base Abstract Classes
212
-
213
- * `TempMailProvider`: Defines the interface for synchronous temporary email providers.
214
- * `AsyncTempMailProvider`: Defines the interface for asynchronous temporary email providers.
215
-
216
- ### Provider Implementations
217
-
218
- #### Mail.TM
219
-
220
- * **`MailTM`**: Synchronous client for the Mail.TM service.
221
- * **`MailTMAsync`**: Asynchronous client for the Mail.TM service.
222
-
223
- #### TempMail.io
224
-
225
- * **`TempMailIO`**: Synchronous client for the TempMail.io service.
226
- * **`TempMailIOAsync`**: Asynchronous client for the TempMail.io service.
227
-
228
- ### Factory Functions
229
-
230
- * **`get_provider(provider_name: str, async_provider: bool = False) -> Union[TempMailProvider, AsyncTempMailProvider]`**:
231
- Retrieves an initialized provider instance based on its name (`'mailtm'` or `'tempmailio'`) and whether an async version is needed.
232
- * **`get_random_email(provider_name: Optional[str] = None) -> Tuple[str, TempMailProvider]`**:
233
- Generates a random email address using either the specified provider or a randomly selected one. Returns the email address and the synchronous provider instance.
234
- * **`get_disposable_email()`**: An alias for `get_random_email()`.
235
-
236
- ### Asynchronous Utilities (`webscout.Extra.tempmail.async_utils`)
237
-
238
- * **`AsyncTempMailHelper`**: A helper class simplifying common asynchronous operations like email creation and message waiting.
239
- * **`get_temp_email(alias: Optional[str] = None, domain: Optional[str] = None) -> Tuple[str, AsyncTempMailHelper]`**:
240
- Asynchronously creates a temporary email using the helper. Returns the email address and the helper instance.
241
- * **`wait_for_message(helper: AsyncTempMailHelper, timeout: int = 60, check_interval: int = 5) -> Optional[dict]`**:
242
- Asynchronously waits for a message to arrive for the email managed by the `helper`. Returns the message dictionary or `None` if timeout occurs.
243
-
244
- ## Advanced Usage Examples
245
-
246
- ### Automated Email Verification Workflow (Async)
247
-
248
- ```python
249
- import asyncio
250
- from webscout.Extra.tempmail import get_provider
251
- # Assume extract_link_from_message is defined elsewhere
252
- # from your_parsing_utils import extract_link_from_message
253
-
254
- async def verify_email_signup(service_url, username):
255
- """
256
- Attempts to sign up for a service using a temp email and
257
- retrieve the verification link.
258
- """
259
- provider = get_provider("mailtm", async_provider=True)
260
- await provider.initialize()
261
- print(f"[*] Initialized async provider for {service_url} signup")
262
-
263
- email_data = None
264
- verification_link = None
265
-
266
- try:
267
- email_data = await provider.create_email()
268
- email = email_data['address']
269
- print(f"[*] Generated temp email: {email} for {username}")
270
-
271
- # --- Placeholder for your signup logic ---
272
- print(f"[*] Attempting signup on {service_url} with {email}...")
273
- # success = await sign_up_to_service(service_url, username, email)
274
- success = True # Assume signup initiates email sending
275
- if not success:
276
- print("[!] Service signup failed.")
277
- return None
278
- # -----------------------------------------
279
-
280
- print("[*] Waiting for verification email...")
281
- # Wait up to 2 minutes (12 checks * 10 seconds interval)
282
- for attempt in range(12):
283
- print(f"[*] Checking for messages (Attempt {attempt + 1}/12)...")
284
- messages = await provider.get_messages()
285
-
286
- # Simple check: look for "verify" or "confirm" in subject
287
- verification_msg = next((
288
- m for m in messages
289
- if "verify" in m.get('subject', '').lower() or \
290
- "confirm" in m.get('subject', '').lower()
291
- ), None)
292
-
293
- if verification_msg:
294
- print("[+] Verification email found!")
295
- print(f" Subject: {verification_msg.get('subject')}")
296
- # --- Placeholder for link extraction ---
297
- # verification_link = extract_link_from_message(verification_msg.get('body', ''))
298
- verification_link = f"http://example.com/verify?token=xyz..." # Dummy link
299
- # -------------------------------------
300
- if verification_link:
301
- print(f"[+] Extracted verification link: {verification_link}")
302
- break # Exit loop once link is found
303
- else:
304
- print("[!] Found email, but failed to extract link.")
305
-
306
- await asyncio.sleep(10) # Wait before next check
307
-
308
- if not verification_link:
309
- print("[!] Timed out waiting for verification email or link.")
310
-
311
- except Exception as e:
312
- print(f"[!] An error occurred: {e}")
313
- finally:
314
- # Clean up regardless of success/failure
315
- if email_data:
316
- print("[*] Cleaning up temporary email...")
317
- try:
318
- # Adjust deletion based on provider needs (ID, token, etc.)
319
- await provider.delete_email(email_data['id'], email_data['token'])
320
- print("[*] Temporary email deleted.")
321
- except Exception as del_e:
322
- print(f"[!] Error during email deletion: {del_e}")
323
-
324
- await provider.close()
325
- print("[*] Async provider closed.")
326
-
327
- return verification_link
328
-
329
- # Example call (replace with actual service interaction)
330
- # asyncio.run(verify_email_signup("https://some-service.com/signup", "testuser123"))
331
- ```
332
-
333
- ### Testing Email Functionality (Sync)
334
-
335
- ```python
336
- from webscout.Extra.tempmail import get_random_email
337
- import time
338
- # Assume send_test_email is a function you have defined
339
- # from your_email_sending_module import send_test_email
340
-
341
- def test_email_sending_feature():
342
- """Tests if an email sent to a temp address is received."""
343
- print("[*] Starting email sending test...")
344
- email, provider = get_random_email()
345
- print(f"[*] Generated temp email for receiving: {email}")
346
-
347
- test_subject = "My Test Email Subject"
348
- test_content = "This is the body of the test email."
349
- test_email_received = False
350
-
351
- try:
352
- # --- Placeholder for your email sending logic ---
353
- print(f"[*] Sending test email to {email}...")
354
- # success = send_test_email(email, test_subject, test_content)
355
- success = True # Assume sending works
356
- if not success:
357
- print("[!] Failed to send test email.")
358
- return False
359
- # ---------------------------------------------
360
-
361
- print("[*] Waiting a few seconds for email delivery...")
362
- time.sleep(15) # Allow time for email to arrive
363
-
364
- print("[*] Checking inbox...")
365
- messages = provider.get_messages()
366
-
367
- if not messages:
368
- print("[!] No messages received in the temporary inbox.")
369
- else:
370
- print(f"[*] Received {len(messages)} message(s). Checking for test email...")
371
- for msg in messages:
372
- if msg.get('subject') == test_subject:
373
- print(f"[+] Test email received successfully!")
374
- print(f" From: {msg.get('from')}")
375
- # Optional: Verify content
376
- # if test_content in msg.get('body', ''):
377
- # print("[+] Email content verified.")
378
- test_email_received = True
379
- break # Found the email
380
- if not test_email_received:
381
- print(f"[!] Test email with subject '{test_subject}' not found.")
382
-
383
- except Exception as e:
384
- print(f"[!] An error occurred during the test: {e}")
385
- finally:
386
- # Clean up the temporary email account
387
- print("[*] Deleting temporary email account...")
388
- try:
389
- provider.delete_account() # Adjust if deletion needs specific info
390
- print("[*] Account deleted.")
391
- except Exception as del_e:
392
- print(f"[!] Error deleting account: {del_e}")
393
-
394
- print(f"[*] Email sending test result: {'Success' if test_email_received else 'Failure'}")
395
- return test_email_received
396
-
397
- # Run the test
398
- # test_result = test_email_sending_feature()
399
- ```
400
-
401
- ### Using Async Helper Utilities
402
-
403
- ```python
404
- import asyncio
405
- from webscout.Extra.tempmail.async_utils import get_temp_email, wait_for_message
406
-
407
- async def use_async_helpers():
408
- email = None
409
- helper = None
410
- print("[*] Using async helper utilities...")
411
- try:
412
- # 1. Create a new email using the helper
413
- email, helper = await get_temp_email()
414
- print(f"[*] Temporary email created via helper: {email}")
415
-
416
- # 2. Wait for a message to arrive (timeout after 60 seconds)
417
- print("[*] Waiting for a message (up to 60s)...")
418
- # Simulate sending an email here if needed for testing
419
- # await send_email_to(email, "Helper Test", "Body content")
420
-
421
- message = await wait_for_message(helper, timeout=60, check_interval=5)
422
-
423
- if message:
424
- print("[+] Message received!")
425
- print(f" From: {message.get('from', 'N/A')}")
426
- print(f" Subject: {message.get('subject', 'N/A')}")
427
- # print(f"Body: {message.get('body', 'N/A')[:100]}...") # Optional: print body snippet
428
- else:
429
- print("[!] No messages received within the 60-second timeout period.")
430
-
431
- except Exception as e:
432
- print(f"[!] An error occurred: {e}")
433
- finally:
434
- # 3. Clean up using the helper's delete method
435
- if helper:
436
- print("[*] Cleaning up email via helper...")
437
- await helper.delete()
438
- print("[*] Email deleted by helper.")
439
- else:
440
- print("[!] Helper instance not available for cleanup.")
441
-
442
- # Run the async function
443
- if __name__ == "__main__":
444
- asyncio.run(use_async_helpers())
445
- ```
446
-
447
- ## 🔌 Provider Integration
448
-
449
- Adding support for a new temporary email service is straightforward thanks to the abstract provider pattern used throughout Webscout:
450
-
451
- 1. **Create Provider Classes**: Implement two new classes:
452
- * One inheriting from `webscout.Extra.tempmail.base.TempMailProvider` for synchronous operations.
453
- * One inheriting from `webscout.Extra.tempmail.base.AsyncTempMailProvider` for asynchronous operations.
454
- Implement all the abstract methods defined in the base classes (e.g., `create_account`/`create_email`, `get_messages`, `delete_account`/`delete_email`).
455
- 2. **Register in Factory**: Update the `get_provider` function in `webscout/Extra/tempmail/base.py` to recognize a new `provider_name` string and return instances of your newly created classes.
456
- 3. **Expose (Optional)**: If desired, update `webscout/Extra/tempmail/__init__.py` to directly import and expose your new provider classes for users who might want to instantiate them directly.
457
- 4. **Add Tests**: Create unit and integration tests for your new provider to ensure it functions correctly.
458
- 5. **Update Documentation**: Add your new provider to this README, including any specific usage notes.
459
-
460
- ## 🛠️ Implementation Details
461
-
462
- * **Parser**: Uses the `Scout` HTML/XML parser from the core `webscout` library instead of external libraries like `BeautifulSoup` for consistency and potentially better performance within the Webscout ecosystem.
463
- * **Sync/Async Parity**: Aims to provide feature parity between the synchronous (`TempMailProvider`) and asynchronous (`AsyncTempMailProvider`) interfaces for all supported providers.
464
- * **Factories**: Relies on factory functions (`get_provider`, `get_random_email`) for easy and consistent instantiation of provider objects.
465
- * **Minimal Dependencies**: Avoids adding external logging or unnecessary dependencies to ensure smooth integration into projects using Webscout.
466
-
467
- ## 🤝 Contributing
468
-
469
- Contributions to enhance the TempMail module are highly welcome! Potential areas include:
470
-
471
- 1. **Adding New Providers**: Integrating support for additional temporary email services.
472
- 2. **Improving CLI**: Enhancing the command-line interface with more features or better output formatting.
473
- 3. **Robustness**: Improving error handling, retries, and provider-specific edge cases.
474
- 4. **Utility Functions**: Adding more helper functions for common temporary email automation tasks.
475
- 5. **Documentation**: Refining examples, API descriptions, and usage guides.
476
-
477
- Please refer to the main Webscout project's contributing guidelines if you plan to submit a pull request.
478
-
479
- <div align="center">
480
- <!-- Footer Links (Mirrored from main README) -->
481
- <div>
482
- <a href="https://t.me/PyscoutAI"><img alt="Telegram Group" src="https://img.shields.io/badge/Telegram%20Group-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
483
- <a href="https://t.me/ANONYMOUS_56788"><img alt="Developer Telegram" src="https://img.shields.io/badge/Developer%20Contact-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
484
- <a href="https://buymeacoffee.com/oevortex"><img alt="Buy Me A Coffee" src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black"></a>
485
- </div>
486
- <p>📧 TempMail - Part of the Webscout Toolkit</p>
487
- <a href="https://github.com/OEvortex/Webscout">Back to Main Webscout Project</a>
1
+ <div align="center">
2
+ <a href="https://github.com/OEvortex/Webscout">
3
+ <img src="https://img.shields.io/badge/WebScout-TempMail%20Module-blue?style=for-the-badge&logo=mail&logoColor=white" alt="WebScout TempMail">
4
+ </a>
5
+
6
+ <h1>📧 TempMail</h1>
7
+
8
+ <p><strong>Powerful Temporary Email Generation & Management</strong></p>
9
+
10
+ <p>
11
+ Create disposable email addresses, manage messages, and automate email verification workflows with multiple providers and both synchronous and asynchronous APIs.
12
+ </p>
13
+
14
+ <!-- Badges -->
15
+ <p>
16
+ <a href="https://pypi.org/project/webscout/"><img src="https://img.shields.io/pypi/v/webscout.svg?style=flat-square&logo=pypi&label=PyPI" alt="PyPI Version"></a>
17
+ <a href="#"><img src="https://img.shields.io/badge/No%20API%20Key-Required-success?style=flat-square" alt="No API Key Required"></a>
18
+ <a href="#"><img src="https://img.shields.io/badge/Python-3.7%2B-blue?style=flat-square&logo=python" alt="Python Version"></a>
19
+ </p>
20
+ </div>
21
+
22
+ > [!NOTE]
23
+ > TempMail provides disposable email addresses for testing, verification, and privacy protection. It supports multiple providers and offers both synchronous and asynchronous interfaces.
24
+
25
+ ## ✨ Key Features
26
+
27
+ ### Email Management
28
+
29
+ * **Multiple Provider Support**
30
+ * Native integration with Mail.TM and TempMail.io services
31
+ * Extensible architecture for adding new providers
32
+ * Consistent interface across all providers
33
+
34
+ * **Privacy Protection**
35
+ * Generate disposable email addresses on demand
36
+ * Protect your primary inbox from spam
37
+ * Automatic cleanup after use
38
+
39
+ ### Developer Experience
40
+
41
+ * **Dual API Support**
42
+ * Synchronous interface for simple scripts
43
+ * Asynchronous interface for high-performance applications
44
+ * Complete feature parity between both interfaces
45
+
46
+ * **Automation Tools**
47
+ * Helper utilities for common workflows
48
+ * Email verification automation
49
+ * Message waiting and processing
50
+
51
+ * **Command Line Interface**
52
+ * Direct terminal access to all features
53
+ * Real-time message monitoring
54
+ * Simple and detailed output modes
55
+
56
+ ## 🚀 Installation
57
+
58
+ Install or update Webscout to get access to the TempMail module:
59
+
60
+ ```bash
61
+ pip install -U webscout
62
+ ```
63
+
64
+ ## 🖥️ Usage
65
+
66
+ ### Basic Synchronous Example
67
+
68
+ ```python
69
+ from webscout.Extra.tempmail import get_random_email
70
+
71
+ # 1. Create a new temporary email (provider chosen automatically)
72
+ email, provider = get_random_email()
73
+ print(f"[*] Your temporary email: {email}")
74
+ print(f"[*] Provider: {type(provider).__name__}")
75
+
76
+ try:
77
+ # 2. Check for incoming messages
78
+ print("[*] Waiting for messages...")
79
+ # Add a small delay or implement a loop if checking immediately
80
+ import time
81
+ time.sleep(10)
82
+
83
+ messages = provider.get_messages()
84
+ if not messages:
85
+ print("[*] No messages received yet.")
86
+ else:
87
+ print(f"[*] Received {len(messages)} message(s):")
88
+ for i, message in enumerate(messages):
89
+ print(f"\n--- Message {i+1} ---")
90
+ print(f" From: {message.get('from', 'N/A')}")
91
+ print(f" Subject: {message.get('subject', 'N/A')}")
92
+ # Optionally print body, be mindful of length
93
+ # print(f" Body: {message.get('body', 'N/A')[:100]}...")
94
+
95
+ finally:
96
+ # 3. Clean up: Delete the account/email when done
97
+ print("[*] Deleting temporary email account...")
98
+ provider.delete_account() # Adjust based on provider (delete_account or delete_email)
99
+ print("[*] Account deleted.")
100
+
101
+ ```
102
+
103
+ ### Choosing a Specific Provider
104
+
105
+ ```python
106
+ from webscout.Extra.tempmail import get_provider
107
+
108
+ # Use Mail.TM (default if unspecified in get_random_email)
109
+ print("[*] Using Mail.TM Provider")
110
+ mailtm_provider = get_provider("mailtm")
111
+ # MailTM typically uses create_account() which generates email+token
112
+ account_info = mailtm_provider.create_account()
113
+ print(f"[*] Mail.TM Email: {account_info['address']}")
114
+ # ... use mailtm_provider.get_messages(), etc. ...
115
+ mailtm_provider.delete_account(account_info['id'], account_info['token']) # Requires ID and Token for deletion
116
+ print("[*] Mail.TM account deleted.")
117
+
118
+
119
+ # Use TempMail.io
120
+ print("\n[*] Using TempMail.io Provider")
121
+ tempmailio_provider = get_provider("tempmailio")
122
+ # TempMail.io might have a different creation flow (check implementation)
123
+ # Assuming it also uses create_account() that returns an email address
124
+ email_info = tempmailio_provider.create_account() # Adapt if method/return differs
125
+ temp_email_io_addr = email_info # Adjust based on actual return value
126
+ print(f"[*] TempMail.io Email: {temp_email_io_addr}")
127
+ # ... use tempmailio_provider.get_messages(), etc. ...
128
+ tempmailio_provider.delete_account() # Adapt if deletion needs specific info
129
+ print("[*] TempMail.io account deleted.")
130
+ ```
131
+
132
+ ### Asynchronous API Example
133
+
134
+ ```python
135
+ import asyncio
136
+ from webscout.Extra.tempmail import get_provider
137
+
138
+ async def manage_temp_email_async():
139
+ # 1. Get an async provider instance (e.g., Mail.TM)
140
+ provider = get_provider("mailtm", async_provider=True)
141
+ await provider.initialize() # Important for async providers
142
+ print("[*] Async Provider Initialized (Mail.TM)")
143
+
144
+ try:
145
+ # 2. Create a new email (async method)
146
+ # Note: Method might be create_email or create_account depending on provider
147
+ email_data = await provider.create_email() # Adjust if method/return differs
148
+ email = email_data['address'] # Adjust based on actual return keys
149
+ token = email_data.get('token') # Get token if applicable
150
+ email_id = email_data.get('id') # Get ID if applicable
151
+ print(f"[*] Your temporary email: {email}")
152
+
153
+ # 3. Check for messages (async method)
154
+ print("[*] Waiting for messages (async)...")
155
+ await asyncio.sleep(15) # Wait a bit for potential incoming mail
156
+
157
+ messages = await provider.get_messages()
158
+ if not messages:
159
+ print("[*] No messages received yet.")
160
+ else:
161
+ print(f"[*] Received {len(messages)} message(s):")
162
+ for i, message in enumerate(messages):
163
+ print(f"\n--- Message {i+1} ---")
164
+ print(f" From: {message.get('from', 'N/A')}")
165
+ print(f" Subject: {message.get('subject', 'N/A')}")
166
+
167
+ finally:
168
+ # 4. Clean up (async methods)
169
+ print("[*] Deleting temporary email (async)...")
170
+ # Deletion method and required arguments depend on the provider
171
+ if token and email_id:
172
+ await provider.delete_email(email_id, token) # Example for MailTM-like
173
+ elif hasattr(provider, 'delete_email') and not token and not email_id:
174
+ await provider.delete_email(email) # Example if only email needed
175
+ else:
176
+ print("[!] Could not determine deletion method/parameters. Manual cleanup might be needed.")
177
+
178
+ await provider.close() # Close the underlying HTTP client
179
+ print("[*] Provider closed.")
180
+
181
+ # Run the async function
182
+ if __name__ == "__main__":
183
+ asyncio.run(manage_temp_email_async())
184
+ ```
185
+
186
+ ### Command Line Interface (CLI)
187
+
188
+ Access temporary email features directly from your terminal:
189
+
190
+ ```bash
191
+ python -m webscout.Extra.tempmail.cli --help
192
+ ```
193
+
194
+ **Example: Get a temp email and watch for messages:**
195
+
196
+ ```bash
197
+ # This will generate an email and check for new messages every 15 seconds
198
+ python -m webscout.Extra.tempmail.cli --wait 15
199
+ ```
200
+
201
+ **CLI Options:**
202
+
203
+ * `--provider {mailtm,tempmailio}`: Specify the provider to use (default: mailtm).
204
+ * `--wait SECONDS`: Wait time in seconds between checking for new messages (default: 10). Set to 0 to check once and exit.
205
+ * `--output {simple,detailed}`: Control the level of detail in the output (default: simple). `detailed` usually shows message bodies.
206
+
207
+ ## 📚 API Reference
208
+
209
+ The module is built around abstract base classes for providers, ensuring a consistent interface.
210
+
211
+ ### Base Abstract Classes
212
+
213
+ * `TempMailProvider`: Defines the interface for synchronous temporary email providers.
214
+ * `AsyncTempMailProvider`: Defines the interface for asynchronous temporary email providers.
215
+
216
+ ### Provider Implementations
217
+
218
+ #### Mail.TM
219
+
220
+ * **`MailTM`**: Synchronous client for the Mail.TM service.
221
+ * **`MailTMAsync`**: Asynchronous client for the Mail.TM service.
222
+
223
+ #### TempMail.io
224
+
225
+ * **`TempMailIO`**: Synchronous client for the TempMail.io service.
226
+ * **`TempMailIOAsync`**: Asynchronous client for the TempMail.io service.
227
+
228
+ ### Factory Functions
229
+
230
+ * **`get_provider(provider_name: str, async_provider: bool = False) -> Union[TempMailProvider, AsyncTempMailProvider]`**:
231
+ Retrieves an initialized provider instance based on its name (`'mailtm'` or `'tempmailio'`) and whether an async version is needed.
232
+ * **`get_random_email(provider_name: Optional[str] = None) -> Tuple[str, TempMailProvider]`**:
233
+ Generates a random email address using either the specified provider or a randomly selected one. Returns the email address and the synchronous provider instance.
234
+ * **`get_disposable_email()`**: An alias for `get_random_email()`.
235
+
236
+ ### Asynchronous Utilities (`webscout.Extra.tempmail.async_utils`)
237
+
238
+ * **`AsyncTempMailHelper`**: A helper class simplifying common asynchronous operations like email creation and message waiting.
239
+ * **`get_temp_email(alias: Optional[str] = None, domain: Optional[str] = None) -> Tuple[str, AsyncTempMailHelper]`**:
240
+ Asynchronously creates a temporary email using the helper. Returns the email address and the helper instance.
241
+ * **`wait_for_message(helper: AsyncTempMailHelper, timeout: int = 60, check_interval: int = 5) -> Optional[dict]`**:
242
+ Asynchronously waits for a message to arrive for the email managed by the `helper`. Returns the message dictionary or `None` if timeout occurs.
243
+
244
+ ## Advanced Usage Examples
245
+
246
+ ### Automated Email Verification Workflow (Async)
247
+
248
+ ```python
249
+ import asyncio
250
+ from webscout.Extra.tempmail import get_provider
251
+ # Assume extract_link_from_message is defined elsewhere
252
+ # from your_parsing_utils import extract_link_from_message
253
+
254
+ async def verify_email_signup(service_url, username):
255
+ """
256
+ Attempts to sign up for a service using a temp email and
257
+ retrieve the verification link.
258
+ """
259
+ provider = get_provider("mailtm", async_provider=True)
260
+ await provider.initialize()
261
+ print(f"[*] Initialized async provider for {service_url} signup")
262
+
263
+ email_data = None
264
+ verification_link = None
265
+
266
+ try:
267
+ email_data = await provider.create_email()
268
+ email = email_data['address']
269
+ print(f"[*] Generated temp email: {email} for {username}")
270
+
271
+ # --- Placeholder for your signup logic ---
272
+ print(f"[*] Attempting signup on {service_url} with {email}...")
273
+ # success = await sign_up_to_service(service_url, username, email)
274
+ success = True # Assume signup initiates email sending
275
+ if not success:
276
+ print("[!] Service signup failed.")
277
+ return None
278
+ # -----------------------------------------
279
+
280
+ print("[*] Waiting for verification email...")
281
+ # Wait up to 2 minutes (12 checks * 10 seconds interval)
282
+ for attempt in range(12):
283
+ print(f"[*] Checking for messages (Attempt {attempt + 1}/12)...")
284
+ messages = await provider.get_messages()
285
+
286
+ # Simple check: look for "verify" or "confirm" in subject
287
+ verification_msg = next((
288
+ m for m in messages
289
+ if "verify" in m.get('subject', '').lower() or \
290
+ "confirm" in m.get('subject', '').lower()
291
+ ), None)
292
+
293
+ if verification_msg:
294
+ print("[+] Verification email found!")
295
+ print(f" Subject: {verification_msg.get('subject')}")
296
+ # --- Placeholder for link extraction ---
297
+ # verification_link = extract_link_from_message(verification_msg.get('body', ''))
298
+ verification_link = f"http://example.com/verify?token=xyz..." # Dummy link
299
+ # -------------------------------------
300
+ if verification_link:
301
+ print(f"[+] Extracted verification link: {verification_link}")
302
+ break # Exit loop once link is found
303
+ else:
304
+ print("[!] Found email, but failed to extract link.")
305
+
306
+ await asyncio.sleep(10) # Wait before next check
307
+
308
+ if not verification_link:
309
+ print("[!] Timed out waiting for verification email or link.")
310
+
311
+ except Exception as e:
312
+ print(f"[!] An error occurred: {e}")
313
+ finally:
314
+ # Clean up regardless of success/failure
315
+ if email_data:
316
+ print("[*] Cleaning up temporary email...")
317
+ try:
318
+ # Adjust deletion based on provider needs (ID, token, etc.)
319
+ await provider.delete_email(email_data['id'], email_data['token'])
320
+ print("[*] Temporary email deleted.")
321
+ except Exception as del_e:
322
+ print(f"[!] Error during email deletion: {del_e}")
323
+
324
+ await provider.close()
325
+ print("[*] Async provider closed.")
326
+
327
+ return verification_link
328
+
329
+ # Example call (replace with actual service interaction)
330
+ # asyncio.run(verify_email_signup("https://some-service.com/signup", "testuser123"))
331
+ ```
332
+
333
+ ### Testing Email Functionality (Sync)
334
+
335
+ ```python
336
+ from webscout.Extra.tempmail import get_random_email
337
+ import time
338
+ # Assume send_test_email is a function you have defined
339
+ # from your_email_sending_module import send_test_email
340
+
341
+ def test_email_sending_feature():
342
+ """Tests if an email sent to a temp address is received."""
343
+ print("[*] Starting email sending test...")
344
+ email, provider = get_random_email()
345
+ print(f"[*] Generated temp email for receiving: {email}")
346
+
347
+ test_subject = "My Test Email Subject"
348
+ test_content = "This is the body of the test email."
349
+ test_email_received = False
350
+
351
+ try:
352
+ # --- Placeholder for your email sending logic ---
353
+ print(f"[*] Sending test email to {email}...")
354
+ # success = send_test_email(email, test_subject, test_content)
355
+ success = True # Assume sending works
356
+ if not success:
357
+ print("[!] Failed to send test email.")
358
+ return False
359
+ # ---------------------------------------------
360
+
361
+ print("[*] Waiting a few seconds for email delivery...")
362
+ time.sleep(15) # Allow time for email to arrive
363
+
364
+ print("[*] Checking inbox...")
365
+ messages = provider.get_messages()
366
+
367
+ if not messages:
368
+ print("[!] No messages received in the temporary inbox.")
369
+ else:
370
+ print(f"[*] Received {len(messages)} message(s). Checking for test email...")
371
+ for msg in messages:
372
+ if msg.get('subject') == test_subject:
373
+ print(f"[+] Test email received successfully!")
374
+ print(f" From: {msg.get('from')}")
375
+ # Optional: Verify content
376
+ # if test_content in msg.get('body', ''):
377
+ # print("[+] Email content verified.")
378
+ test_email_received = True
379
+ break # Found the email
380
+ if not test_email_received:
381
+ print(f"[!] Test email with subject '{test_subject}' not found.")
382
+
383
+ except Exception as e:
384
+ print(f"[!] An error occurred during the test: {e}")
385
+ finally:
386
+ # Clean up the temporary email account
387
+ print("[*] Deleting temporary email account...")
388
+ try:
389
+ provider.delete_account() # Adjust if deletion needs specific info
390
+ print("[*] Account deleted.")
391
+ except Exception as del_e:
392
+ print(f"[!] Error deleting account: {del_e}")
393
+
394
+ print(f"[*] Email sending test result: {'Success' if test_email_received else 'Failure'}")
395
+ return test_email_received
396
+
397
+ # Run the test
398
+ # test_result = test_email_sending_feature()
399
+ ```
400
+
401
+ ### Using Async Helper Utilities
402
+
403
+ ```python
404
+ import asyncio
405
+ from webscout.Extra.tempmail.async_utils import get_temp_email, wait_for_message
406
+
407
+ async def use_async_helpers():
408
+ email = None
409
+ helper = None
410
+ print("[*] Using async helper utilities...")
411
+ try:
412
+ # 1. Create a new email using the helper
413
+ email, helper = await get_temp_email()
414
+ print(f"[*] Temporary email created via helper: {email}")
415
+
416
+ # 2. Wait for a message to arrive (timeout after 60 seconds)
417
+ print("[*] Waiting for a message (up to 60s)...")
418
+ # Simulate sending an email here if needed for testing
419
+ # await send_email_to(email, "Helper Test", "Body content")
420
+
421
+ message = await wait_for_message(helper, timeout=60, check_interval=5)
422
+
423
+ if message:
424
+ print("[+] Message received!")
425
+ print(f" From: {message.get('from', 'N/A')}")
426
+ print(f" Subject: {message.get('subject', 'N/A')}")
427
+ # print(f"Body: {message.get('body', 'N/A')[:100]}...") # Optional: print body snippet
428
+ else:
429
+ print("[!] No messages received within the 60-second timeout period.")
430
+
431
+ except Exception as e:
432
+ print(f"[!] An error occurred: {e}")
433
+ finally:
434
+ # 3. Clean up using the helper's delete method
435
+ if helper:
436
+ print("[*] Cleaning up email via helper...")
437
+ await helper.delete()
438
+ print("[*] Email deleted by helper.")
439
+ else:
440
+ print("[!] Helper instance not available for cleanup.")
441
+
442
+ # Run the async function
443
+ if __name__ == "__main__":
444
+ asyncio.run(use_async_helpers())
445
+ ```
446
+
447
+ ## 🔌 Provider Integration
448
+
449
+ Adding support for a new temporary email service is straightforward thanks to the abstract provider pattern used throughout Webscout:
450
+
451
+ 1. **Create Provider Classes**: Implement two new classes:
452
+ * One inheriting from `webscout.Extra.tempmail.base.TempMailProvider` for synchronous operations.
453
+ * One inheriting from `webscout.Extra.tempmail.base.AsyncTempMailProvider` for asynchronous operations.
454
+ Implement all the abstract methods defined in the base classes (e.g., `create_account`/`create_email`, `get_messages`, `delete_account`/`delete_email`).
455
+ 2. **Register in Factory**: Update the `get_provider` function in `webscout/Extra/tempmail/base.py` to recognize a new `provider_name` string and return instances of your newly created classes.
456
+ 3. **Expose (Optional)**: If desired, update `webscout/Extra/tempmail/__init__.py` to directly import and expose your new provider classes for users who might want to instantiate them directly.
457
+ 4. **Add Tests**: Create unit and integration tests for your new provider to ensure it functions correctly.
458
+ 5. **Update Documentation**: Add your new provider to this README, including any specific usage notes.
459
+
460
+ ## 🛠️ Implementation Details
461
+
462
+ * **Parser**: Uses the `Scout` HTML/XML parser from the core `webscout` library instead of external libraries like `BeautifulSoup` for consistency and potentially better performance within the Webscout ecosystem.
463
+ * **Sync/Async Parity**: Aims to provide feature parity between the synchronous (`TempMailProvider`) and asynchronous (`AsyncTempMailProvider`) interfaces for all supported providers.
464
+ * **Factories**: Relies on factory functions (`get_provider`, `get_random_email`) for easy and consistent instantiation of provider objects.
465
+ * **Minimal Dependencies**: Avoids adding external logging or unnecessary dependencies to ensure smooth integration into projects using Webscout.
466
+
467
+ ## 🤝 Contributing
468
+
469
+ Contributions to enhance the TempMail module are highly welcome! Potential areas include:
470
+
471
+ 1. **Adding New Providers**: Integrating support for additional temporary email services.
472
+ 2. **Improving CLI**: Enhancing the command-line interface with more features or better output formatting.
473
+ 3. **Robustness**: Improving error handling, retries, and provider-specific edge cases.
474
+ 4. **Utility Functions**: Adding more helper functions for common temporary email automation tasks.
475
+ 5. **Documentation**: Refining examples, API descriptions, and usage guides.
476
+
477
+ Please refer to the main Webscout project's contributing guidelines if you plan to submit a pull request.
478
+
479
+ <div align="center">
480
+ <!-- Footer Links (Mirrored from main README) -->
481
+ <div>
482
+ <a href="https://t.me/PyscoutAI"><img alt="Telegram Group" src="https://img.shields.io/badge/Telegram%20Group-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
483
+ <a href="https://t.me/ANONYMOUS_56788"><img alt="Developer Telegram" src="https://img.shields.io/badge/Developer%20Contact-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
484
+ <a href="https://buymeacoffee.com/oevortex"><img alt="Buy Me A Coffee" src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black"></a>
485
+ </div>
486
+ <p>📧 TempMail - Part of the Webscout Toolkit</p>
487
+ <a href="https://github.com/OEvortex/Webscout">Back to Main Webscout Project</a>
488
488
  </div>