com.mailslurp.models

Class CreateWebhookOptions

java.lang.Object

com.mailslurp.models.CreateWebhookOptions

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class CreateWebhookOptions
extends Object

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_BASIC_AUTH
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor and Description
CreateWebhookOptions()

Method Summary

Modifier and Type	Method and Description
CreateWebhookOptions	basicAuth(BasicAuthOptions basicAuth)
boolean	equals(Object o)
BasicAuthOptions	getBasicAuth() Get basicAuth
String	getName() Optional name for the webhook
String	getUrl() Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received.
int	hashCode()
CreateWebhookOptions	name(String name)
void	setBasicAuth(BasicAuthOptions basicAuth)
void	setName(String name)
void	setUrl(String url)
String	toString()
CreateWebhookOptions	url(String url)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_BASIC_AUTH

public static final String SERIALIZED_NAME_BASIC_AUTH

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

Constant Field Values

Constructor Detail

CreateWebhookOptions

public CreateWebhookOptions()

Method Detail

basicAuth

public CreateWebhookOptions basicAuth(BasicAuthOptions basicAuth)

getBasicAuth

@Nullable
public BasicAuthOptions getBasicAuth()

Get basicAuth

Returns:

basicAuth

setBasicAuth

public void setBasicAuth(BasicAuthOptions basicAuth)

name

public CreateWebhookOptions name(String name)

getName

@Nullable
public String getName()

Optional name for the webhook

Returns:

name

setName

public void setName(String name)

url

public CreateWebhookOptions url(String url)

getUrl

@Nullable
public String getUrl()

Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received. The payload of the submitted JSON is described by https://api.mailslurp.com/schemas/webhook-payload

Returns:

url

setUrl

public void setUrl(String url)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object