全部产品
云市场

Java SDK 手册

更新时间:2019-08-14 10:22:12

创建 Access Key

  1. 登录 Access Key 管理控制台
  2. 单击页面右上角按钮 创建 Access Key,弹出创建对话框。
  3. 阅读《API使用规范》后,单击 同意并创建

(注:也可以使用阿里云访问控制服务创建的 Access Key。)

安装 Java SDK

开发环境

阿里云 Java SDK 支持 J2SE Development Kit (JDK) 1.6 或以上版本。

SDK 下载

SDK 安装

手动安装

  1. 在解压的文件中可以找到 aliyun-java-sdk-dm-3.0.0-rc1.jar 和 aliyun-java-sdk-core-3.0.0.jar 包。
  2. 以 Eclipse 导入 JAR 包为例:在 Eclipse 上右键点击 Project,再单击 Properties > Java Build Path > Libraries > Add External JARs(netbeans 和 intellij 等其他 idea 用户请自行按照相应导入 JAR 包的方法导入)。
  3. 选择以上 JAR 包,点击 OK 按钮。

经过以上步骤,你就可以在工程中使用阿里云 Java SDK 了。

通过 maven 进行安装

  1. 添加 maven 库
    1. <repositories>
    2. <repository>
    3. <id>sonatype-nexus-staging</id>
    4. <name>Sonatype Nexus Staging</name>
    5. <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    6. <releases>
    7. <enabled>true</enabled>
    8. </releases>
    9. <snapshots>
    10. <enabled>true</enabled>
    11. </snapshots>
    12. </repository>
    13. </repositories>
  2. 添加 JAR 包
    1. <dependencies>
    2. <dependency>
    3. <groupId>com.aliyun</groupId>
    4. <artifactId>aliyun-java-sdk-core</artifactId>
    5. <version>3.0.0</version>
    6. </dependency>
    7. <dependency>
    8. <groupId>com.aliyun</groupId>
    9. <artifactId>aliyun-java-sdk-dm</artifactId>
    10. <version>3.1.0</version>
    11. </dependency>
    12. <dependencies>

发送邮件示例

调用单一发信 API 示例 (如何调用此接口,请参见 SingleSendMail ):

  1. import com.aliyuncs.DefaultAcsClient;
  2. import com.aliyuncs.IAcsClient;
  3. import com.aliyuncs.dm.model.v20151123.SingleSendMailRequest;
  4. import com.aliyuncs.dm.model.v20151123.SingleSendMailResponse;
  5. import com.aliyuncs.exceptions.ClientException;
  6. import com.aliyuncs.exceptions.ServerException;
  7. import com.aliyuncs.profile.DefaultProfile;
  8. import com.aliyuncs.profile.IClientProfile;
  9. //import com.aliyuncs.http.MethodType;
  10. public void sample() {
  11. // 如果是除杭州region外的其它region(如新加坡、澳洲Region),需要将下面的"cn-hangzhou"替换为"ap-southeast-1"、或"ap-southeast-2"。
  12. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<your accessKey>", "<your accessSecret>");
  13. // 如果是除杭州region外的其它region(如新加坡region), 需要做如下处理
  14. //try {
  15. //DefaultProfile.addEndpoint("dm.ap-southeast-1.aliyuncs.com", "ap-southeast-1", "Dm", "dm.ap-southeast-1.aliyuncs.com");
  16. //} catch (ClientException e) {
  17. //e.printStackTrace();
  18. //}
  19. IAcsClient client = new DefaultAcsClient(profile);
  20. SingleSendMailRequest request = new SingleSendMailRequest();
  21. try {
  22. //request.setVersion("2017-06-22");// 如果是除杭州region外的其它region(如新加坡region),必须指定为2017-06-22
  23. request.setAccountName("控制台创建的发信地址");
  24. request.setFromAlias("发信人昵称");
  25. request.setAddressType(1);
  26. request.setTagName("控制台创建的标签");
  27. request.setReplyToAddress(true);
  28. request.setToAddress("目标地址");
  29. //可以给多个收件人发送邮件,收件人之间用逗号分开,批量发信建议使用BatchSendMailRequest方式
  30. //request.setToAddress("邮箱1,邮箱2");
  31. request.setSubject("邮件主题");
  32. request.setHtmlBody("邮件正文");
  33. //开启需要备案,0关闭,1开启
  34. //request.setClickTrace("0");
  35. //如果调用成功,正常返回httpResponse;如果调用失败则抛出异常,需要在异常中捕获错误异常码;错误异常码请参考对应的API文档;
  36. SingleSendMailResponse httpResponse = client.getAcsResponse(request);
  37. } catch (ServerException e) {
  38. //捕获错误异常码
  39. System.out.println("ErrCode : " + e.getErrCode());
  40. e.printStackTrace();
  41. }
  42. catch (ClientException e) {
  43. //捕获错误异常码
  44. System.out.println("ErrCode : " + e.getErrCode());
  45. e.printStackTrace();
  46. }
  47. }

单击 这里 获取更多 Java SDK 的使用提示。

另调用模板批量发信请使用BatchSendMailRequest,相关修改

  1. request.setTemplateName("test模板");
  2. request.setReceiversName("测试-test");

其中“test模板”为模板名称;“测试-test”为收件人列表名称。

错误码传送门,其他错误码请参考对应API文档