Constructor Detail

• FormControllerApi

  FormControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• submitForm

   final String submitForm(String to, String subject, String redirectTo, String emailAddress, String successMessage, String spamCheck, String otherParameters)

  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 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?_to=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\">`.

  Parameters:

  to - The email address that submitted form should be sent to.

  subject - Optional subject of the email that will be sent.

  redirectTo - Optional URL to redirect form submitter to after submission.

  emailAddress - Email address of the submitting user.

  successMessage - Optional success message to display if no _redirectTo present.

  spamCheck - Optional but recommended field that catches spammers out.

  otherParameters - All other parameters or fields will be accepted and attached to the sent email.

• submitFormRequestConfig

   final RequestConfig submitFormRequestConfig(String to, String subject, String redirectTo, String emailAddress, String successMessage, String spamCheck, String otherParameters)

  To obtain the request config of the operation submitForm

  Parameters:

  to - The email address that submitted form should be sent to.

  subject - Optional subject of the email that will be sent.

  redirectTo - Optional URL to redirect form submitter to after submission.

  emailAddress - Email address of the submitting user.

  successMessage - Optional success message to display if no _redirectTo present.

  spamCheck - Optional but recommended field that catches spammers out.

  otherParameters - All other parameters or fields will be accepted and attached to the sent email.