Share via

SendGridOutput Interface

  • Reference
Package:
com.microsoft.azure.functions.annotation
Maven Artifact:
com.microsoft.azure.functions:azure-functions-java-library:1.3.1

Implements

java.lang.annotation.Annotation

public interface SendGridOutput
implements java.lang.annotation.Annotation

Place this on a parameter whose value would be written to SendGrid. The parameter type should be OutputBinding, where T could be one of:

  • Any native Java types such as int, String, byte[]
  • Any POJO type

Method Summary

Modifier and Type Method and Description
abstract java.lang.String apiKey()

Defines the API key of the SendGrid to which to write.
abstract java.lang.String dataType()

Defines how Functions runtime should treat the parameter value.
abstract java.lang.String from()

Defines the 'FROM' name of the SendGrid to which to write.
abstract java.lang.String name()

The variable name used in function.json.
abstract java.lang.String subject()

Defines the subject of the SendGrid email to which to write.
abstract java.lang.String text()

Defines the content text of the SendGrid email to which to write.
abstract java.lang.String to()

Defines the 'TO' email of the SendGrid to which to write.

Method Details

apiKey

public abstract String apiKey()

Defines the API key of the SendGrid to which to write.

Returns:

The SendGrid API key string.

dataType

public abstract String dataType()

Defines how Functions runtime should treat the parameter value. Possible values are:

  • "" or string: treat it as a string whose value is serialized from the parameter
  • binary: treat it as a binary data whose value comes from for example OutputBinding<byte[]>

Returns:

The dataType which will be used by the Functions runtime.

from

public abstract String from()

Defines the 'FROM' name of the SendGrid to which to write.

Returns:

The SendGrid 'FROM' name string.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

subject

public abstract String subject()

Defines the subject of the SendGrid email to which to write.

Returns:

The SendGrid email subject string.

text

public abstract String text()

Defines the content text of the SendGrid email to which to write.

Returns:

The SendGrid email content string.

to

public abstract String to()

Defines the 'TO' email of the SendGrid to which to write.

Returns:

The SendGrid 'TO' email string.

Applies to