com.mailslurp.apis

Class FormControllerApi

java.lang.Object

com.mailslurp.apis.FormControllerApi

public class FormControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FormControllerApi()
FormControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
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.
okhttp3.Call	submitFormAsync(String to, String subject, String redirectTo, String emailAddress, String successMessage, String spamCheck, String otherParameters, ApiCallback<String> _callback) Submit a form to be parsed and sent as an email to an address determined by the form fields (asynchronously) This endpoint allows you to submit HTML forms and receive the field values and files via email.
okhttp3.Call	submitFormCall(String to, String subject, String redirectTo, String emailAddress, String successMessage, String spamCheck, String otherParameters, ApiCallback _callback) Build call for submitForm
ApiResponse<String>	submitFormWithHttpInfo(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormControllerApi

public FormControllerApi()

FormControllerApi

public FormControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

submitFormCall

public okhttp3.Call submitFormCall(String to,
                                   String subject,
                                   String redirectTo,
                                   String emailAddress,
                                   String successMessage,
                                   String spamCheck,
                                   String otherParameters,
                                   ApiCallback _callback)
                            throws ApiException

Build call for submitForm

Parameters:

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

subject - Optional subject of the email that will be sent. (optional)

redirectTo - Optional URL to redirect form submitter to after submission. If not present user will see a success message. (optional)

emailAddress - Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. (optional)

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

spamCheck - 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)

otherParameters - 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)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

submitForm

public String submitForm(String to,
                         String subject,
                         String redirectTo,
                         String emailAddress,
                         String successMessage,
                         String spamCheck,
                         String otherParameters)
                  throws ApiException

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://java.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://java.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. (optional)

subject - Optional subject of the email that will be sent. (optional)

redirectTo - Optional URL to redirect form submitter to after submission. If not present user will see a success message. (optional)

emailAddress - Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. (optional)

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

spamCheck - 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)

otherParameters - 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)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

submitFormWithHttpInfo

public ApiResponse<String> submitFormWithHttpInfo(String to,
                                                  String subject,
                                                  String redirectTo,
                                                  String emailAddress,
                                                  String successMessage,
                                                  String spamCheck,
                                                  String otherParameters)
                                           throws ApiException

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://java.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://java.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. (optional)

subject - Optional subject of the email that will be sent. (optional)

redirectTo - Optional URL to redirect form submitter to after submission. If not present user will see a success message. (optional)

emailAddress - Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. (optional)

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

spamCheck - 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)

otherParameters - 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)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

submitFormAsync

public okhttp3.Call submitFormAsync(String to,
                                    String subject,
                                    String redirectTo,
                                    String emailAddress,
                                    String successMessage,
                                    String spamCheck,
                                    String otherParameters,
                                    ApiCallback<String> _callback)
                             throws ApiException

Submit a form to be parsed and sent as an email to an address determined by the form fields (asynchronously) 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://java.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://java.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. (optional)

subject - Optional subject of the email that will be sent. (optional)

redirectTo - Optional URL to redirect form submitter to after submission. If not present user will see a success message. (optional)

emailAddress - Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. (optional)

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

spamCheck - 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)

otherParameters - 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)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-