Email Groups

get__email_groups

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/email/groups \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/email/groups, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/email/groups,
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /email/groups

メールグループリストを取得します。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	承認トークン

応答例

[
  {
    "id": 0,
    "oid": 0,
    "gid": 0,
    "name": "string",
    "to_addr": "string",
    "cc_addr": "string",
    "bcc_addr": "string",
    "from_addr": "string",
    "reply_to_addr": "string",
    "subject_prefix": "string",
    "from_time": "00:00:00",
    "to_time": "23:59:59"
  }
]

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
anonymous	Query information ]	false	none	なし
» id	integer	false	none	メールグループID
» oid	integer	false	none	メールグループオプションID
» gid	integer	false	none	メールグループID
» name	string	false	none	メールグループ名
» to_addr	string	false	none	メールグループオプションの受信者アドレス
» cc_addr	string	false	none	メールグループオプション CCアドレス
» bcc_addr	string	false	none	メールグループオプション BCCアドレス
» from_addr	string	false	none	メールグループオプションの送信者アドレス
» reply_to_addr	string	false	none	メールグループオプションの返信先アドレス
» subject_prefix	string	false	none	メールグループオプションの件名プレフィックス
» from_time	string	false	none	メンバーの時間から選択した時間範囲までのメールグループオプション
» to_time	string	false	none	メンバーの時間範囲を選択するメールグループオプション

注釈

この操作には認証が必要ありません

post__email_groups

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/v14/email/groups \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.post(https://PEM-SERVER-IP/api/v14/email/groups, headers = headers)

print(r.json())

const inputBody = {
  "name": "string",
  "options": [
    {
      "to_addr": "string",
      "cc_addr": "string",
      "bcc_addr": "string",
      "from_addr": "string",
      "reply_to_addr": "string",
      "subject_prefix": "string",
      "from_time": "00:00:00",
      "to_time": "23:59:59"
    }
  ]
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/email/groups,
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /email/groups

新しいメールグループを追加します。

ボディパラメーター

{
  "name": "string",
  "options": [
    {
      "to_addr": "string",
      "cc_addr": "string",
      "bcc_addr": "string",
      "from_addr": "string",
      "reply_to_addr": "string",
      "subject_prefix": "string",
      "from_time": "00:00:00",
      "to_time": "23:59:59"
    }
  ]
}

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	承認トークン
body	body	EmailGroupsPostData	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	電子メールグループが正常に作成されました	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

get_email_groups{email_group_id}

コードサンプル

#  You can also use wget

curl -X GET https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id} \
  -H Accept: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Accept: application/json,
  X-Auth-Token: string
}

r = requests.get(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id}, headers = headers)

print(r.json())

const headers = {
  Accept:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id},
{
  method: GET,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /email/groups/{email_group_id}

email_group_idで識別される、メールグループの情報を取得します。

パラメーター

Name	In	Type	Required	Description
email_group_id	path	string	true	なし
X-Auth-Token	header	string	true	承認トークン

応答例

{
  "id": 0,
  "oid": 0,
  "gid": 0,
  "name": "string",
  "to_addr": "string",
  "cc_addr": "string",
  "bcc_addr": "string",
  "from_addr": "string",
  "reply_to_addr": "string",
  "subject_prefix": "string",
  "from_time": "00:00:00",
  "to_time": "23:59:59"
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ステータス200	メールグループ

注釈

この操作には認証が必要ありません

put_email_groups{email_group_id}

コードサンプル

#  You can also use wget

curl -X PUT https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id} \
  -H Content-Type: application/json \
  -H X-Auth-Token: string

import requests
headers = {
  Content-Type: application/json,
  X-Auth-Token: string
}

r = requests.put(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id}, headers = headers)

print(r.json())

const inputBody = {
  "name": "string",
  "options": {
    "added": [
      {
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "changed": [
      {
        "oid": 0,
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "deleted": [
      {
        "oid": 0
      }
    ]
  }
};
const headers = {
  Content-Type:application/json,
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id},
{
  method: PUT,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /email/groups/{email_group_id}

メールグループ情報を更新します。

ボディパラメーター

{
  "name": "string",
  "options": {
    "added": [
      {
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "changed": [
      {
        "oid": 0,
        "to_addr": "string",
        "cc_addr": "string",
        "bcc_addr": "string",
        "from_addr": "string",
        "reply_to_addr": "string",
        "subject_prefix": "string",
        "from_time": "00:00:00",
        "to_time": "23:59:59"
      }
    ],
    "deleted": [
      {
        "oid": 0
      }
    ]
  }
}

パラメーター

Name	In	Type	Required	Description
email_group_id	path	string	true	なし
X-Auth-Token	header	string	true	承認トークン
body	body	EmailGroupsPutData	true	なし

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	除外されたデータベースが正常に追加されました	None

レスポンススキーマ

注釈

この操作には認証が必要ありません

delete_email_groups{email_group_id}

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id} \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id}, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/v14/email/groups/{email_group_id},
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /email/groups/{email_group_id}

メールグループを削除します。

パラメーター

Name	In	Type	Required	Description
email_group_id	path	string	true	なし
X-Auth-Token	header	string	true	承認トークン

応答例

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	電子メールグループは正常に削除されました	None

レスポンススキーマ

注釈

この操作には認証が必要ありません