EmailService is used to send emails.
Method Name | Request Type | Response Type | Description |
SendEmailWithTemplate | SendEmailWithTemplateRequest | SendEmailWithTemplateResponse | Send an email with template |
SendEmail | SendEmailRequest | SendEmailResponse | Send an email with raw content instead of using templates. |
Email content
Field | Type | Label | Description |
text | string | Required. |
Address information
Field | Type | Label | Description |
from | string | Required. The Email sender address. |
|
to | string | repeated | Required. The Email destination addresses. |
cc | string | repeated | Optional. To whom the mail is cc |
Email template
Field | Type | Label | Description |
template_id | string | Required |
|
template_params | EmailTemplate.TemplateParamsEntry | repeated | Required |
Field | Type | Label | Description |
key | string |
|
|
value | string |
|
SendEmailRequest is the message send to email.
Field | Type | Label | Description |
component_name | string | The saas service name, like 'aliyun.email'/'aws.ses'/'...' If your system uses multiple IVR services at the same time, you can specify which service to use with this field. |
|
setting_id | string | Required. |
|
subject | string | Required. The Email subject. |
|
content | Content | Required. |
|
address | EmailAddress | Required. |
The response of `SendEmail` method
Field | Type | Label | Description |
request_id | string | The saas requestId. |
SendEmailWithTemplateRequest is the message send to email.
Field | Type | Label | Description |
component_name | string | The saas service name, like 'aliyun.email'/'aws.ses'/'...' If your system uses multiple IVR services at the same time, you can specify which service to use with this field. |
|
template | EmailTemplate | Required. |
|
subject | string | Required. The Email subject. |
|
address | EmailAddress | Required. |
Response of `SendEmailWithTemplate` method
Field | Type | Label | Description |
request_id | string | The saas requestId. |
.proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
double | double | double | float | float64 | double | float | Float | |
float | float | float | float | float32 | float | float | Float | |
int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |