Skip to content

電子メールオブジェクト

email オブジェクトを使用すると、当社のメッセージングエンドポイントを介して電子メールを変更または作成できます。

電子メールオブジェクト

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "app_id": (required, string), see App Identifier,
  "subject": (optional, string),
  "from": (required, valid email address in the format "Display Name <[email protected]>"),
  "reply_to": (optional, valid email address in the format "[email protected]" - defaults to your workspace's default reply to if not set) - use "NO_REPLY_TO" to set reply-to address to null,
  "bcc": (optional, one of the BCC addresses defined in your workspace's email settings) if provided and the BCC feature is enabled for your account, this address will get added to your outbound message as a BCC address,
  "body": (required unless email_template_id is given, valid HTML),
  "plaintext_body": (optional, valid plaintext, defaults to autogenerating plaintext from "body" when this is not set),
  "preheader": (optional*, string) recommended length 50-100 characters,
  "email_template_id": (optional, string) if provided, we will use the subject/body/should_inline_css values from the given email template UNLESS they are specified here, in which case we will override the provided template,
  "message_variation_id": (optional, string) used when providing a campaign_id to specify which message variation this message should be tracked under,
  "extras": (optional, valid Key-Value Hash) extra hash - for SendGrid users, this will be passed to SendGrid as Unique Arguments,
  "headers": (optional, valid Key-Value Hash) hash of custom extensions headers (available for SparkPost and SendGrid),
  "should_inline_css": (optional, boolean) whether to inline CSS on the body. If not provided, falls back to the default CSS inlining value for the workspace,
  "attachments": (optional, array) array of JSON objects that define the files you need attached, defined by "file_name" and "url",
    "file_name": (required, string) the name of the file you want to attach to your email, excluding the extension (for example, ".pdf"). Attach files up to 2 MB. This is required if you use "attachments",
    "url": (required, string) the corresponding URL of the file you want to attach to your email. The file name's extension will be detected automatically from the URL defined, which should return the appropriate "Content-Type" as a response header. This is required if you use "attachments",
}
  • アプリ識別子
  • プリヘッダーに関するより詳しい情報とベストプラクティスについては、email body stylingのヘルプ記事を参照してください。

有効な添付ファイルのタイプは以下の通りです：txt csv,log,css,ics,jpg,jpe,jpeg,gif,png,bmp,psd,tif,tiff,svg,indd,ai,eps,doc,docx,rtf,odt,ott,pdf,pub,pages,mobi,epub,mp3 、m4a m4v,wma,ogg,flac,wav,aif,aifc,aiff,mp4,mov,avi,mkv,mpeg,mpg,wmv,xls,xlsx,ods,numbers,odp,ppt,pptx,pps,key,zip,vcf, およびpkpass 。

email_template_id は、HTMLエディタで作成されたメールテンプレートの下部から取得できます。以下は、このIDがどのように見えるかの例である：

HTMLメールテンプレートのAPI識別子セクション]31。

添付ファイル付き電子メールオブジェクトの例

1
2
3
4
5
6
7
8
9
10
11
12

{
  "external_user_ids": ["YOUR_EXTERNAL_USER_ID"],
  "messages":{
     "email":{
        "app_id":"YOUR_APP_ID",
        "attachments":[{
            "file_name":"YourFileName",
            "url":"https://exampleurl.com/YourFileName.pdf"
         }]
     }
  }
}

電子メール添付ファイルの認証

  1. 設定]>[接続コンテンツ]に移動し、[認証情報の追加]をクリックして認証情報を追加します。
  2. 名前を入力し、ユーザー名とパスワードを追加する。
  3. /messages/send エンドポイントの電子メール・オブジェクトに、添付ファイルの詳細にクレデンシャル名を指定するbasic_auth_credential プロパティを含める。以下の例を参照のこと。クレデンシャル名はcompany_basic_auth_credential_name ：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "external_user_ids": ["recipient_user_id"],
  "messages":{
    "email":{
      "app_id": "153e8a29-fd6d-4f77-ade7-1a4ca08d457a",
      "subject": "Basis auth attachement test",
      "from": "mail <[email protected]>",
      "body": "my attachment test",
      "attachments":[
        { "file_name":"checkout_receipt.pdf",
        "url":"https://fileserver.company.com/user123-checkout_receipt.pdf",
        "basic_auth_credential": "company_basic_auth_credential_name" }
      ]
    }
  }
}
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!