Skip to content

Latest commit

 

History

History
executable file
·
326 lines (249 loc) · 3.68 KB

protocols.md

File metadata and controls

executable file
·
326 lines (249 loc) · 3.68 KB
Raw

Sender (SMTP(local) -> HTTP(RESTful) -> worker -> SMTP(worker))

user api

find user

  • methods: GET
  • url: /v1/users/$USERNAME

found

{
    "stat": 200,
    "token": "",
    "data": ""
}

not found

{
    "stat": 404,
    "token": "",
    "data": ""
}

auth user

  • methods: GET
  • url: /v1/users/$USERNAME/password
  • header: "Password: $PASSWORD"

auth success

{
    "stat": 200,
    "token": "$USER_TOKEN",
    "data": ""
}

auth failed

{
    "stat": 404,
    "token": "",
    "data": ""
}

insert user

  • methods: POST
  • url: /v1/users/$USERNAME/password
  • header: "Password: $PASSWORD"
  • header: "Token: $ADMIN_TOKEN"
  • header: "Admin: 0 | 1"

insert success

{
    "stat": 200,
    "token": "",
    "data": ""
}

admin not authorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

user already exists

{
    "stat": 409,
    "token": "",
    "data": ""
}

update user

  • methods: PUT
  • url: /v1/users/$USERNAME/password
  • header: "Oldpass: $OLDPASSWORD" // can't change is_admin unless itself is an admin, not require if admin token is given
  • header: "Newpass: $NEWPASSWORD" // optional if want to change ppassword
  • header: "Token: $ADMIN_TOKEN" // can change anything if use this
  • header: "Admin: 0 | 1" // if want to change is_admin, must be a admin(token) to change this field

update success

{
    "stat": 200,
    "token": "",
    "data": ""
}

admin not authorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

auth failed

{
    "stat": 403,
    "token": "",
    "data": ""
}

delete user

  • methods: DELETE
  • url: /v1/users/$USERNAME/password
  • header: "Password: $PASSWORD" // if provided, must be true password; if not provided, token must be an admin
  • header: "Token: $ADMIN_TOKEN" // if provided, must be an admin

update success

{
    "stat": 200,
    "token": "",
    "data": ""
}

auth failed

{
    "stat": 403,
    "token": "",
    "data": ""
}

mail api

mail meta info

  • methods: GET
  • url: /v1/mail/
  • header: "Token: $USERTOKEN"

success

{
    "stat": 200,
    "token": "",
    "data": {
        "num": $mail_num,
        "size": $mail_size,
        "mails": [
            {
                "id": $mail_id,
                "size": $mail_size
            }
        ]
    }
}

unauthorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

not found

{
    "stat": 404,
    "token": "",
    "data": ""
}

get mail content

  • methods: GET
  • url: /v1/mail/$MAILID
  • header: "Token: $USERTOKEN"

success

{
    "stat": 200,
    "token": "",
    "data": {
        "id": $mail_id,
        "size": $mail_size,
        "content": $BASE64_CODED_MAIL_CONTENT
    }
}

unauthorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

not found

{
    "stat": 404,
    "token": "",
    "data": ""
}

delete mail

  • methods: DELETE
  • url: /v1/mail/$MAILID
  • header: "Token: $USERTOKEN"

unauthorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

not found

{
    "stat": 404,
    "token": "",
    "data": ""
}

send mail

  • methods: POST
  • url: /v1/mail/
  • header: "Token: $USERTOKEN"
  • body:
{
    "from": $FROM_USER_EMAIL,
    "to": $TO_USER_EMAILS[],
    "content": $BASE64_ENCODED_CONTENT
}

unauthorized

{
    "stat": 401,
    "token": "",
    "data": ""
}

not found

{
    "stat": 404,
    "token": "",
    "data": ""
}

no content

{
    "stat": 500,
    "token": "",
    "data": ""
}