Box Developerドキュメント
最新バージョン

メールエイリアスを作成

post
https://api.box.com/2.0
/users/:user_id/email_aliases

新しいメールエイリアスをユーザーアカウントに追加します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ユーザーのID。

リクエスト本文

string本文内必須
"alias@example.com"

アカウントにエイリアスとして追加するメールアドレス。

注: メールエイリアスのドメインは企業に登録されている必要があります。新しいドメインを追加する手順については、ドメイン検証のガイドを参照してください。

レスポンス

新しく作成されたメールエイリアスオブジェクトを返します。

予期しないクライアントエラー。

post
メールエイリアスを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/users/12345/email_aliases" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "email": "alias@example.com"
     }'
TypeScript Gen
await client.emailAliases.createUserEmailAlias(newUser.id, {
  email: newAliasEmail,
} satisfies CreateUserEmailAliasRequestBody);
Python Gen
client.email_aliases.create_user_email_alias(new_user.id, new_alias_email)
.NET Gen
await client.EmailAliases.CreateUserEmailAliasAsync(userId: newUser.Id, requestBody: new CreateUserEmailAliasRequestBody(email: newAliasEmail));
Java
BoxUser user = new BoxUser(api, "0");
user.addEmailAlias("user+alias@example.com");
Python
user_id = '33333'
user = client.user(user_id)
email_alias = user.add_email_alias('alias@example.com')
.NET
BoxEmailAlias alias = await client.UsersManager
    .AddEmailAliasAsync(userId: "33333", email: "user+foo@example.com");
Node
client.users.addEmailAlias('33333', 'user+baz@example.com')
    .then(alias => {
        /* alias -> {
            type: 'email_alias',
            id: '12345',
            is_confirmed: false,
            email: 'user+baz@example.com' }
        */
    });
iOS
client.users.createEmailAlias(
    userId: "33333",
    email: "user+alias@example.com"
) { (result: Result<EmailAlias, BoxSDKError>) in
    guard case let .success(alias) = result else {
        print("Error adding email alias")
        return
    }

    print("Added email alias \(alias.email) — user must confirm")
}

レスポンスの例

{
  "id": "11446498",
  "type": "email_alias",
  "email": "alias@example.com",
  "is_confirmed": true
}