Merge branch 'main' into CUST-4514-python-sdk-handle-non-json-responses-html-fastly-empty-etc-stemming-from-500-s

Author: samuelpx

.bumpversion.cfg

@@ -1,6 +1,6 @@
 [bumpversion]
 commit = True
 tag = True
-current_version = 6.11.1
+current_version = 6.13.0
 
 [bumpversion:file:nylas/_client_sdk_version.py]

CHANGELOG.md

@@ -1,7 +1,12 @@
 nylas-python Changelog
 ======================
 
-Unreleased
+v6.13.0
+----------
+* Fixed from field handling in messages.send() to properly map "from_" field to "from field
+* Fixed content_id handling for large inline attachments to use content_id as field name instead of generic file{index}
+
+v6.12.0
 ----------
 * Added Yahoo, Zoom, EWS as providers to models/auth.py
 * Fixed grants.update() not using the correct "PATCH" method

Contributing.md

@@ -3,6 +3,160 @@
 
 The following is a set of guidelines for contributing to the Nylas Python SDK; these are guidelines, not rules, so please use your best judgement and feel free to propose changes to this document via pull request.
 
+# Development Setup
+
+To get started contributing to this repository, you'll need to set up a local development environment. Follow these steps:
+
+## Prerequisites
+
+- Python 3.8 or higher (the project supports Python 3.8+)
+- Git
+- A GitHub account
+
+## Setup Steps
+
+### 1. Fork and Clone the Repository
+
+```bash
+# Fork the repository on GitHub, then clone your fork
+git clone https://github.com/YOUR_USERNAME/nylas-python.git
+cd nylas-python
+
+# Add the upstream repository as a remote
+git remote add upstream https://github.com/nylas/nylas-python.git
+```
+
+### 2. Set Up Python Virtual Environment
+
+We recommend using a virtual environment to isolate your development dependencies:
+
+```bash
+# Create a virtual environment
+python3 -m venv .venv
+
+# Activate the virtual environment
+# On macOS/Linux:
+source .venv/bin/activate
+
+# On Windows:
+# .venv\Scripts\activate
+```
+
+**Important**: If you encounter issues with `pip` not being available in the virtual environment, run:
+
+```bash
+# Ensure pip is available in the virtual environment
+python -m ensurepip --upgrade
+```
+
+### 3. Install Development Dependencies
+
+Install the package in editable mode with all optional dependencies:
+
+```bash
+# Install the package in development mode with all optional dependencies
+python -m pip install -e ".[test,docs,release]"
+
+# Or install specific dependency groups as needed:
+# python -m pip install -e ".[test]"     # For running tests
+# python -m pip install -e ".[docs]"     # For building documentation
+# python -m pip install -e ".[release]"  # For release management
+```
+
+**Note**: We use `python -m pip` instead of just `pip` to ensure we're using the pip from the virtual environment.
+
+### 4. Install Code Quality Tools
+
+Install the linting and formatting tools used by the project:
+
+```bash
+python -m pip install pylint black
+```
+
+### 5. Verify Your Setup
+
+Run the tests to make sure everything is working correctly:
+
+```bash
+# Run the test suite
+python setup.py test
+
+# Or run tests with pytest directly
+pytest
+
+# Run with coverage
+pytest --cov=nylas tests/
+```
+
+Check code formatting and linting:
+
+```bash
+# Check code formatting (this will modify files)
+black .
+
+# Run linting
+pylint nylas
+```
+
+## Development Workflow
+
+1. **Create a branch** for your feature or bug fix:
+   ```bash
+   git checkout -b your-feature-branch
+   ```
+
+2. **Make your changes** and write tests for any new functionality
+
+3. **Run tests and linting**:
+   ```bash
+   python setup.py test
+   black .
+   pylint nylas
+   ```
+
+4. **Commit your changes** following [conventional commit practices](https://www.conventionalcommits.org/)
+
+5. **Push to your fork** and create a pull request
+
+## Project Structure
+
+- `nylas/` - Main SDK source code
+- `tests/` - Test files
+- `examples/` - Example usage scripts
+- `scripts/` - Build and development scripts
+- `pyproject.toml` - Project configuration and dependencies
+- `setup.py` - Legacy setup file (still used for some operations)
+
+## Running Tests
+
+The project uses pytest for testing:
+
+```bash
+# Run all tests
+pytest
+
+# Run tests with coverage
+pytest --cov=nylas tests/
+
+# Run specific test files
+pytest tests/test_specific_module.py
+
+# Run tests matching a pattern
+pytest -k "test_pattern"
+```
+
+## Documentation
+
+To build the documentation locally:
+
+```bash
+# Make sure you have docs dependencies installed
+pip install -e ".[docs]"
+
+# Generate documentation (if there are scripts for this)
+python scripts/generate-docs.py
+```
+
 # How to Ask a Question
 
 If you have a question about how to use the Python SDK, please [create an issue](https://github.com/nylas/nylas-python/issues) and label it as a question. If you have more general questions about the Nylas Communications Platform, or the Nylas Email, Calendar, and Contacts API, please reach out to support@nylas.com to get help.

examples/inline_attachment_demo/README.md

@@ -0,0 +1,65 @@
+# Inline Attachment Example
+
+This example demonstrates how to send messages and drafts with inline attachments using the `content_id` field in the Nylas Python SDK.
+
+## What This Example Shows
+
+- How to create inline attachments with `content_id` for HTML emails
+- How the SDK properly handles `content_id` for large attachments (>3MB)
+- The difference between inline attachments and regular attachments
+- How to reference inline attachments in HTML email bodies using `cid:` syntax
+
+## Key Features Demonstrated
+
+### Content ID Usage
+When an attachment includes a `content_id` field, the SDK will use this as the field name in multipart form data instead of the generic `file{index}` pattern. This is crucial for inline attachments that need to be referenced in the email body.
+
+### HTML Email with Inline Images
+The example shows how to:
+1. Set the `content_id` field in the attachment
+2. Reference the attachment in HTML using `src="cid:your-content-id"`
+3. Set appropriate inline properties (`is_inline: True`, `content_disposition: "inline"`)
+
+### Large Attachment Handling
+For attachments larger than 3MB, the SDK automatically switches from JSON to multipart form data. With this fix, the `content_id` is now properly respected in the form field names.
+
+## Running the Example
+
+1. Set your Nylas API key:
+   ```bash
+   export NYLAS_API_KEY='your-api-key-here'
+   ```
+
+2. Update the grant ID and email addresses in the script
+
+3. Run the example:
+   ```bash
+   python inline_attachment_example.py
+   ```
+
+## Important Notes
+
+- **Content ID Format**: Use a unique identifier for each inline attachment (e.g., `"image1@example.com"`, `"logo"`, `"banner-image"`)
+- **HTML Reference**: Reference inline attachments in HTML using `src="cid:your-content-id"`
+- **Backward Compatibility**: Attachments without `content_id` still work as before using `file{index}` naming
+- **File Size Threshold**: The 3MB threshold determines whether JSON or form data is used for the request
+
+## Expected Behavior
+
+### Before the Fix (Problematic)
+```
+Form data fields:
+- message: (JSON payload)
+- file0: (inline image - content_id ignored)
+- file1: (regular attachment)
+```
+
+### After the Fix (Correct)
+```
+Form data fields:
+- message: (JSON payload)
+- my-inline-image: (inline image - uses content_id)
+- file1: (regular attachment - fallback to file{index})
+```
+
+This ensures that email clients can properly display inline images by matching the `content_id` in the HTML `cid:` reference with the multipart form field name.