DocSpring::CreateAccountEmailActionRequest

Properties

Name	Type	Description	Notes
template_ids	Array<String>	For an account email action: the IDs of the templates it sends for. With `folder_ids`, it sends for a template that either list includes. Both empty sends for every template. Always empty for a template's own email action.	[optional]
folder_ids	Array<String>	For an account email action: the IDs of folders whose templates it sends for, including the templates in the folders inside them. Always empty for a template's own email action.	[optional]
name	String	A name for the email action, shown in the dashboard. Null shows its recipients instead.	[optional]
enabled	Boolean	Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.	[optional]
to	Array<String>	Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.	[optional]
cc	Array<String>	Who is copied on each email, as in `to` (but not `{{ signer.email }}`).	[optional]
bcc	Array<String>	Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).	[optional]
from_name	String	The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".	[optional]
from_address	String	The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.	[optional]
reply_to	String	Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.	[optional]
subject	String	The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.	[optional]
message	String	The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.	[optional]
file_name	String	The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.	[optional]
file_formats	EmailActionFileFormats	Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.	[optional]
delivery	EmailActionDelivery	`attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.	[optional]
max_attachment_mb	Integer	With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).	[optional]
submission_type	EmailActionSubmissionType	Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.	[optional]
send_when	EmailActionConditionsInput	Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.	[optional]
failure_notifications_enabled	Boolean	Whether the account's owner gets an email when the email action's emails keep failing.	[optional]

Example

require 'docspring'

instance = DocSpring::CreateAccountEmailActionRequest.new(
  template_ids: null,
  folder_ids: null,
  name: null,
  enabled: null,
  to: null,
  cc: null,
  bcc: null,
  from_name: null,
  from_address: null,
  reply_to: null,
  subject: null,
  message: null,
  file_name: null,
  file_formats: null,
  delivery: null,
  max_attachment_mb: null,
  submission_type: null,
  send_when: null,
  failure_notifications_enabled: null
)

GeezerVison

Expand file tree

CreateAccountEmailActionRequest.md

Latest commit

History

CreateAccountEmailActionRequest.md

File metadata and controls

DocSpring::CreateAccountEmailActionRequest

Properties

Example