本ブログシリーズは、「Docusign eSignature APIでできること」と題しまして、シンプルながらも有用なAPIタスクについてご紹介するシリーズです。このシリーズでは、Docusign API開発者にとって有用な情報をコード例とともに解説していきます。

シリーズ第1回目では、エンベロープを送信するとすべての受信者に届く通知メールの件名とメッセージ本文をカスタマイズする方法について見ていきましょう。また、件名とメッセージ本文をエンベロープの受信者ごとにカスタマイズする方法もご説明します。

ご存じのとおり、エンベロープの受信者全員に送信される、通知メールの件名とメッセージ本文は、必要に応じて変更することができます。これは、EnvelopeDefinitionオブジェクトで、次のように実行します。

C#

// エンベロープを定義する EnvelopeDefinition env = new EnvelopeDefinition(); env.EmailSubject = "メール件名"; env.EmailBlurb = "メッセージ本文";

Java

// エンベロープを定義する EnvelopeDefinition env = new EnvelopeDefinition(); env.setEmailSubject("メール件名"); env.setEmailBlurb("メッセージ本文");

PHP

# エンベロープを定義する $env = new \Docusign\eSign\Model\EnvelopeDefinition([     'email_subject' => 'メール件名',     'email_blurb' => 'メッセージ本文']);

Node.js

// エンベロープを定義する let env = new docusign.EnvelopeDefinition(); env.emailSubject = 'メール件名'; env.emailBlurb = 'メッセージ本文';

Ruby

# エンベロープを定義する env = DocuSign_eSign::EnvelopeDefinition.new env.email_subject = 'メール件名' env.email_blurb = 'メッセージ本文'

Python

# エンベロープを定義する env = EnvelopeDefinition(     email_subject = 'メール件名',     email_blurb = 'メッセージ本文')

さらに、Docusign eSignature APIでは、受信者ごとにメール件名とメッセージ本文をカスタマイズすることもできます。

エンベロープに受信者を追加する際、各受信者にRecipientEmailNotificationオブジェクトを含めます。このオブジェクトに、EmailSubjectとEmailBodyのプロパティを含め、受信者ごとにメール件名とメッセージ本文をカスタマイズします。（EmailBodyおよびEmailBlurbは、通知メールに表示する追加のテキストであり、通知メール本文全体を指すものではありません。）

C#

// 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する // EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める Signer signer1 = new Signer {     Email = "jiro.yamada@mail.com",     Name = "山田二郎",     RecipientId = "1",     RoutingOrder = "1",     EmailNotification = new RecipientEmailNotification {     EmailSubject = "この受信者にカスタマイズしたメール件名",     EmailBody = "この受信者にカスタマイズしたメッセージ本文" } };

Java

// 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する // EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める Signer signer1 = new Signer (); signer1.setEmail("jiro.yamada@mail.com"); signer1.setName("山田二郎"); signer1.setRecipientId("1"); signer1.setRoutingOrder("1"); RecipientEmailNotification ren = new RecipientEmailNotification(); ren.setEmailSubject("この受信者にカスタマイズしたメール件名"); ren.setEmailBody("この受信者にカスタマイズしたメッセージ本文"); signer1.setEmailNotification(ren);

PHP

# 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する

EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める

$signer1 = new \Docusign\eSign\Model\Signer([ 'email' => 'jiro.yamada@mail.com', 'name' => '山田二郎', 'recipient_id' => '1', 'routing_order' => '1', 'email_notification' => new \Docusign\eSign\Model\RecipientEmailNotification([ 'email_subject' => 'この受信者にカスタマイズしたメール件名', 'email_body' => 'この受信者にカスタマイズしたメッセージ本文']) ]);

Node.js

// 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する // EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める let signer1 = docusign.Signer.constructFromObject( { email : 'jiro.yamada@mail.com', name : '山田二郎', recipientId : '1', routingOrder : '1', emailNotification = docusign.RecipientEmailNotification.constructFromObject ( { emailSubject : 'この受信者にカスタマイズしたメール件名', emailBody : 'この受信者にカスタマイズしたメッセージ本文' }) });

Ruby

# 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する

EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める

signer1 = DocuSign_eSign::Signer.new signer1.email = 'jiro.yamada@mail.com' signer1.name = '山田二郎' signer1.recipient_id = '1' signer1.routing_order = '1' ren = DocuSign_eSign::RecipientEmailNotification.new ren.email_subject = 'この受信者にカスタマイズしたメール件名' ren.email_body = 'この受信者にカスタマイズしたメッセージ本文' signer1.email_notification = ren

Python

# 文書に署名をするSigner受信者を作成し、名前とメールアドレスを追加する

EmailNotificationオブジェクトを追加し、カスタマイズしたメール件名とメッセージを含める

signer1 = Signer( email = 'jiro.yamada@mail.com', name = '山田二郎', recipient_id = '1', routing_order = '1', email_notification = RecipientEmailNotification( email_subject = 'この受信者にカスタマイズしたメール件名', email_body = 'この受信者にカスタマイズしたメッセージ本文') )

複数の受信者が存在する場合は、上記のコードを使用して受信者ごとにメール件名とメッセージをカスタマイズします。メール件名とメッセージが指定されていない受信者には、デフォルトで設定されている件名とメッセージが適用されるため、デフォルトの件名とメッセージを使用する場合は、特に指定する必要はありません。

次回は、eSignature APIを使用してエンベロープデータを取得する方法についてご紹介します。どうぞお楽しみに。