Create a Send Mail Address
Description
CreateMailAddress API is used for creating a Send Mail Address.
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: CreateMailAddress. |
AccountName | String | Required | Sending Address |
ReplyAddress | String | Optional | ReplyTo mail address |
Sendtype | String | Required | Types of mails:batch or trigger |
For other request parameters, see Public parameters.
Response parameters
Name | Type | Description |
|---|---|---|
mailAddressId | int | Sending mail address id |
For more information about public response parameters, see Public parameters.
Error codes
Error code | HTTP status code | Meaning |
|---|---|---|
InvalidMailAddressName.Malformed | 400 (Bad Request) | The specified mailAddress accountName is wrongly formed. |
InvalidMailAddressNumber.Malformed | 400 (Bad Request) | The amount of mailaddress exceeds the limit. |
Forbidden | 400 (Bad Request) | The operator has no permission on the specified resource. |
InvalidMailAddressDomain.Malformed | 400 (Bad Request) | The specified mailAddress domain does not exist. |
InvalidMailAddressDomainStatus.Malformed | 400 (Bad Request) | The specified mailAddress domain status is wrongly formed. |
InvalidMailAddressName.Duplicate | 400 (Bad Request) | The specified mailAddress accountName has already existed. |
InvalidMailAddressNumber.Malformed | 400 (Bad Request) | The amount of mailaddress exceeds the limit. |
InvalidMailAddressName.Malformed | 400 (Bad Request) | The specified mailAddress accountName is wrongly formed. |
Get the list of sending addresses
Description
QueryMailAddressByParam API is used for querying the list of sending addresses.
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: QueryMailAddressByParam. |
KeyWord | String | Required | mail address,Length 1 to 60, numerals or upper or lower case letters or . or - or @ |
Sendtype | String | Optional | Types of mails:batch or trigger |
PageNo | String | Optional | Offset Page No |
PageSize | String | Optional | Number of Items each page |
For other request parameters, see Public parameters.
Response parameters
Name | Type | Description |
|---|---|---|
data | data |
data
Name | Type | Description |
|---|---|---|
data | Array | data record |
data record
Name | Type | Description |
|---|---|---|
mailAddressId | int | Sending mail address id |
accountName | String | Sending mail address |
replyAddress | String | ReplyTo mail address |
sendtype | String | Types of mails:batch or trigger |
accountStatus | int | Account status, freeze: 1, normal: 0 |
replyStatus | int | ReplyTo mail address status |
createTime | Date | |
dailyCount | int | Daily quota limit |
monthCount | int | Monthly quota limit |
dailyReqCount | int | Request num in the current day |
monthReqCount | int | Request num in the current month |
domainStatus | int | Domain status:Success: 0; Failure: 1 |
For more information about public response parameters, see Public parameters.
Setting Smtp Password for Send Address
Description
ModifyMailAddress API is used for setting Smtp Password for Send Address
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: ModifyMailAddress. |
MailAddressId | Integer | Required | Sending mail address id |
Password | String | Required | Password |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Delete Send Address
Description
DeleteMailAddress API is used for deleting Send Address.
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: QueryMailAddressByParam. |
MailAddressId | Integer | Required | Sending mail address id |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Send mail when verifying the return address
Description
CheckReplyToMailAddress API is used for sending mail when verifying the return address.
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: CheckReplyToMailAddress. |
MailAddressId | Integer | Required | Sending mail address id |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Verify the return address
Description
ApproveReplyMailAddress API is used for verifying the return address.
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: ApproveReplyMailAddress. |
Ticket | String | Required | address ticket |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Setting Notification Address for Sending Address-Not available now
Description
UpdateMailAddressMsgCallBackUrl API is used for setting Notification Address for Sending Address
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: UpdateMailAddressMsgCallBackUrl. |
MailFrom | String | Required | Sending mail address |
NotifyUrl | String | Required | Notification URL; http web hook or mns region |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Error codes
Error code | HTTP status code | Meaning |
|---|---|---|
InvalidMailAddressName.Malformed | 400 (Bad Request) | The specified mailAddress accountName is wrongly formed. |
InvalidNotifyUrl.Malformed | 400 (Bad Request) | The specified notifyUrl is wrongly formed. |
Get the notification address of the sending address-Not available now
Description
GetMailAddressMsgCallBackUrl API is used for getting the notification address of the sending address
Request parameters
Name | Type | Required? | Description |
|---|---|---|---|
Action | String | Required | API name, a system required parameter. Value: GetMailAddressMsgCallBackUrl. |
MailFrom | String | Required | Sending mail address |
For other request parameters, see Public parameters.
Response parameters
Name | Type | Description |
|---|---|---|
notifyUrlStatus | Integer | Notify address status; 0 closes, 1 opens |
notifyUrl | String | Notification address |
For more information about public response parameters, see Public parameters.
Error codes
Error code | HTTP status code | Meaning |
|---|---|---|
InvalidMailAddressName.Malformed | 400 (Bad Request) | The specified mailAddress accountName is wrongly formed. |