2021/08/30

MANUAL

開発者向け機能:API:メール:メール送信

## 概要 「[メール送信API](/manual/faq-sendmail-with-attachments)」を使用してメールの送信をする事ができます。 ## 対応バージョン #### Attachments 1. プリザンター 1.2.4.0 以降 1. .NET Framweork版 0.50.267 以降 ## 事前準備 APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。 ## リクエスト 下記のリクエスト形式で、jsonデータを送信します。 |設定項目|値| |:--|:--| |HTTPメソッド|POST| |Content-Type |application/json| |文字コード|UTF-8| |URL|http://{サーバー名}/api/items/{レコードID}/OutgoingMails/Send (※1)| |Body|以下のjsonデータを参考のこと| (※1){サーバー名},{レコードID}の部分は、適宜、環境に合わせて編集してください。   pleasanter.netの場合は以下の形式になります。   https\://pleasanter.net/fs/api/items/{レコードID}/OutgoingMails/Send ・jsonデータの必須項目 |項目|必須|備考| |:--|:--|:--| |ApiVersion|〇|| |ApiKey|〇|| |From|-|| |To|-|| |Cc|-|| |Bcc|-|| |Title|〇|| |Body|-|| |Attachments|-|以下のプロパティを設定してください。<br>Name : ファイル名<br>Base64 : 添付ファイルをBase64エンコードした文字列<br>ContentType : コンテンツタイプ| ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "[設定したAPIキー]", "From": "[Mail.jsonのFixedFrom値(※2)]", "To": "[受信側メールアドレス]", "Cc": "[受信側Ccメールアドレス]", "Bcc": "[受信側Bccメールアドレス]", "Title": "メール送信APIのテストです", "Body": "メール送信APIのテストでメールを飛ばしています。", "Attachments": [ { "Name": "sample1.txt", "Base64": "c2FtcGxlMS50eHQ=....", "ContentType": "text/plain" }, { "Name": "sample2.txt", "Base64": "c2FtcGxlMi50eHQ=....", "ContentType": "text/plain" } ] } ``` (※2)FixedFromについては「[Mail.json](/manual/mail.json)」をご参照下さい 。 ## レスポンス 下記の形式のjsonデータが返却され、メールが送信されます。 ##### JSON ``` { "Id": [レコードID], "StatusCode": 200, "Message": "メールを送信しました。" } ``` ## 参考(PostmanによるHTTPリクエスト送信) ![image](/binaries/d15674da65584677be71f15319dffa77) (content-typeはHeadersから設定してます。) ## エラー時の確認事項 [・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api) [・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format) ## 関連情報 <div id="ManualList"><ul><li><a href="/manual/mail.json">パラメータ設定:Mail.json</a><span>2021/05/05 up</span></li></ul></article> <ul><li><a href="/manual/faq-sendmail-with-attachments">FAQ:メール送信APIを使用して添付ファイル付きのメールを送信したい</a><span>2021/09/03 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
このページをシェアする