cow_cookie:setcookie(3)

Name

cow_cookie:setcookie - Generate a set-cookie header

Description

setcookie(Name  :: iodata(),
          Value :: iodata(),
          Opts  :: cow_cookie:cookie_opts())
    -> iolist()

Generate a set-cookie header.

Note that this function expects the Name, Value arguments as well as the domain or path options to be safe, meaning they do not contain invalid characters according to RFC6265 section 4.1.1.

Arguments

Name

Cookie name.

Value

Cookie value.

Opts

Options added to the set-cookie header as attributes.

Return value

An iolist with the generated set-cookie header value.

Changelog

  • 2.12: The Version attribute is no longer generated.
  • 1.0: Function introduced.

Examples

Generate a set-cookie header
SetCookie = cow_cookie:setcookie(<<"sessionid">>, ID, #{
    http_only => true,
    secure    => true
}).

See also

cow_cookie(3), cow_cookie:parse_cookie(3), cow_cookie:parse_set_cookie(3), cow_cookie:cookie(3)

Cowlib 2.20 Function Reference

Navigation

Version select

Sponsor me!

Support my work on Cowboy, Ranch, Gun and Erlang.mk via GitHub Sponsors. The funds cover domain names and development tools.