Globals / FormControllerApi
# Class: FormControllerApi
FormControllerApi - object-oriented interface
export
# Hierarchy
-
↳ FormControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new FormControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): FormControllerApi
Inherited from BaseAPI.constructor
Defined in src/generated/api.ts:57 (opens new window)
# Parameters:
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | - |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Returns: FormControllerApi
# Properties
# basePath
• Protected basePath: string
Inherited from BaseAPI.basePath
Defined in src/generated/api.ts:61 (opens new window)
# configuration
• Protected configuration: Configuration
Inherited from BaseAPI.configuration
Defined in src/generated/api.ts:57 (opens new window)
# fetch
• Protected fetch: FetchAPI
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# submitForm
▸ submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, toAlias?: string, otherParameters?: string, options?: any): Promise<string>
Defined in src/generated/api.ts:8616 (opens new window)
This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a _to email address or a _toAlias email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding name attributes or as URL query parameters such as ?_to=test@example.com The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts application/x-www-form-urlencoded, and multipart/form-data content-types. #### HTML Example html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> #### URL Example html <form action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> The email address is specified by a _to field OR is extracted from an email alias specified by a _toAlias field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the enctype attribute, for instance: <form enctype=\"multipart/form-data\">.
summary Submit a form to be parsed and sent as an email to an address determined by the form fields
throws {RequiredError}
memberof FormControllerApi
# Parameters:
| Name | Type |
|---|---|
emailAddress? | string |
redirectTo? | string |
spamCheck? | string |
subject? | string |
successMessage? | string |
to? | string |
toAlias? | string |
otherParameters? | string |
options? | any |
Returns: Promise<string>
