Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Mail

Catalyst Mailを使用すると、Catalystアプリケーションからエンドユーザーにメールを送信するために使用するビジネスのメールアドレスを追加できます。パブリックドメインまたは組織独自のドメインのメールアドレスを設定できます。また、Catalyst組み込みのメールクライアントの代わりに、任意の外部メールクライアントを使用し、そのSMTP設定をCatalystで構成することもできます。これらの設定はコンソールから実行できます。

メールの送信

説明

このAPIを使用すると、Catalystアプリケーションから検証済みのメールアドレスを使用して、指定した受信者にメールを送信できます。

Catalystでは、1回のメール送信操作で、複数のメールアドレスを受信者、CC、BCC、および返信先として設定できます。また、メールにファイルを添付することもできます。1回のメール送信操作でのメール受信者とファイル添付のサポートされる上限は以下のとおりです:

  • Toアドレス: 10
  • CC: 10
  • BCC: 5
  • 返信先: 5
  • ファイル添付数: 5
  • ファイル添付サイズ: 15 MB(1つのファイルまたは最大5ファイルの複数ファイル)

送信者と受信者のメールアドレス、件名、内容、およびメールの添付ファイルをAPIリクエストのform-dataとして渡す必要があります。form-dataとして渡すキーとサンプル値は、以下の「Form-Dataプロパティ」セクションで説明されています。

注意: メールを送信するには、Catalystコンソールで送信者のメールアドレスを設定および検証しておく必要があります。送信者のメールがプライベートドメインでホストされている場合、またはサードパーティのメールクライアントを使用する場合は、メールを送信する前にそれらを設定する必要があります。

リクエスト詳細

リクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/email/send

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有のドメイン

project_id
Numerical
プロジェクトの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.email.CREATE

Form-Dataプロパティ

from_email
mandatory
Catalyst Mailで設定された送信者のメールアドレス
to_email
atleast one recipient mandatory
受信者のメールアドレス
cc
optional
カーボンコピー(CC)するメールアドレス
bcc
optional
ブラインドカーボンコピー(BCC)するメールアドレス
reply_to
optional
返信先のメールアドレス
attachments
optional
メールに添付するファイル
subject
mandatory
メールの件名
content
optional
メールの本文。html_modeを「True」に設定することで、HTML形式でコンテンツを渡すことができます。
html_mode
optional
メールのコンテンツがHTML形式かどうかを指定します。値としてtrueまたはfalseを渡す必要があります。値がfalseの場合、メールのコンテンツは通常のテキスト形式になります。
display_name
optional
送信者の表示名

レスポンス詳細

レスポンスには、送信されたメールのステータス、プロジェクト詳細、from_email、to_email、およびcontentなど、送信されたメールの詳細が返されます。

リクエスト例
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/email/send
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW” \

-F from_email=emma@zylker.com \ -F to_email=vanessa.hyde@zoho.com,r.owens@zoho.com,chang.lee@zoho.com
-F cc=p.boyle@zylker.com,robert.plant@zylker.com
-F bcc=ham.gunn@zylker.com,rover.jenkins@zylker.com
-F reply_to=peter.d@zoho.com,arnold.h@zoho.com
-F attachments=kycform.pdf
-F subject=“Greetings from Zylker Corp!”
-F content="

Hello,

We’re glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address. We cannot wait to get started!

Cheers!

Team Zylker

"
-F html_mode=true
-F display_name=“Amelia Burrows” \

レスポンス例
copy
{
  "status": "success",
  "data": {
    "isAsync": false,
    "project_details": {
      "project_name": "Onboarding",
      "id": 2648000000235047,
      "project_type": "Live"
    },
    "display_name": "Amelia Burrows",
    "from_email": "emma@zylker.com",
    "to_email": [
      "vanessa.hyde@zoho.com", 
      "r.owens@zoho.com", 
      "chang.lee@zoho.com"
    ],
    "cc": [
      "p.boyle@zylker.com", 
      "robert.plant@zylker.com"
    ],
    "bcc": [
      "ham.gunn@zylker.com", 
      "rover.jenkins@zylker.com"
    ],
    "html_mode": true,
    "subject": "Greetings from Zylker Corp!",
    "content": "<p>Hello,</p><p>We're glad to welcome you at Zylker Corp. To begin your journey with us, please download thattached KYC form and fill in your details. You can send us the completed form to this same email address. We cannowait to get started!<p>Cheers!</p><p>Team Zylker </p>",
    "reply_to": [
      "peter.d@zoho.com", 
      "arnold.h@zoho.com"
    ]
  }
}