メール送信

    メールを送信します。

    注意

    • メールの件名は最大 100 文字です。101 字以上入力した場合、超過分は無視されます。
    • 送信時はメールアドレス形式のみを確認し、有効なアドレスか否か(メールの受信可否、実在するか、など)は確認しません。
    • 無効なメールアドレスの場合、送信者に[送信失敗]メールが送られます。
    • 添付ファイルに拡張子制限の対象もしくはマルウェアを含むファイルが含まれている場合、送信に失敗します。
    • 拡張子制限もしくはマルウェアを含むファイルを添付ファイルとしてアップロードした場合、ファイル名と FILE_UPLOAD_REJECT_VIRUS または FILE_UPLOAD_BLOCKED エラーを返します。
    • 添付ファイルの最大容量は管理者設定に従います。
    • 大容量添付には対応していません。指定容量を超えるファイルを添付した場合、SYSTEM_ERROR を返します。

    API の種類

    サービス API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/mail/v2/sendMail

    HTTP Method

    POST(Content-Type: multipart/form-data; boundary="$boundary”; charset=UTF-8)

    Request

    パラメータ タイプ 必須 説明
    userName String N 送信者名
    to String Y 宛先のメールアドレス(';'で区分)
    例) admin@example.com; admin1@example.com
    cc String N CCメールアドレス(';'で区分)
    例) admin@example.com; admin1@example.com
    bcc String N BCCメールアドレス(';'で区分)
    例) admin@example.com; admin1@example.com
    subject String Y 件名
    最大 100 文字まで。101 文字以上は無視されます。
    text String N メール内容
    contentType String N メール本文の形式
    ● html(既定値)
    ● text
    saveSentMail String N 送信済みメールフォルダへの保存有無
    ● true(既定値)
    ● false
    sendSeparately String N 個別送信
    ● true
    ● false(既定値)
    添付ファイル名 Multipart N UTF-8でエンコードした添付ファイル名
    • 「添付ファイル名」は、メール送信時にアップロードするファイル名を意味します。 例)添付ファイル名がfile.txtの場合、パラメータ名にfile.txtを指定します。
    • メール本文の形式によって改行文字が異なります。HTML形式では「
      」タグを使用します。TEXT形式では、Java 等の場合は「\r\n」(Carriage Return and Line Feed)、web アプリから text や textarea にメール本文を渡す場合には Enter(改行)を使用します。

    Response

    API呼び出しに成功するとHTTP Status コード 200 を返し、応答内容は JSON 形式で返します。

    プロパティ タイプ 必須 説明
    smtpFailList List Y SMTP エラーで送信に失敗したメールアドレスのリスト
    例) nvmail051@example.com, nvmail052@example.com
    successList List Y 送信に成功したメールアドレスのリスト
    例) nvmail051@example.com, nvmail052@example.com
    dupAddrList List Y 同じアドレスが複数含まれていた場合、重複したメールアドレスのリスト(エラーではない)
    例) nvmail051@example.com, nvmail052@example.com
    dormantAddrList List Y 休眠メールアドレスのリスト
    例) nvmail051@example.com, nvmail052@example.com
    noneExistenceAddrList List Y 存在しないメールアドレスのリスト
    例) nvmail051@example.com, nvmail052@example.com
    wrongAddrList List Y 不正なメールアドレスのリスト
    例) nvmail051@example.com, nvmail052@example.com

    Response Example

    {
        "returnCode": 0,
        "successList": ["nvmail051@example.com", "nvmail052@example.com"],
        "wrongAddrList": [],
        "noneExistenceAddrList": [],
        "smtpFailList": [],
        "returnMessage": 0,
        "dormantAddrList": [],
        "dupAddrList": []
    }
    

    Error

    呼び出しに失敗すると、HTTP Status と以下のエラー情報を返します。

    プロパティ タイプ 説明
    code String Error Code
    message String Error Message
    Http Status Error Code 説明
    400 INVALID_PARAMETER リクエスト値が不適切
    500 SYSTEM_ERROR 内部サーバーエラー
    Error Example
    {
        "code": "INVALID_PARAMETER",
        "message": "FILE_UPLOAD_REJECT_VIRUS : virus.exe",
        "domain": "mail"
    }