mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
[ci skip] fix description of url_for
This commit is contained in:
parent
b5242b6f95
commit
c15d3fb0da
2 changed files with 1 additions and 18 deletions
|
@ -132,11 +132,6 @@ module ActionMailer
|
|||
#
|
||||
# config.action_mailer.default_url_options = { host: "example.com" }
|
||||
#
|
||||
# When you decide to set a default <tt>:host</tt> for your mailers, then you need to make sure to use the
|
||||
# <tt>only_path: false</tt> option when using <tt>url_for</tt>. Since the <tt>url_for</tt> view helper
|
||||
# will generate relative URLs by default when a <tt>:host</tt> option isn't explicitly provided, passing
|
||||
# <tt>only_path: false</tt> will ensure that absolute URLs are generated.
|
||||
#
|
||||
# = Sending mail
|
||||
#
|
||||
# Once a mailer action and template are defined, you can deliver your message or create it and save it
|
||||
|
|
|
@ -470,16 +470,7 @@ By using the full URL, your links will now work in your emails.
|
|||
|
||||
#### generating URLs with `url_for`
|
||||
|
||||
You need to pass the `only_path: false` option when using `url_for`. This will
|
||||
ensure that absolute URLs are generated because the `url_for` view helper will,
|
||||
by default, generate relative URLs when a `:host` option isn't explicitly
|
||||
provided.
|
||||
|
||||
```erb
|
||||
<%= url_for(controller: 'welcome',
|
||||
action: 'greeting',
|
||||
only_path: false) %>
|
||||
```
|
||||
`url_for` generate full URL by default in templates.
|
||||
|
||||
If you did not configure the `:host` option globally make sure to pass it to
|
||||
`url_for`.
|
||||
|
@ -491,9 +482,6 @@ If you did not configure the `:host` option globally make sure to pass it to
|
|||
action: 'greeting') %>
|
||||
```
|
||||
|
||||
NOTE: When you explicitly pass the `:host` Rails will always generate absolute
|
||||
URLs, so there is no need to pass `only_path: false`.
|
||||
|
||||
#### generating URLs with named routes
|
||||
|
||||
Email clients have no web context and so paths have no base URL to form complete
|
||||
|
|
Loading…
Reference in a new issue