# MailslurpJavascriptApollo.FormControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
submitForm POST /forms Submit a form to be parsed and sent as an email to an address determined by the form fields

# submitForm

String submitForm(opts)

Submit a form to be parsed and sent as an email to an address determined by the form fields

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=&quot;https://api.mailslurp.com/forms&quot; method=&quot;post&quot; > <input name=&quot;_to&quot; type=&quot;hidden&quot; value=&quot;test@example.com&quot;/> <textarea name=&quot;feedback&quot;></textarea> <button type=&quot;submit&quot;>Submit</button> </form> ``` #### URL Example ```html <form action=&quot;https://api.mailslurp.com/forms?_toAlias=test@example.com&quot; method=&quot;post&quot; > <textarea name=&quot;feedback&quot;></textarea> <button type=&quot;submit&quot;>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=&quot;multipart/form-data&quot;>`.

# Example

import MailslurpJavascriptApollo from 'mailslurp-javascript-apollo';
let defaultClient = MailslurpJavascriptApollo.ApiClient.instance;
// Configure API key authorization: API_KEY
let API_KEY = defaultClient.authentications['API_KEY'];
API_KEY.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.apiKeyPrefix = 'Token';
let apiInstance = new MailslurpJavascriptApollo.FormControllerApi();
let opts = {
  'emailAddress': "emailAddress_example", // String | Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
  'redirectTo': "redirectTo_example", // String | Optional URL to redirect form submitter to after submission. If not present user will see a success message.
  'spamCheck': "spamCheck_example", // String | Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
  'subject': "subject_example", // String | Optional subject of the email that will be sent.
  'successMessage': "successMessage_example", // String | Optional success message to display if no _redirectTo present.
  'to': "to_example", // String | The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
  'toAlias': "toAlias_example", // String | ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
  'otherParameters': "otherParameters_example" // String | All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
};
apiInstance.submitForm(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

# Parameters

Name Type Description Notes
emailAddress String Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. [optional]
redirectTo String Optional URL to redirect form submitter to after submission. If not present user will see a success message. [optional]
spamCheck String Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. [optional]
subject String Optional subject of the email that will be sent. [optional]
successMessage String Optional success message to display if no _redirectTo present. [optional]
to String The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted.. [optional]
toAlias String ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam. [optional]
otherParameters String All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. [optional]

# Return type

String

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: multipart/form-data, application/x-www-form-urlencoded
  • Accept: application/json