Contents

# Buildium::CreateEmailRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **template_id** | **Integer** | Unique identifier of the email template to use for the body of the email. Any tokens present in the template will be replaced based on the recipient(s) of the email.  The following email templates cannot be used:  <ul><li>1 (Tenant Statement)</li><li>2 (Homeowner Statement)</li><li>3 (Rental Owner Statement)</li><li>123 (Association Tenant Invoice)</li><li>124 (Rental Tenant Invoice)</li></ul> |  |
| **subject** | **String** | Email subject. |  |
| **include_alternate_emails** | **Boolean** | Indicates whether to send the email to the recipient's primary and alternate email addresses. |  |
| **exclude_delinquent_recipients** | **Boolean** | Indicates whether to exclude sending emails to association owners that are flagged as delinquent. This only applies to association recipients. |  |
| **include_association_tenants** | **Boolean** | Indicates whether to include association tenants. Only applies to association properties. |  |
| **property_ids** | **Array<Integer>** | A list of association and/or rental property unique identifiers to send the email to. Cannot be populated if 'RecipientIds' is present. | [optional] |
| **recipient_ids** | **Array<Integer>** | A list of individual unique identifiers to send the email to. Cannot be populated if 'PropertyIds' is present. | [optional] |

## Example

```ruby
require 'buildium-ruby'

instance = Buildium::CreateEmailRequest.new(
  template_id: null,
  subject: null,
  include_alternate_emails: null,
  exclude_delinquent_recipients: null,
  include_association_tenants: null,
  property_ids: null,
  recipient_ids: null
)
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
buildium-ruby-3.1.0	docs/CreateEmailRequest.md