jointrashposs/content/ja/.docs-legacy/api/endpoints/email-address/available.json5
2023-07-11 23:48:17 +09:00

44 lines
1.1 KiB
Plaintext

{
summary: 'メールアドレスが利用可能か確認します。',
description: 'メールアドレスが利用可能か確認します。',
tags: [
'users',
],
requireCredential: false,
req: {
type: 'object',
properties: {
emailAddress: {
type: 'string',
description: 'メールアドレス。'
},
},
required: [
'emailAddress',
],
},
res: {
type: 'object',
optional: false,
nullable: false,
properties: {
available: {
type: 'boolean',
optional: false,
nullable: false,
description: 'メールアドレスが利用可能であればtrueです。',
},
reason: {
type: 'string',
optional: false,
nullable: true,
description: '利用可能でない場合の理由。以下のいずれかの値が入ります。used: 同じメールアドレスを使っている他のユーザーがすでに存在します。format: フォーマットが不正です。disposable: 使い捨てメールアドレスです。mx: DNSのMXレコードが存在しません。利用可能であればnullが返されます。',
},
},
required: [
'available',
'reason',
],
},
errors: {},
}