ZeptoMail Client¶
This page documents the main ZeptoMail
client class and its methods.
Class Reference¶
ZeptoMail
¶
A Python client for interacting with the ZeptoMail API.
Note: This is an unofficial SDK. Namilink Kft is not affiliated with ZeptoMail.
Source code in zeptomail/client.py
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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
|
Attributes¶
api_key = api_key
instance-attribute
¶
base_url = base_url
instance-attribute
¶
headers = {'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': api_key}
instance-attribute
¶
Functions¶
__init__(api_key, base_url='https://api.zeptomail.eu/v1.1')
¶
Initialize the ZeptoMail client.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_key
|
str
|
Your ZeptoMail API key |
required |
base_url
|
str
|
The base URL for the ZeptoMail API (defaults to https://api.zeptomail.eu/v1.1) |
'https://api.zeptomail.eu/v1.1'
|
Source code in zeptomail/client.py
_build_recipient(address, name=None)
¶
Build a recipient object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
address
|
str
|
Email address of the recipient |
required |
name
|
Optional[str]
|
Name of the recipient |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Dict containing recipient details |
Source code in zeptomail/client.py
_build_recipient_with_merge_info(address, name=None, merge_info=None)
¶
Build a recipient object with merge info.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
address
|
str
|
Email address of the recipient |
required |
name
|
Optional[str]
|
Name of the recipient |
None
|
merge_info
|
Optional[Dict]
|
Dictionary containing merge fields for this recipient |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Dict containing recipient details with merge info |
Source code in zeptomail/client.py
_ensure_json_serializable(obj)
¶
Recursively process an object to ensure it's JSON serializable. Converts bytes to base64-encoded strings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj
|
Any
|
The object to process |
required |
Returns:
Type | Description |
---|---|
Any
|
A JSON serializable version of the object |
Source code in zeptomail/client.py
_get_error_solution(code, sub_code, details)
¶
Get a solution message based on error codes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
code
|
str
|
The error code |
required |
sub_code
|
str
|
The error sub-code |
required |
details
|
List[Dict]
|
Error details |
required |
Returns:
Type | Description |
---|---|
Optional[str]
|
A solution message or None |
Source code in zeptomail/client.py
_handle_response(response)
¶
Handle the API response and check for errors.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response
|
Response
|
Response object from requests |
required |
Returns:
Type | Description |
---|---|
Dict
|
Parsed response as a dictionary |
Raises:
Type | Description |
---|---|
ZeptoMailError
|
If the API returns an error |
Source code in zeptomail/client.py
add_attachment_from_content(content, mime_type, name)
¶
Add an attachment using base64 encoded content.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
content
|
str
|
Base64 encoded content |
required |
mime_type
|
str
|
MIME type of the content |
required |
name
|
str
|
Name for the file |
required |
Returns:
Type | Description |
---|---|
Dict
|
Attachment dictionary |
Source code in zeptomail/client.py
add_attachment_from_file_cache(file_cache_key, name=None)
¶
Add an attachment using a file cache key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_cache_key
|
str
|
File cache key from ZeptoMail |
required |
name
|
Optional[str]
|
Optional name for the file |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Attachment dictionary |
Source code in zeptomail/client.py
add_batch_recipient(address, name=None, merge_info=None)
¶
Create a batch recipient object with merge info.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
address
|
str
|
Email address |
required |
name
|
Optional[str]
|
Recipient name |
None
|
merge_info
|
Optional[Dict]
|
Merge fields for this recipient |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Recipient dictionary with merge info |
Source code in zeptomail/client.py
add_inline_image(cid, content=None, mime_type=None, file_cache_key=None)
¶
Add an inline image to the email.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cid
|
str
|
Content ID to reference in HTML |
required |
content
|
Optional[str]
|
Base64 encoded content |
None
|
mime_type
|
Optional[str]
|
MIME type of the content |
None
|
file_cache_key
|
Optional[str]
|
File cache key from ZeptoMail |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Inline image dictionary |
Source code in zeptomail/client.py
add_recipient(address, name=None)
¶
Create a recipient object for use in to, cc, bcc lists.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
address
|
str
|
Email address |
required |
name
|
Optional[str]
|
Recipient name |
None
|
Returns:
Type | Description |
---|---|
Dict
|
Recipient dictionary |
Source code in zeptomail/client.py
send_batch_email(from_address, from_name=None, to=None, cc=None, bcc=None, subject='', html_body=None, text_body=None, attachments=None, inline_images=None, track_clicks=True, track_opens=True, client_reference=None, mime_headers=None, merge_info=None)
¶
Send a batch email using the ZeptoMail API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
from_address
|
str
|
Sender's email address |
required |
from_name
|
Optional[str]
|
Sender's name |
None
|
to
|
List[Dict]
|
List of recipient dictionaries with optional merge_info |
None
|
cc
|
List[Dict]
|
List of cc recipient dictionaries |
None
|
bcc
|
List[Dict]
|
List of bcc recipient dictionaries |
None
|
subject
|
str
|
Email subject |
''
|
html_body
|
Optional[str]
|
HTML content of the email |
None
|
text_body
|
Optional[str]
|
Plain text content of the email |
None
|
attachments
|
List[Dict]
|
List of attachment dictionaries |
None
|
inline_images
|
List[Dict]
|
List of inline image dictionaries |
None
|
track_clicks
|
bool
|
Whether to track clicks |
True
|
track_opens
|
bool
|
Whether to track opens |
True
|
client_reference
|
Optional[str]
|
Client reference identifier |
None
|
mime_headers
|
Optional[Dict]
|
Additional MIME headers |
None
|
merge_info
|
Optional[Dict]
|
Global merge info for recipients without specific merge info |
None
|
Returns:
Type | Description |
---|---|
Dict
|
API response as a dictionary |
Source code in zeptomail/client.py
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
|
send_email(from_address, from_name=None, to=None, cc=None, bcc=None, reply_to=None, subject='', html_body=None, text_body=None, attachments=None, inline_images=None, track_clicks=True, track_opens=True, client_reference=None, mime_headers=None)
¶
Send a single email using the ZeptoMail API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
from_address
|
str
|
Sender's email address |
required |
from_name
|
Optional[str]
|
Sender's name |
None
|
to
|
List[Dict]
|
List of recipient dictionaries |
None
|
cc
|
List[Dict]
|
List of cc recipient dictionaries |
None
|
bcc
|
List[Dict]
|
List of bcc recipient dictionaries |
None
|
reply_to
|
List[Dict]
|
List of reply-to dictionaries |
None
|
subject
|
str
|
Email subject |
''
|
html_body
|
Optional[str]
|
HTML content of the email |
None
|
text_body
|
Optional[str]
|
Plain text content of the email |
None
|
attachments
|
List[Dict]
|
List of attachment dictionaries |
None
|
inline_images
|
List[Dict]
|
List of inline image dictionaries |
None
|
track_clicks
|
bool
|
Whether to track clicks |
True
|
track_opens
|
bool
|
Whether to track opens |
True
|
client_reference
|
Optional[str]
|
Client reference identifier |
None
|
mime_headers
|
Optional[Dict]
|
Additional MIME headers |
None
|
Returns:
Type | Description |
---|---|
Dict
|
API response as a dictionary |
Source code in zeptomail/client.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
|
Source Code in LLMs
When generating the LLMs text file, only function signatures and docstrings are included, not the implementation details.
Usage Examples¶
Basic Initialization¶
from zeptomail import ZeptoMail
# Initialize with API key
client = ZeptoMail("your-api-key-here")
# Or with custom base URL (for different regions)
client = ZeptoMail(
api_key="your-api-key-here",
base_url="https://api.zeptomail.com/v1.1" # Custom API endpoint
)
Sending a Simple Email¶
# Create a recipient
recipient = client.add_recipient("recipient@example.com", "Recipient Name")
# Send a simple email
response = client.send_email(
from_address="sender@example.com",
from_name="Sender Name",
to=[recipient],
subject="Test Email",
html_body="<h1>Hello World!</h1><p>This is a test email.</p>",
text_body="Hello World! This is a test email."
)
print(f"Email sent with message ID: {response['data']['message_id']}")
See the Examples section for more detailed usage examples.