@alicloud/dm20151123 1.8.2 → 1.9.0

package/src/models/SingleSendMailShrinkRequest.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SingleSendMailShrinkRequestAttachments extends $dara.Model {
+  /**
+   * @remarks
+   * This feature is available only in the latest SDK. It is not supported by OpenAPI or signature mechanisms.
+   * 
+   * @example
+   * test.txt
+   */
   attachmentName?: string;
+  /**
+   * @remarks
+   * This feature is available only in the latest SDK. It is not supported by OpenAPI or signature mechanisms.
+   * 
+   * @example
+   * C:\\Users\\Downloads\\test.txt
+   */
   attachmentUrl?: string;
   static names(): { [key: string]: string } {
     return {
@@ -31,16 +45,43 @@ export class SingleSendMailShrinkRequestAttachments extends $dara.Model {
 export class SingleSendMailShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The sender address configured in the Direct Mail console.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test***@example.net
    */
   accountName?: string;
   /**
    * @remarks
+   * The address type. Valid values:
+   * 
+   * 0: Random account
+   * 
+   * 1: Sender address
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 1
    */
   addressType?: number;
+  /**
+   * @remarks
+   * This feature is available only in the latest software development kit (SDK). It is not supported by OpenAPI or signature mechanisms. For more information, see [How do I send an email with attachments using an SDK?]().
+   */
   attachments?: SingleSendMailShrinkRequestAttachments[];
   /**
+   * @remarks
+   * - The list of blind carbon copy (BCC) recipients.
+   * 
+   * - A copy of the email is sent to each BCC address. The BCC information is not visible to any recipient, including those in the ToAddress and BccAddress fields.
+   * 
+   * - To protect the privacy of BCC recipients, email tracking is disabled by default for emails sent to BCC addresses. This means that behavioral data, such as open rates and click-through rates, is not recorded for BCC emails. However, billing, sending details, and sending status statistics are the same as for regular emails.
+   * 
+   * - You can specify up to two BCC recipients for each email.
+   * 
    * @example
    * 1@example.com,2@example.com
    * 
@@ -48,36 +89,221 @@ export class SingleSendMailShrinkRequest extends $dara.Model {
    * true
    */
   bccAddress?: string;
+  /**
+   * @remarks
+   * 1: Enables data tracking.
+   * 
+   * 0 (default): Disables data tracking.
+   * 
+   * @example
+   * 0
+   */
   clickTrace?: string;
+  /**
+   * @remarks
+   * Enable domain-level authentication.
+   * 
+   * - true
+   * 
+   * - false
+   * 
+   * Use this only for domain-level authentication. Ignore it for sender address-level authentication.
+   * 
+   * 1\\. Create the \\`domain-auth-created-by-system\\@example.com\\` address in the console. Keep the prefix before the at sign (@) fixed and use your own domain as the suffix.
+   * 
+   * 2\\.
+   * 
+   * **API scenario**
+   * 
+   * Set \\`AccountName\\` to your domain. The recipient sees the sender as \\`domain-auth-created-by-system\\@example.com\\`.
+   * 
+   * **SMTP scenario**
+   * 
+   * a. Set the domain password using the \\`ModifyPWByDomain\\` API.
+   * 
+   * b. Authenticate using the domain and the set password. For the actual sender, pass a custom address, such as \\`user\\@example.com\\`, in the \\`mailfrom\\` field. The recipient sees the sender as \\`user\\@example.com\\`.
+   * 
+   * @example
+   * true
+   */
   domainAuth?: boolean;
+  /**
+   * @remarks
+   * The nickname of the sender. The nickname must be fewer than 15 characters.
+   * 
+   * For example, if you set the nickname to "Xiao Hong" and the sender address is test\\*\\*\\*@example.net, the recipient sees the sender as "Xiao Hong" \\<test\\*\\*\\*@example.net>.
+   * 
+   * @example
+   * 小红
+   */
   fromAlias?: string;
+  /**
+   * @remarks
+   * Message header settings
+   * 
+   * Both standard and non-standard fields must follow the syntax rules for message headers. The API supports a maximum of 10 headers in the headers field. Any headers exceeding this limit are ignored. SMTP, however, does not have this limit.
+   * 
+   * 1\\. Standard fields
+   * 
+   * Message-ID, List-Unsubscribe, List-Unsubscribe-Post
+   * 
+   * Standard fields overwrite existing values in the message header.
+   * 
+   * 2\\. Non-standard fields
+   * 
+   * Case-insensitive
+   * 
+   * a. Fields that start with X-User- (These are not pushed to the EventBridge event bus or Message Service MNS. They are required only for the API, whereas SMTP supports any custom header.)
+   * 
+   * b. Fields that start with X-User-Notify- (These are pushed to the EventBridge event bus and Message Service MNS, and are supported by both the API and SMTP.)
+   * 
+   * When pushed to EventBridge or MNS, these fields appear in the header field.
+   * 
+   * @example
+   * {
+   *       "Message-ID": "<d52ce63e-a0d5-4f95-b6a9-e1256a44f5fb@example.net>",
+   *       "X-User-UID1": "UID-1-000001",
+   *       "X-User-UID2": "UID-2-000001",
+   *       "X-User-Notify-UID1": "UID-3-000001",
+   *       "X-User-Notify-UID2": "UID-4-000001"
+   * 	  
+   * }
+   */
   headers?: string;
+  /**
+   * @remarks
+   * The HTML body of the email.
+   * 
+   * Note: Specify HtmlBody or TextBody.
+   * 
+   * - The size of the parameter passed in a URL is limited to approximately 80 KB.
+   * 
+   * - The new SDK limits the body parameter to approximately 8 MB (Java 1.4.0 and later, Python 3 1.4.0 and later, PHP 1.4.0 and later).
+   * 
+   * @example
+   * body
+   */
   htmlBody?: string;
+  /**
+   * @remarks
+   * The ID of the dedicated IP address pool. If you purchased dedicated IP addresses, use this parameter to specify the outbound IP address for the current email. For more information, see [Dedicated IPs]().
+   * 
+   * @example
+   * e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
+   */
   ipPoolId?: string;
   ownerId?: number;
+  /**
+   * @remarks
+   * The reply-to address.
+   * 
+   * @example
+   * test2***@example.net
+   */
   replyAddress?: string;
+  /**
+   * @remarks
+   * The nickname of the reply-to address.
+   * 
+   * @example
+   * 小红
+   */
   replyAddressAlias?: string;
   /**
    * @remarks
+   * Specifies whether to use the reply-to address configured in the console. The reply-to address must be verified. Valid values: true and false.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * true
    */
   replyToAddress?: boolean;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
+   * The subject of the email. The subject cannot exceed 256 characters in length.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * Subject
    */
   subject?: string;
+  /**
+   * @remarks
+   * The email tag that you create in the Direct Mail console. Use tags to classify email batches and query the sending status of each batch. If email tracking is enabled, you must specify an email tag.
+   * The tag can be 1 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-).
+   * 
+   * @example
+   * test
+   */
   tagName?: string;
+  /**
+   * @remarks
+   * The template information for sending template-based emails.
+   */
   templateShrink?: string;
+  /**
+   * @remarks
+   * The text body of the email.
+   * 
+   * Note: Specify HtmlBody or TextBody.
+   * 
+   * - The size of the parameter passed in a URL is limited to approximately 80 KB.
+   * 
+   * - The new SDK limits the body parameter to approximately 8 MB (Java 1.4.0 and later, Python 3 1.4.0 and later, PHP 1.4.0 and later).
+   * 
+   * @example
+   * body
+   */
   textBody?: string;
   /**
    * @remarks
+   * The destination address. To specify multiple addresses, separate them with commas (,). You can specify a maximum of 100 addresses. Recipient groups are supported.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test1***@example.net
    */
   toAddress?: string;
+  /**
+   * @remarks
+   * The filtering level. For more information, see [Unsubscribe link generation and filtering mechanism]().
+   * 
+   * disabled: No filtering.
+   * 
+   * default: The default policy is used. Batch addresses are filtered at the sender address level.
+   * 
+   * mailfrom: Filters at the sender address level.
+   * 
+   * mailfrom_domain: Filters at the email domain level.
+   * 
+   * edm_id: Filters at the account level.
+   * 
+   * @example
+   * mailfrom_domain
+   */
   unSubscribeFilterLevel?: string;
+  /**
+   * @remarks
+   * disabled: No link is generated.
+   * 
+   * default: The default policy is used. An unsubscribe link is generated for batch emails sent to specific domains, such as domains that contain keywords like "gmail", "yahoo",
+   * "google", "aol.com", "hotmail",
+   * "outlook", or "ymail.com". For more information, see [Unsubscribe link generation and filtering mechanism]().
+   * 
+   * The display language is automatically detected based on the recipient\\"s browser settings.
+   * 
+   * "outlook", or "ymail.com". For more information, see [Unsubscribe link generation and filtering mechanism]().
+   * 
+   * The display language is automatically detected based on the recipient\\"s browser settings.
+   * 
+   * @example
+   * default
+   */
   unSubscribeLinkType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UnblockSendingRequest.ts

@@ -5,19 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class UnblockSendingRequest extends $dara.Model {
   /**
    * @remarks
-   * Blacklisted recipient\\"s email address
+   * The blacklisted recipient address.
    * 
    * This parameter is required.
    * 
    * @example
-   * recipient@example.com
+   * recipient@yyy.com
    */
   blockEmail?: string;
   /**
    * @remarks
-   * Blacklist type
+   * The blacklist type.
+   * 
    * - UNSUB: Unsubscribe
-   * - REPORT: Report
+   * 
+   * - REPORT: Complaint
    * 
    * This parameter is required.
    * 
@@ -27,12 +29,12 @@ export class UnblockSendingRequest extends $dara.Model {
   blockType?: string;
   /**
    * @remarks
-   * Sender\\"s email address
+   * The sender address.
    * 
    * This parameter is required.
    * 
    * @example
-   * sender@example.com
+   * sender@xxx.com
    */
   senderEmail?: string;
   static names(): { [key: string]: string } {

package/src/models/UnblockSendingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UnblockSendingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 10A1AD70-E48E-476D-98D9-39BD92193837

package/src/models/UpdateUserRequest.ts

@@ -3,13 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateUserRequestUser extends $dara.Model {
-  /**
-   * @remarks
-   * Whether EventBridge is enabled
-   * 
-   * @example
-   * true
-   */
   enableEventbridge?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -33,10 +26,6 @@ export class UpdateUserRequestUser extends $dara.Model {
 }
 
 export class UpdateUserRequest extends $dara.Model {
-  /**
-   * @remarks
-   * User Information
-   */
   user?: UpdateUserRequestUser;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateUserResponseBody.ts

@@ -3,13 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateUserResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * Id of the request
-   * 
-   * @example
-   * 7BC346F6-1092-5852-B6E2-CCE2E5AAE51F
-   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateUserShrinkRequest.ts

@@ -3,10 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateUserShrinkRequest extends $dara.Model {
-  /**
-   * @remarks
-   * User Information
-   */
   userShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ValidateEmailRequest.ts

@@ -3,9 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ValidateEmailRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to check the graylist. The default value is false. The result is sent through an asynchronous notification message from EventBridge.
+   * 
+   * @example
+   * true
+   */
   checkGraylist?: boolean;
   /**
    * @remarks
+   * The email address to validate.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +22,9 @@ export class ValidateEmailRequest extends $dara.Model {
    */
   email?: string;
   /**
+   * @remarks
+   * The timeout period. The default value is 60 seconds.
+   * 
    * @example
    * 20
    */

package/src/models/ValidateEmailResponseBody.ts

@@ -4,32 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class ValidateEmailResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The domain part of the email address parsed from the syntax check. The domain part is converted to lowercase.
+   * 
    * @example
    * yyy.com
    */
   domainPart?: string;
   /**
+   * @remarks
+   * Indicates whether the address is from a free email service.
+   * 
    * @example
    * true
    */
   isFreeMail?: boolean;
   /**
+   * @remarks
+   * The local part of the email address parsed from the syntax check. The local part is converted to lowercase and the content after the plus sign (+) is removed.
+   * 
    * @example
    * xxx
    */
   localPart?: string;
   /**
+   * @remarks
+   * The email service provider of the address.
+   * 
    * @example
    * Gmail
    */
   provider?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxxx-xxxx-xxxx-xxxx
    */
   requestId?: string;
   /**
    * @remarks
+   * The validation status of the email address.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,6 +55,8 @@ export class ValidateEmailResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
+   * The detailed validation status of the email address. This provides more information about the Status.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/model.ts

@@ -173,6 +173,10 @@ export { GetIpProtectionResponse } from './GetIpProtectionResponse';
 export { GetIpfilterListRequest } from './GetIpfilterListRequest';
 export { GetIpfilterListResponseBody } from './GetIpfilterListResponseBody';
 export { GetIpfilterListResponse } from './GetIpfilterListResponse';
+export { GetSendifyAutoLoginURLResponseBody } from './GetSendifyAutoLoginUrlresponseBody';
+export { GetSendifyAutoLoginURLResponse } from './GetSendifyAutoLoginUrlresponse';
+export { GetSendifyInfoResponseBody } from './GetSendifyInfoResponseBody';
+export { GetSendifyInfoResponse } from './GetSendifyInfoResponse';
 export { GetSuppressionListLevelRequest } from './GetSuppressionListLevelRequest';
 export { GetSuppressionListLevelResponseBody } from './GetSuppressionListLevelResponseBody';
 export { GetSuppressionListLevelResponse } from './GetSuppressionListLevelResponse';
@@ -210,6 +214,8 @@ export { ModifyPWByDomainResponse } from './ModifyPwbyDomainResponse';
 export { ModifyTagRequest } from './ModifyTagRequest';
 export { ModifyTagResponseBody } from './ModifyTagResponseBody';
 export { ModifyTagResponse } from './ModifyTagResponse';
+export { OpenSendifyTrialServiceResponseBody } from './OpenSendifyTrialServiceResponseBody';
+export { OpenSendifyTrialServiceResponse } from './OpenSendifyTrialServiceResponse';
 export { QueryDomainByParamRequest } from './QueryDomainByParamRequest';
 export { QueryDomainByParamResponseBody } from './QueryDomainByParamResponseBody';
 export { QueryDomainByParamResponse } from './QueryDomainByParamResponse';