ArchWiki - 利用者の投稿記録 [ja]

Msmtp

2025-06-06T07:54:29Z

Sanlun: 英語版の最新の内容に更新

{{Lowercase title}}
[[Category:メールクライアント]]
[[Category:OpenPGP]]
[[en:Msmtp]]
{{Related articles start}}
{{Related|mutt}}
{{Related|OfflineIMAP}}
{{Related|SSMTP}}
{{Related|S-nail}}
{{Related|OpenSMTPD}}
{{Related articles end}}

[http://msmtp.sourceforge.net/ msmtp] はとてもシンプルで使いやすい SMTP クライアントです。[[sendmail]] と完全な互換性があります。

==インストール==

{{Pkg|msmtp}} パッケージで[[インストール]]できます。さらに {{Pkg|msmtp-mta}} をインストールすることで msmtp に sendmail エイリアスが作成されます。

==基本設定==

msmtp バージョン 1.8.6 以降、設定ファイルを {{ic|~/.msmtprc}} か {{ic|$XDG_CONFIG_HOME/msmtp/config}} に配置することができます。以下は msmtp の設定例です (パッケージに含まれている、{{ic|/usr/share/doc/msmtp/msmtprc-user.example}} にある通常ユーザーのサンプルが基になっています。システム設定ファイルは {{ic|/etc/msmtprc}} にあり、サンプルは {{ic|/usr/share/doc/msmtp/msmtprc-system.example}} にあります):

{{Tip|Gmail を使う場合は、以下のどちらかが必要です:
* [[#OAuth2 設定]] で OAuth を使う。
* 二段階認証を使う場合は [https://myaccount.google.com/apppasswords アプリパスワードを作成します]。
}}

{{hc|~/.msmtprc|
# Set default values for all following accounts.
defaults
auth on
tls on
tls_trust_file /etc/ssl/certs/ca-certificates.crt
logfile ~/.msmtp.log

# Gmail
account gmail
host smtp.gmail.com
port 465
from ''username''@gmail.com
user ''username''
password ''plain-text-password''

# A freemail service
account freemail
host smtp.freemail.example
from joe_smith@freemail.example
...

# Accounts can inherit info from another account
account postmasterfreemail : freemail
from postmaster*@freemail.example

# Set a default account
account default : gmail
}}

{{Note|SSL/TLS を使っていて "Server sent empty reply" エラーメッセージが表示される場合、[[#Server sent empty reply]] を見て下さい。}}

ユーザーの設定ファイルは所有者が読み書きできるように明示的に設定しないと msmtp がエラーを吐きます:

$ chmod 600 ~/.msmtprc

設定ファイルに平文でパスワードを保存したくない場合、''passwordeval'' を使って外部プログラムを起動するか、あるいは下の[[#パスワード管理|パスワード管理]]セクションを見てください。以下は [[GnuPG]] を使ってパスワードを暗号化する例です:

$ echo -e "password\n" | gpg --encrypt -o .msmtp-gmail.gpg # enter id (email...)

{{Warning|ほとんどのシェルはコマンド履歴を保存します (例: {{ic|.bash_history}} や {{ic|.zhistory}})。GPG でシェルの標準入力を使いたくない場合 {{ic|gpg --encrypt -o .msmtp-gmail.gpg -r <email> -}} コマンドを使ってください。最後のダッシュは打ち間違えではなく標準入力を使うために必要な文字です。コマンドを実行したら、パスワードを入力してから Control-d を押せば GPG によってパスワードが暗号化されます。}}

{{hc|~/.msmtprc|
passwordeval "gpg --quiet --for-your-eyes-only --no-tty --decrypt ~/.msmtp-gmail.gpg"
}}

=== OAuth2 設定 ===

[[Wikipedia:OAuth2|OAuth2]] は、基本的なユーザー名/パスワード認証がサイト構成によってサポートされていない場合、または他の点で望ましくない場合に、msmtp を安全に認証するために使用できます。

{{Note|[https://superuser.com/questions/1723180/how-to-continue-using-msmtp-oauth-2-0-for-gmail-in-mutt-after-oob-deprecation この投稿] では、現在 Gmail に許可されている極めて制限されている機能について説明しています。}}

==== oama ====

msmtp だけでは OAuth2 資格情報を更新・認証することができません。包括的な解決方法は、[https://github.com/pdobsan/oama oama] ユーティリティを使うことです。これは IMAP/SMTP クライアントに OAuth2 資格情報の更新能力と認証を提供します。

oama を使うには、{{AUR|oama-bin}} を [[インストール]] し、 msmtp を設定して使用できるようにします。

# account at Google with oauth2 access
account YOUR_EMAIL_NAME@gmail.com
from YOUR_EMAIL_NAME@gmail.com
user YOUR_EMAIL_NAME@gmail.com
auth oauthbearer
passwordeval oama access YOUR_EMAIL_NAME@gmail.com
host smtp.gmail.com
port 587
tls on
tls_trust_file /etc/ssl/certs/ca-certificates.crt

アクセストークン更新は、ユーザーには見えないバックグラウンドで自動的に行われます。

==mail コマンドを使う==

{{ic|mail}} コマンドを使ってメールを送信するには {{Pkg|s-nail}} パッケージをインストールする必要があります。これは、 {{ic|mailx}} コマンドも提供します。それに加えて {{ic|sendmail}} 互換の MTA が必要です。{{Pkg|msmtp-mta}} をインストールするか(これは {{ic|sendmail} を {{ic|msmtp}} へシンボリックリンクします) {{ic|/etc/mail.rc}} を編集して sendmail クライアントを設定してください:

{{hc|/etc/mail.rc|2=set mta=/usr/bin/msmtp}}

システム共通の {{ic|/etc/msmtprc}} ファイルを使用するか、{{ic|.msmtprc}} ファイルをメールを送信したい全てのユーザーのホームディレクトリに配置する必要があります。

msmtp ではエイリアスが使えます。以下の行を msmtprc のデフォルトセクションかローカルの設定ファイルに追加してください:

{{hc|/etc/msmtprc|2=aliases /etc/aliases}}

そして {{ic|/etc}} にエイリアスファイルを作成してください:

{{hc|/etc/aliases|2=# Example aliases file

# Send root to Joe and Jane
root: joe_smith@example.com, jane_chang@example.com

# Send everything else to admin
default: admin@domain.example}}

==動作のテスト==

アカウントオプション ({{ic|1=--account=,-a}}) で送信元として使用するアカウントを指定します:

$ echo "hello there username." | msmtp -a default ''username''@domain.com

もしくは、件名と本文の両方を送信するには:

$ printf "Subject: Test\n\nhello there username." | msmtp -a default ''username''@domain.com

もしくは、ファイルにアドレスを書いて使用するには:

To: ''username''@domain.com
From: ''username''@gmail.com
Subject: A test

Hello there.

$ cat test.mail | msmtp -a default <username>@domain.com

{{Tip|''-a default'' の代わりに ''--read-envelope-from'' を使うことで送信するメッセージの ''From:'' に使われるアカウントが自動的に選択されます。また、 {{ic|--read-recipients,-t}} を使うことで、コマンドラインで指定した受信者に加えてメールの To、CC、Bcc ヘッダーから受信者のアドレスを読み込むことができます。}}

==Cronie のデフォルトメールクライアント==

{{Out of date|Arch は cronie の代わりに [[systemd/タイマー]] を使います。}}

{{Pkg|cronie}} で sendmail ではなく msmtp を使うようにするには、{{Pkg|msmtp-mta}} をインストールするか、{{ic|cronie.service}} systemd ユニットを編集してください:

{{hc|/etc/systemd/system/cronie.service.d/msmtp.conf|[Service]
ExecStart=
ExecStart=/usr/bin/crond -n -m '/usr/bin/msmtp -t'}}

それから cronie あるいは msmtp にメールアドレスを設定してください:

*{{ic|/etc/msmtprc}} に追加: {{bc|aliases /etc/aliases}} それから {{ic|/etc/aliases}} を作成: {{bc|your_username: email@address.com}}または：
*crontab の {{ic|MAILTO}} 行に追加: {{bc|MAILTO=email@address.com}}

==パスワード管理==

msmtp のパスワードはプレーンテキスト・暗号化ファイル・キーリングのどれかに保存できます [http://msmtp.sourceforge.net/doc/msmtp.html#Authentication]。

===GNOME Keyring===

[[GNOME Keyring]] にパスワードを保存することができます。Wiki ページに従ってキーリングを設定したら {{Pkg|libsecret}} をインストールしてください。以下のコマンドでパスワードを保存できます:

$ secret-tool store --label=msmtp host ''smtp.your.domain'' service smtp user ''yourusername''

msmtp は自動的にパスワードを確認します。

===GnuPG===

{{Ic|password}} ディレクティブは省略できます。省略した場合、アカウントの {{Ic|auth}} を {{Ic|off}} 以外の値に設定することで、インタラクティブシェルから msmtp を起動したときにメールの送信前にパスワードが要求されるようになります。[[Mutt]] などの他のアプリケーションから呼び出されたときは msmtp はパスワードを要求しません。そのようなときは {{ic|--passwordeval}} パラメータを使って [[GnuPG]] などの外部のキーリングツールを使用することができます。

[[GnuPG]] と [[GnuPG#gpg-agent|gpg-agent]] を設定してパスワードを毎回入力しなくてもよいようにしてください。それから、以下のように msmtp 用に暗号化したパスワードファイルを作成してください。{{ic|700}} パーミッションで [[tmpfs]] 上にディレクトリを作成することで、ディスクに暗号化されていないパスワードが書き込まれないようにすることができます。ディレクトリの中にはメールアカウントのパスワードを記述したプレーンテキストファイルを作成してください。そして、秘密鍵を使ってファイルを暗号化してください:

$ gpg --default-recipient-self -e ''/path/to/plain/password''

プレーンテキストファイルを削除して、暗号化したファイルを適切なディレクトリに移動してください (例: {{ic|~/.mail/.msmtp-credentials.gpg}})。{{ic|~/.msmtprc}} に以下を追加:

{{hc|~/.msmtprc|passwordeval "gpg --quiet --for-your-eyes-only --no-tty --decrypt ~/.mail/.msmtp-credentials.gpg"}}

[[Mutt]] などからメールを送信するときに GUI のパスワードプロンプトを表示するだけなら上記で十分です。gpg によってパスフレーズのプロンプトが表示されない場合、先に [[GPG#gpg-agent|gpg-agent]] を起動してください。muttrc に {{ic| ` command ` }} のようにバッククォートを使って外部コマンドを指定することでエージェントを起動できます。例:

{{hc|muttrc|set my_msmtp_pass=`gpg -d mypwfile.gpg`}}

Mutt は起動時にこれを実行し、gpg-agent はあなたのパスワードをキャッシュし、 msmtp は喜んでメールを送れるようになります。

{{Note| この場合、再びメールの受信を開始するには gpg-agent がパスワードをクリアした後 mutt を再起動する必要があります。}}

An alternative is to place passwords in {{ic|~/.netrc}}, a file that can act as a common pool for msmtp, [[OfflineIMAP]], and associated tools.

代替案としては、 msmtp、[[OfflineIMAP]]及び関連ツールで共通して管理できる {{ic|~/.netrc}}にパスワードを置く方法があります。

=== pass ===

認証情報を [[pass]] パスワードマネージャ内に保存することができます。

メインパスワード(通常はpassファイルの1行目に格納)で SMTP サーバにログインする場合は、以下を {{ic|.msmptrc}} に追加します:

{{hc|~/.msmtprc|
passwordeval "pass your_email_password_entry {{!}} head -n1"
}}

[https://www.google.com/gmail/ Gmail] を使っていて[https://myaccount.google.com/apppasswords アプリパスワード]の設定が済んでいるのなら、以下の設定がふさわしいでしょう。アプリパスワードを {{ic|pass}} パスワードファイルに保存しますが、{{ic|msmtp:}} プレフィックスを付けて下さい。

{{hc|your_email_password_entry|
your_main_password

login: your_username
url: the_url_of_your_email
'''msmtp: your_msmtp_app_password'''}}

そして、{{ic|.msmptrc}} に以下を追加して下さい。:
{{hc|~/.msmtprc|
passwordeval "pass your_email_password_entry {{!}} awk '/^msmtp:/ { print $2; }'"
}}

どちらの場合も、 msmtpでメールを送信しようとすると {{ic|pass}} が起動します。最近入力していないのであれば、 {{ic|pass}} のマスターパスワードを求められるかもしれません。

==ヒントとテクニック==

===msmtp をオフラインで使う===

msmtp は素晴らしいツールですが、使用するにはオンラインになる必要があります。インターネットに常時接続することができないノートパソコンなどではあまり好ましくありません。この問題を解決するためのスクリプトが複数存在し、まとめて msmtpqueue と呼ばれます。

スクリプトは {{ic|/usr/share/doc/msmtp/msmtpqueue}} にインストールされます。スクリプトはどこか便利な場所にコピーすると良いでしょう ({{ic|/usr/local/bin}} を推奨します)。

そして MUA でメールを送信するときに msmtp のかわりに msmtp-enqueue.sh を使うようにしてください。デフォルトでは、キューに入ったメッセージは {{ic|~/.msmtpqueue}} に保存されます。保存場所を変更したい場合はスクリプトの {{ic|QUEUEDIR=$HOME/.msmtpqueue}} 行を変更してください (もしくは行を削除して、{{ic|.bash_profile}} で QUEUEDIR 変数をエクスポートしてください: {{ic|export QUEUEDIR="$XDG_DATA_HOME/msmtpqueue"}})。

作成したメールを送信したいときは以下のコマンドを実行:
$ /usr/local/bin/msmtp-runqueue.sh

{{ic|/usr/local/bin}} を PATH に追加することでキーストロークを少なくすることができます。スクリプトに付属している README ファイルには有用な情報が載っているため、読むことを推奨します。

===Vim のシンタックスハイライト===
msmtp のソースディストリビューションには [[Vim]] 用の {{ic|msmtprc}} のシンタックスハイライトスクリプトが含まれています。{{ic|/usr/share/vim/vimfiles/syntax/msmtp.vim}} で利用できます。ファイルタイプは自動的に認識されません。[http://vimdoc.sourceforge.net/htmldoc/options.html#modeline modeline] をファイルの一番上あるいは下に追加するのが簡単です:

# vim:filetype=msmtp

===msmtp を使って PHP でメールを送信===
{{ic|php.ini}} の ''sendmail_path'' オプションを以下のように編集してください:
{{bc|1=
sendmail_path = "/usr/bin/msmtp -C /path/to/your/config -t"
}}

msmtp を php などで sendmail の代替として使う場合、ユーザーの設定ファイル(つまり ~/ 以下にあるもの)は'''使えない'''ことに注意して下さい。
その場合は /etc/msmtprc を作成し、ユーザー設定ファイルを削除してください(他の用途で使う場合は削除しないで下さい)。また、使うもの(php、django等)で読み取り可能にしておいて下さい。

msmtp マニュアルより: ''ユーザー設定ファイルで定義されたアカウントはシステム設定ファイル'により上書きされます。ユーザー設定ファイルには、ユーザーが読み書きできる以上の権限を与えてはいけません。'

そのため、conf ファイルを ~/ 以下に置き、php ユーザーが読めるようにすることは不可能です。

テストするにはこのファイルを php が有効なサーバが置くか、php-cli を使って下さい。
{{bc|
<?php
mail("your@email.com", "Test email from PHP", "msmtp as sendmail for PHP");
?>
}}

/etc/msmtprc のパーミションをユーザーが読み書きできる(600)ようにしない限り、{{ic|php-fpm}} はメール送信に失敗し、以下の警告をログに出すでしょう: {{ic|PHP Warning: mail(mail.log): failed to open stream}}

==トラブルシューティング==
===TLS の問題===
以下のエラーメッセージが表示される場合:

msmtp: TLS certificate verification failed: the certificate hasn't got a known issuer

msmtp: TLS certificate verification failed: The certificate is NOT trusted. The certificate issuer is unknown.

おそらく設定ファイルの {{ic|tls_trust_file}} パラメータが正しくありません。

[https://marlam.de/msmtp/msmtp.html#Transport-Layer-Security 素晴らしいマニュアル]に従って下さい。指定した SMTP サーバの証明書発行者を調べる方法が説明されています。そして、 {{ic|/usr/share/ca-certificates/}} ディレクトリを探索して、必要な証明書がひょっとしてそこにあるか調べることができます。ない場合は、自分で証明書を取得する必要があります。独自の証明書を使用している場合は、以下を {{ic|~/.msmtprc}}に追加することで msmtp にその証明書を信頼させることができます。

tls_fingerprint <SHA1 (recommended) or MD5 fingerprint of the certificate>

ユーザーがサーバで使用されている証明書を [https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail PEM] ファイルで持っている場合は、 {{ic|openssl}} を使うことによって保存されている証明書のフィンガープリントを見つけることができます:

openssl x509 -in ''CERT.pem'' -inform PEM -fingerprint

Gmail でメールを送信しようとしてこのエラーを受け取った場合、[https://www.mail-archive.com/msmtp-users@lists.sourceforge.net/msg00141.html この]スレッドを読むか、上記二番目の Gmail の例を使って下さい。

本当に困っているが、100% 正しいサーバに接続していると確信している場合は、いつでも証明書チェックを一時的に無効化することができます:

$ msmtp --tls-certcheck off

以下のメッセージが表示される場合:
msmtp: TLS handshake failed: the operation timed out
{{Bug|44994}} のバグが原因です。{{ic|1=--with-ssl=openssl}} を使って msmtp を再コンパイルしてください (デフォルトでは GnuTLS が有効になっています)。

===Server sent empty reply===
"server sent empty reply" エラーが表示される場合、メールサーバーがポート 587 での STARTTLS を許可しておらず、非標準のポート 465 での SSL/TLS を必要としています [https://www.fastmail.com/help/technical/ssltlsstarttls.html]。

msmtp でポート 465 の SSL/TLS を使うには、以下の行を {{ic|~/.msmtprc}} に追加してください:

tls_starttls off

==== Zoho SMTP サーバ ====

Zoho SMTP サーバでも、メールヘッダと本文の間に空行な無い場合発生する場合があります(Debianのバグ [https://www.mail-archive.com/debian-bugs-dist@lists.debian.org/msg1650762.html #917260] を参照)。この解決法としては、間に余分なスペースを追加して下さい:

"test-header\n\ntest-body"

===GSSAPI の問題===

以下のエラーが表示される場合:

GNU SASL: GSSAPI error in client while negotiating security context in gss_init_sec_context() in SASL library. This is most likely due insufficient credentials or malicious interactions.

.msmtprc ファイルの auth 設定を gssapi から plain に変更してみてください [https://bbs.archlinux.org/viewtopic.php?id=138727]:

auth plain

=== Envelope not accepted ===

以下のエラーが表示される場合:

msmtp: envelope from address mail@server not accepted by the server
msmtp: server message: 530 5.5.1 Authentication Required.
msmtp: could not send mail (account default from /etc/msmtprc)

以下で認証の有効化を試みるか、

auth on

他の方法で認証を有効化して下さい。

OfflineIMAP

2025-06-05T06:52:25Z

Sanlun: 誤字の訂正

[[Category:メール取得エージェント]]
[[Category:OpenPGP]]
[[en:OfflineIMAP]]
{{Related articles start}}
{{Related|isync}}
{{Related|notmuch}}
{{Related|msmtp}}
{{Related articles end}}

[https://github.com/OfflineIMAP/offlineimap3 OfflineIMAP] は IMAP サーバーからメールを同期する Python ユーティリティです。POP3 プロトコルや mbox は使えないため、通常 [[Mutt]] などの MUA と組み合わされて使われます。

== インストール ==

{{pkg|offlineimap}} をインストールしてください。

== 設定 ==

Offlineimap には2つのデフォルト設定ファイルが付属しており、どちらも {{ic|/usr/share/offlineimap/}} にあります。{{ic|offlineimap.conf}} には全ての設定が含まれておりコメントが付与されています。一方、{{ic|offlineimap.conf.minimal}} にはコメントが付いておらず多少の設定しか含まれていません (参照: [[#最小]])。

デフォルト設定ファイルのどちらかを {{ic|~/.offlineimaprc}} または {{ic|$XDG_CONFIG_HOME/offlineimap/config}} にコピーしてください。

{{note|同じ行内に、オプションや値の後ろにコメントを書くのは無効な構文なので、コメントは別の独立した行に書いて下さい。}}

=== 最小 ===

{{ic|offlineimap.conf.minimal}} のコメントが付いたバージョンは以下になります:

{{hc|~/.offlineimaprc|<nowiki>
[general]
# 同期するアカウントのリスト。コンマで区切る。
accounts = main

[Account main]
# ローカルリポジトリの識別子。例: IMAP経由で同期されるmaildir。
localrepository = main-local
# リモートリポジトリの識別子。すなわち実際のIMAPで、通常はローカルではありません。
remoterepository = main-remote

[Repository main-local]
# OfflineImapは、Maildir、GmailMaildir、およびIMAPをローカルリポジトリとしてサポートしています。
type = Maildir
# メールを配置する場所
localfolders = ~/mail

[Repository main-remote]
# リモートレポジトリはIMAPまたはGmailであり、後者は事前に設定されたIMAPです。
type = IMAP
remotehost = host.domain.tld
remoteuser = username
# OfflineImapのバージョンが6.5.4より高い場合、SSL接続に必要です。
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
</nowiki>}}

=== フォルダの同期の選択 ===

特定のフォルダだけを同期したい場合、{{ic|~/.offlineimaprc}} でアカウントの '''remote''' セクションに [http://offlineimap.org/doc/nametrans.html#folderfilter folderfilter] を使います。例えば、以下の設定では {{ic|Inbox}} と {{ic|Sent}} フォルダだけが同期されます:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
# InboxとSentフォルダーのみ同期します:
folderfilter = lambda foldername: foldername in ["Inbox", "Sent"]
...
}}

他のオプションについては、[http://offlineimap.org/doc/nametrans.html#folderfilter 公式ドキュメント] を見て下さい。

=== カスタムポート ===

IMAPサーバーの中には、デフォルトの993ポートではなく、カスタムポートの接続を要求してくるものがあります。そのようにするには、{{ic|~/.offlineimaprc}}の '''remote''' セクションに ''remoteport'' オプションを追加します:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
remoteport=''1234''
}}

== 使用方法 ==

offlineimap を実行する前に、ローカルリポジトリに割り当てる親ディレクトリを作成してください:
$ mkdir ~/Maildir

そして、プログラムを実行してください:

$ offlineimap

メールアカウントが同期されます。何か問題が発生した場合、エラーメッセージをよく見て下さい。OfflineIMAP は基本的に問題について詳しい出力を表示します。最終的な製品からのトレースバックを取得するのに開発者が悩む必要がないようにするためです。

== ヒントとテクニック ==

=== バックグラウンドで offlineimap を実行 ===

{{Style|コメント付きの設定ファイルをドキュメントとして使うのではなく、テキストに記述する方が良いのでは？}}

大抵のメール転送エージェントはデフォルトで、プログラムを定期的に同期させることで[[デーモン]]としてツールを使うのが前提になっています。offlineimap では、バックグラウンドで作業を制御する設定はあまりありません。

紛らわしいことに、バックグラウンドの設定は設定ファイルのあらゆるところに散らばっています:

{{hc|~/.offlineimaprc|2=
# generalセクション
[general]
# 同時に同期するアカウントの数を制御します
maxsyncaccounts = 1

# アカウント識別子
[Account main]
# 同期の間隔(分)
autorefresh = 0.5
# IMAPフラグにのみ変更があった場合、quick-syncsは更新されません。
# autorefresh=0.5 と quick=10 を組み合わせると、
# タイプに関係なく、各完全更新の間に0.5分の間隔で
# 10回のクイック更新が行われます。
quick = 10

# リモートリポジトリ識別子
[Repository main-remote]
# 同期が完了すると接続を閉じる代わりに、offlineimapはサーバーに空のデータを送信して接続を維持します。
# この値を60に設定すると、同期（クイックと自動更新の両方）の間に1分間接続を維持しようとします。
# この設定は、autorefresh と holdconnectionopen の両方が設定されていない場合は無効です。
keepalive = 60
# OfflineIMAPは通常、autorefreshグローバルオプションが指定されている場合、更新の合間にIMAPサーバ接続を閉じます。
# 接続を維持したい場合は、この設定をtrueに設定してください。
# autorefreshが設定されていない場合、この設定は効果がありません。
holdconnectionopen = yes
}}

ログイン時にデーモンを自動的に起動するには、[[systemd/ユーザー]]サービスである{{ic|offlineimap.service}}を{{ic|--user}}フラグ付きで[[起動/有効化]]してください。

複数のアカウントを設定している場合は、maxsyncaccountsパラメータ[https://www.offlineimap.org/configuration/2016/01/29/why-i-m-not-using-maxconnctions.html]を増やすのではなく、{{ic|offlineimap@.service}}を使用することをお勧めします。{{ic|offlineimap@youraccountname.service}}を[[起動/有効化]]するだけです。

==== systemd timer ====

あるいは、systemd-user [[systemd/タイマー|タイマー]]を使って、{{ic|offlineimap-oneshot.timer}}を{{ic|--user}}フラグで起動/有効化することで、OfflineIMAPを完全に管理することもできます。

このタイマーはデフォルトで15分ごとにOfflineIMAPを実行します。これは、[[ドロップインファイル]]を作成することで変更することができます。例えば、以下では5分ごとにチェックするようにタイマーを修正しています:

{{hc|~/.config/systemd/user/offlineimap-oneshot.timer.d/timer.conf|2=
[Timer]
OnUnitInactiveSec=5m
}}

{{Accuracy|これは、OfflineIMAPのローカルデータベースに矛盾をもたらす可能性があります。}}

より堅牢な解決法としては、フリーズした場合にOfflineIMAPをkillするウォッチドッグを設定することができます。

{{hc|~/.config/systemd/user/offlineimap-oneshot.service.d/service.conf|2=
[Service]
WatchdogSec=300
}}

=== mutt 用に自動的にメールボックスを作成 ===

[[Mutt]]は単にIMAP や Maildir のディレクトリを指し示したり、どのサブディレクトリがメールボックスであるかを推測することはできませんが、 offlineimap は同期するメールボックスを含む muttrc フラグメントを生成することができます。

{{hc|~/.offlineimaprc|<nowiki>
[mbnames]
enabled = yes
filename = ~/.mutt/mailboxes
header = "mailboxes "
peritem = "+%(accountname)s/%(foldername)s"
sep = " "
footer = "\n"
</nowiki>}}

そして以下の行を{{ic|~/.mutt/muttrc}}に追加します。

{{hc|~/.mutt/muttrc|<nowiki>
# IMAP: offlineimap
set folder = "~/Mail"
source ~/.mutt/mailboxes
set spoolfile = "+account/INBOX"
set record = "+account/Sent\ Items"
set postponed = "+account/Drafts"
</nowiki>}}

{{ic|account}}は{{ic|~/.offlineimaprc}}でIMAPアカウントにつけた名前です。

=== Gmail の設定 ===

このリモートリポジトリは Gmail をサポートするために特別に設定されており、フォルダ名を大文字から小文字に置き換えたり、その他の細かい追加を行います。この設定では「すべてのメール」フォルダーを同期しないことに注意して下さい。「すべてのメール」は通常不要であり、この同期をスキップすることにより帯域幅コストを抑えるためです:

{{hc|~/.offlineimaprc|<nowiki>
[Repository gmail-remote]
type = Gmail
remoteuser = user@gmail.com
remotepass = password
nametrans = lambda foldername: re.sub ('^\[gmail\]', 'bak',
re.sub ('sent_mail', 'sent',
re.sub ('starred', 'flagged',
re.sub (' ', '_', foldername.lower()))))
folderfilter = lambda foldername: foldername not in ['[Gmail]/All Mail']
# OfflineImap 6.5.4 で必要
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
# https://github.com/OfflineIMAP/offlineimap/issues/573（バージョン7.0.12、7.2.1）の対処に必要
ssl_version = tls1_2
</nowiki>}}

{{Note|
* Gmailが別の言語に設定されている場合、フォルダ名も翻訳されているように見える場合があります。例: 「sent_mail」の代わりに「送信済みメール」
* バージョン6.3.5以降では、offlineimapはローカルのフォルダに合わせてリモートのフォルダも作成します。そのため、この名前の翻訳ルールの効果を逆転させる名前の翻訳ルールがローカルリポジトリにも必要になるかもしれません。名前の逆翻訳ルールを作りたくない場合は、リモートの設定に次のように記述することで、リモートフォルダの作成を無効にできます: {{ic|<nowiki>createfolders = False</nowiki>}}
* 2012年10月1日現在、gmail の SSL 証明書のフィンガープリントはいつも同じだとは限りません。このため {{ic|cert_fingerprint}} を使うよりも {{ic|sslcacertfile}} を使って SSL の確認をするほうが良いでしょう ([[#SSL フィンガープリントが一致しない]]を参照)。
}}

==== oama経由のOAuth2アクセストークン ====

[https://github.com/pdobsan/oama oama] ({{AUR|oama-bin}})は、IMAP/SMTPクライアントにOAuth2認証の更新機能と承認を提供するユーティリティです。

OfflineIMAPは、設定からPythonコードを呼び出すことができます。したがって、まず{{ic|[general]}}セクションで、以下の行を追加します。

{{hc|~/.offlineimaprc|2=
[general]
pythonfile = ~/.offlineimap.py
}}

Pythonファイルに以下のコードを追加して、''oama''を経由してOAuth2アクセストークンを取得します:

{{hc|~/.offlineimap.py|2=
import subprocess

def get_token(email_address):
return subprocess.run(["oama", "access", email_address], capture_output=True, text=True).stdout
}}

そして設定ファイルに戻り、Gmailアカウントのrepositoryセクションに以下を追加してください:

{{hc|~/.offlineimaprc|2=
auth_mechanisms = XOAUTH2
oauth2_client_id = ''YOUR_OAUTH2_CLIENT_ID''
oauth2_client_secret = ''YOUR_OAUTH2_CLIENT_SECRET''
oauth2_request_url = <nowiki>https://accounts.google.com/o/oauth2/token</nowiki>
oauth2_access_token_eval = get_token("''YOUR_EMAIL_ADDRESS_FOR_THIS_ACCOUNT''")
}}

=== パスワードの管理 ===

==== .netrc ====

以下の行を {{ic|~/.netrc}} に追加してください:

machine hostname.tld
login [your username]
password [your password]

ファイルに600や700のような適切な権限を与えることを忘れないでください。

$ chmod 600 ~/.netrc

{{Note|OfflineIMAPは、{{ic|.netrc}}ファイルに複数のアカウントが保存されている場合、パスワードを取得する方法を[https://github.com/OfflineIMAP/offlineimap/issues/295 知りません]。}}

==== GPG を使う ====

GNU Privacy Guard を使うことで暗号化ファイルにパスワードを保存することができます。このセクションの設定を行う前にまず [[GnuPG]] をセットアップしてください。[[GnuPG#gpg-agent|パスワードを入力しなくても]] GPG の秘密鍵をいつでも使えるようにしておく必要があります。

まずプレーンテキストファイルにメールアカウントのパスワードを入力してください。暗号化されていないパスワードがディスクに書き込まれないように、ファイルの作成は [[tmpfs]] 上の {{ic|700}} パーミッションの安全なディレクトリで行って下さい。それから、GnuPGで自身を受信者にしてファイルを[[GnuPG#暗号化と復号化|暗号化]]します:

必要なくなったプレーンテキストファイルは削除してください。暗号化したファイルは最終的に必要な場所 (例: {{ic|~/.offlineimappass.gpg}}) に移動してください。

次にパスワードを復号化する python 関数を作成します:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python
from subprocess import check_output

def get_pass():
return check_output("gpg -dq ~/.offlineimappass.gpg", shell=True).rstrip(b"\n")
}}

上記のファイルを {{ic|~/.offlineimaprc}} からロードして、定義した関数を指定してください:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository ''example'']
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass()
...
}}

==== pass を使う ====

[[pass]] は GPG ベースのシンプルなコマンドラインのパスワードマネージャです。

最初にメールアカウントのパスワードを作成:

$ pass insert Mail/''account''

次にパスワードを復号化する python 関数を作成:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python
from subprocess import check_output

def get_pass(account):
return check_output("pass Mail/" + account, shell=True).splitlines()[0]
}}

上記はマルチアカウントセットアップの例です。前述の ''pass'' の引数はカスタマイズできます。

{{ic|~/.offlineimaprc}} からファイルをロードして、定義した関数を指定:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("Gmail")
...
}}

==== Gnome Keyring ====

リモートリポジトリの設定では、remoteusereval/remotepassevalフィールドを、ユーザー名/パスワードに評価するカスタムPythonコードに設定できます。このコードは、'pythonfile' 設定フィールドで示されたpythonスクリプト上で定義された関数への呼び出しにすることができます。以下のサブセクションに従って{{ic|~/.offlineimap.py}}を作成し、設定で使用します。

{{bc|<nowiki>
[general]
pythonfile = ~/.offlineimap.py

[Repository examplerepo]
type = IMAP
remotehost = mail.example.com
remoteusereval = get_username("examplerepo")
remotepasseval = get_password("examplerepo")
</nowiki>}}

===== gkgetsecret.py =====

{{Style|これは単一のサブセクションであるため、上記の導入と統合する必要があります。}}

{{Pkg|gnome-keyring}}、{{AUR|python2}}、{{AUR|python2-gobject}}、{{Pkg|libsecret}}がインストールされていることを確認して下さい。そして、{{ic|~/.offlineimap.py}}を次の内容で作成します: [https://pastebin.com/wzVfSac8 gkgetsecret.py]。さらに、上記のように{{ic|~/.offlineimaprc}}に{{ic|1=pythonfile = ~/.offlineimap.py}}を設定します。

{{Pkg|seahorse}}を使ってパスワードを作成した場合、その説明からパスワードを取得できます。例えば、''Password for me@myworkemail.com'' という説明つきのgnome-keyringに保存された ''work'' レポジトリのパスワードは、{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remotepasseval = get_pw_from_desc("Password for me@myworkemail.com")

同様にユーザー名も保存したい設定の場合、 ''secret-tool'' でパスワードを生成する方が、ユーザー名やリポジトリ名などの属性を設定するのに使えるのでよいでしょう。以下のコマンドでパスワードを作成することを検討して下さい。
$ secret-tool store --label "Password for Work Email" username me@myworkemail.com repo Work

このアカウントのユーザー名とパスワードは{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remoteusereval = get_val_from_attrs("username", "repo", "Work")
remotepasseval = get_pw_from_attrs("repo", "Work")

==== python-keyring ====

どのキーリングでも使える一般的な解決策があります。{{Pkg|python-keyring}}をインストールし、~/.offlineimaprcを以下のように変更して下さい。

{{bc|<nowiki>
[general]
pythonfile = /home/user/offlineimap.py
...
[Repository RemoteEmail]
remoteuser = username@host.net
remotepasseval = keyring.get_password("host","username")
...
</nowiki>}}

そして、 ~/offlineimap.py のどこかに {{ic|import keyring}} を追加して下さい.

あとはパスワードを設定するだけです。次のようなpythonスクリプトか、

{{bc|$ python
>>> import keyring
>>> keyring.set_password("host","username", "MYPASSWORD")}}

あるいはpython-keyringパッケージで提供されているkeyringコマンドを使えます。

$ keyring --help
$ keyring set host username
Password for 'username' in 'host':
$ keyring get host username
password

これで、平文として保存したり毎回入力したりする必要なく、(kwallet/gnome-)キーリングからパスワードを取り出せるようになります。

==== Emacs EasyPG ====

http://www.emacswiki.org/emacs/OfflineIMAP#toc2 を見てください。

==== KeePassXCとFreedesktop.orgのsecret-service ====

{{Pkg|libsecret}}をインストールし、KeepassXCの設定でFreedesktop.org secret-service統合を有効化、''Database Settings > Secret Service Integration''でエントリを公開し、''Edit Entry > Advanced''設定で{{ic|Title}}追加属性に{{ic|account@name.org}}を追加します。これで、{{ic|secret-tool lookup Title account@name.org}}コマンドでパスワードがコンソールに表示されるはずです。次に、pythonスクリプトを作成します:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import os
from subprocess import check_output

def get_pass(account):
return check_output("secret-tool lookup Title " + account, shell=True).splitlines()[0].decode("UTF-8")
}}

{{Pkg|python-secretstorage}}に依存する同等のスクリプトは以下の通りです:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import secretstorage
from contextlib import closing
def get_pass(title):
with closing(secretstorage.dbus_init()) as conn:
assert(secretstorage.check_service_availability(conn))
collection = secretstorage.get_default_collection(conn)
if collection.is_locked():
collection.unlock()
matches = collection.search_items({"Title": title})
entry = next(matches)
if entry.is_locked():
entry.unlock()
return(entry.get_secret())
}}

{{ic|~/.offlineimaprc}}からこのファイルをロードし、定義された関数を指定します:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.script.py
...
[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("account@name.org")
...
}}

== トラブルシューティング ==

=== UI の上書きと自動更新の設定 ===

トラブルシューティングのために、より詳細なUI、バックグラウンド同期なし、場合によってはデバッグレベルでofflineimapを起動すると便利な場合があります:
$ offlineimap [ -o ] [ -d <debug_type> ] [ -u <ui> ]
;-o
:自動更新、キープアライブ等を無効にします。

;-d <debug_type>
:''<debug_type>''は{{Ic|imap}}、{{Ic|maildir}}、{{Ic|thread}}のいずれかです。imapとmaildirのデバッグが圧倒的に最も便利です。

;-u <ui>
:''<ui>''は{{Ic|CURSES.BLINKENLIGHTS}}、{{Ic|TTY.TTYUI}}、{{Ic|NONINTERACTIVE.BASIC}}、{{Ic|NONINTERACTIVE.QUIET}}、{{Ic|MACHINE.MACHINEUI}}のいずれかです。デバッグ目的ではTTY.TTYUIで十分です。

{{Note|新しいバージョンでは以下を<ui>に使います: {{Ic|blinkenlights}}、{{Ic|ttyui}}、{{Ic|basic}}、{{Ic|quiet}}、{{Ic|machineui}}}}

=== フォルダが作成できない ===

[https://alioth-lists.debian.net/pipermail/offlineimap-project/2011-September/010200.html こちら]にあるように、バージョン6.5.3でofflineimapはリモートリポジトリにフォルダを作成できるようになりました。

これにより、リモートリポジトリで{{Ic|nametrans}}を使用すると以下のようなエラーが発生する可能性があります:
ERROR: Creating folder bar on repository foo-remote
Folder 'bar'[foo-remote] could not be created. Server responded: ('NO', ['[ALREADYEXISTS] Duplicate folder name bar (Failure)'])

解決策は、ローカルリポジトリに逆{{Ic|nametrans}}ラムダを提供することです。例:

{{hc|~/.offlineimaprc|<nowiki>
[Repository foo-local]
nametrans = lambda foldername: foldername.replace('bar', 'BAR')

[Repository foo-remote]
nametrans = lambda foldername: foldername.replace('BAR', 'bar')
</nowiki>}}

* 正しい逆マッピングを行うには、{{Ic|offlineimap --info}}の出力が役に立つでしょう。
* マッピングを更新したら、影響を受けるアカウントの{{Ic|$HOME/.offlineimap/}}下のフォルダを全て削除する必要があるかもしれません。

=== SSL フィンガープリントが一致しない ===

ERROR: Server SSL fingerprint 'keykeykey' for hostname 'example.com' does not match configured fingerprint. Please verify and set 'cert_fingerprint' accordingly if not set yet.

これを解決するには、{{ic|~/.offlineimaprc}} ({{ic|1=ssl = yes}}と同じセクション)に以下のいずれかを追加します。
* リモートサーバーの証明書のフィンガープリントを{{ic|cert_fingerprint}}に追加します。これは、リモートサーバーの証明書が与えられたフィンガープリントに一致するかチェックします。
cert_fingerprint = keykeykey
* もしくは、システムのCA証明書ファイルを{{ic|sslcacertfile}}に追加します。{{Pkg|ca-certificates}}のインストールが必要です。これは、リモートのSSL証明書チェーンを、そのファイルの認証局に対して検証します。
{{bc|1=sslcacertfile = /etc/ssl/certs/ca-certificates.crt}}

=== Copying message, connection closed ===

ERROR: Copying message -2 [acc: email] connection closed
Folder sent [acc: email]: ERROR: while syncing sent [account email] connection closed

上記の問題はローカルとサーバーで同じメッセージが作成されていることが原因です。メールのプロバイダが自動的にローカルクライアントと同じフォルダに送信したメールを保存した場合に発生します。この問題が起こったときはローカルクライアントで送信済みメッセージの保存を無効化してください。

== 参照 ==

* [http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project OfflineIMAP 公式メーリングリスト]
* [http://pbrisbin.com/posts/mutt_gmail_offlineimap/ Mutt + Gmail + Offlineimap] - brisbinによるシンプルなgmail/muttの設定の概要。cronでofflineimapの同期を保持させています。

OfflineIMAP

2025-06-04T01:43:27Z

Sanlun: python2で書かれていたコードを3に更新

[[Category:メール取得エージェント]]
[[Category:OpenPGP]]
[[en:OfflineIMAP]]
{{Related articles start}}
{{Related|isync}}
{{Related|notmuch}}
{{Related|msmtp}}
{{Related articles end}}

[https://github.com/OfflineIMAP/offlineimap3 OfflineIMAP] は IMAP サーバーからメールを同期する Python ユーティリティです。POP3 プロトコルや mbox は使えないため、通常 [[Mutt]] などの MUA と組み合わされて使われます。

== インストール ==

{{pkg|offlineimap}} をインストールしてください。

== 設定 ==

Offlineimap には2つのデフォルト設定ファイルが付属しており、どちらも {{ic|/usr/share/offlineimap/}} にあります。{{ic|offlineimap.conf}} には全ての設定が含まれておりコメントが付与されています。一方、{{ic|offlineimap.conf.minimal}} にはコメントが付いておらず多少の設定しか含まれていません (参照: [[#最小]])。

デフォルト設定ファイルのどちらかを {{ic|~/.offlineimaprc}} または {{ic|$XDG_CONFIG_HOME/offlineimap/config}} にコピーしてください。

{{note|同じ行内に、オプションや値の後ろにコメントを書くのは無効な構文なので、コメントは別の独立した行に書いて下さい。}}

=== 最小 ===

{{ic|offlineimap.conf.minimal}} のコメントが付いたバージョンは以下になります:

{{hc|~/.offlineimaprc|<nowiki>
[general]
# 同期するアカウントのリスト。コンマで区切る。
accounts = main

[Account main]
# ローカルリポジトリの識別子。例: IMAP経由で同期されるmaildir。
localrepository = main-local
# リモートリポジトリの識別子。すなわち実際のIMAPで、通常はローカルではありません。
remoterepository = main-remote

[Repository main-local]
# OfflineImapは、Maildir、GmailMaildir、およびIMAPをローカルリポジトリとしてサポートしています。
type = Maildir
# メールを配置する場所
localfolders = ~/mail

[Repository main-remote]
# リモートレポジトリはIMAPまたはGmailであり、後者は事前に設定されたIMAPです。
type = IMAP
remotehost = host.domain.tld
remoteuser = username
# OfflineImapのバージョンが6.5.4より高い場合、SSL接続に必要です。
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
</nowiki>}}

=== フォルダの同期の選択 ===

特定のフォルダだけを同期したい場合、{{ic|~/.offlineimaprc}} でアカウントの '''remote''' セクションに [http://offlineimap.org/doc/nametrans.html#folderfilter folderfilter] を使います。例えば、以下の設定では {{ic|Inbox}} と {{ic|Sent}} フォルダだけが同期されます:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
# InboxとSentフォルダーのみ同期します:
folderfilter = lambda foldername: foldername in ["Inbox", "Sent"]
...
}}

他のオプションについては、[http://offlineimap.org/doc/nametrans.html#folderfilter 公式ドキュメント] を見て下さい。

=== カスタムポート ===

IMAPサーバーの中には、デフォルトの993ポートではなく、カスタムポートの接続を要求してくるものがあります。そのようにするには、{{ic|~/.offlineimaprc}}の '''remote''' セクションに ''remoteport'' オプションを追加します:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
remoteport=''1234''
}}

== 使用方法 ==

offlineimap を実行する前に、ローカルリポジトリに割り当てる親ディレクトリを作成してください:
$ mkdir ~/Maildir

そして、プログラムを実行してください:

$ offlineimap

メールアカウントが同期されます。何か問題が発生した場合、エラーメッセージをよく見て下さい。OfflineIMAP は基本的に問題について詳しい出力を表示します。最終的な製品からのトレースバックを取得するのに開発者が悩む必要がないようにするためです。

== ヒントとテクニック ==

=== バックグラウンドで offlineimap を実行 ===

{{Style|コメント付きの設定ファイルをドキュメントとして使うのではなく、テキストに記述する方が良いのでは？}}

大抵のメール転送エージェントはデフォルトで、プログラムを定期的に同期させることで[[デーモン]]としてツールを使うのが前提になっています。offlineimap では、バックグラウンドで作業を制御する設定はあまりありません。

紛らわしいことに、バックグラウンドの設定は設定ファイルのあらゆるところに散らばっています:

{{hc|~/.offlineimaprc|2=
# generalセクション
[general]
# 同時に同期するアカウントの数を制御します
maxsyncaccounts = 1

# アカウント識別子
[Account main]
# 同期の間隔(分)
autorefresh = 0.5
# IMAPフラグにのみ変更があった場合、quick-syncsは更新されません。
# autorefresh=0.5 と quick=10 を組み合わせると、
# タイプに関係なく、各完全更新の間に0.5分の間隔で
# 10回のクイック更新が行われます。
quick = 10

# リモートリポジトリ識別子
[Repository main-remote]
# 同期が完了すると接続を閉じる代わりに、offlineimapはサーバーに空のデータを送信して接続を維持します。
# この値を60に設定すると、同期（クイックと自動更新の両方）の間に1分間接続を維持しようとします。
# この設定は、autorefresh と holdconnectionopen の両方が設定されていない場合は無効です。
keepalive = 60
# OfflineIMAPは通常、autorefreshグローバルオプションが指定されている場合、更新の合間にIMAPサーバ接続を閉じます。
# 接続を維持したい場合は、この設定をtrueに設定してください。
# autorefreshが設定されていない場合、この設定は効果がありません。
holdconnectionopen = yes
}}

ログイン時にデーモンを自動的に起動するには、[[systemd/ユーザー]]サービスである{{ic|offlineimap.service}}を{{ic|--user}}フラグ付きで[[起動/有効化]]してください。

複数のアカウントを設定している場合は、maxsyncaccountsパラメータ[https://www.offlineimap.org/configuration/2016/01/29/why-i-m-not-using-maxconnctions.html]を増やすのではなく、{{ic|offlineimap@.service}}を使用することをお勧めします。{{ic|offlineimap@youraccountname.service}}を[[起動/有効化]]するだけです。

==== systemd timer ====

あるいは、systemd-user [[systemd/タイマー|タイマー]]を使って、{{ic|offlineimap-oneshot.timer}}を{{ic|--user}}フラグで起動/有効化することで、OfflineIMAPを完全に管理することもできます。

このタイマーはデフォルトで15分ごとにOfflineIMAPを実行します。これは、[[ドロップインファイル]]を作成することで変更することができます。例えば、以下では5分ごとにチェックするようにタイマーを修正しています:

{{hc|~/.config/systemd/user/offlineimap-oneshot.timer.d/timer.conf|2=
[Timer]
OnUnitInactiveSec=5m
}}

{{Accuracy|これは、OfflineIMAPのローカルデータベースに矛盾をもたらす可能性があります。}}

より堅牢な解決法としては、フリーズした場合にOfflineIMAPをkillするウォッチドッグを設定することができます。

{{hc|~/.config/systemd/user/offlineimap-oneshot.service.d/service.conf|2=
[Service]
WatchdogSec=300
}}

=== mutt 用に自動的にメールボックスを作成 ===

[Mutt]]は単にIMAP や Maildir のディレクトリを指し示したり、どのサブディレクトリがメールボックスであるかを推測することはできませんが、 offlineimap は同期するメールボックスを含む muttrc フラグメントを生成することができます。

{{hc|~/.offlineimaprc|<nowiki>
[mbnames]
enabled = yes
filename = ~/.mutt/mailboxes
header = "mailboxes "
peritem = "+%(accountname)s/%(foldername)s"
sep = " "
footer = "\n"
</nowiki>}}

そして以下の行を{{ic|~/.mutt/muttrc}}に追加します。

{{hc|~/.mutt/muttrc|<nowiki>
# IMAP: offlineimap
set folder = "~/Mail"
source ~/.mutt/mailboxes
set spoolfile = "+account/INBOX"
set record = "+account/Sent\ Items"
set postponed = "+account/Drafts"
</nowiki>}}

{{ic|account}}は{{ic|~/.offlineimaprc}}でIMAPアカウントにつけた名前です。

=== Gmail の設定 ===

このリモートリポジトリは Gmail をサポートするために特別に設定されており、フォルダ名を大文字から小文字に置き換えたり、その他の細かい追加を行います。この設定では「すべてのメール」フォルダーを同期しないことに注意して下さい。「すべてのメール」は通常不要であり、この同期をスキップすることにより帯域幅コストを抑えるためです:

{{hc|~/.offlineimaprc|<nowiki>
[Repository gmail-remote]
type = Gmail
remoteuser = user@gmail.com
remotepass = password
nametrans = lambda foldername: re.sub ('^\[gmail\]', 'bak',
re.sub ('sent_mail', 'sent',
re.sub ('starred', 'flagged',
re.sub (' ', '_', foldername.lower()))))
folderfilter = lambda foldername: foldername not in ['[Gmail]/All Mail']
# OfflineImap 6.5.4 で必要
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
# https://github.com/OfflineIMAP/offlineimap/issues/573（バージョン7.0.12、7.2.1）の対処に必要
ssl_version = tls1_2
</nowiki>}}

{{Note|
* Gmailが別の言語に設定されている場合、フォルダ名も翻訳されているように見える場合があります。例: 「sent_mail」の代わりに「送信済みメール」
* バージョン6.3.5以降では、offlineimapはローカルのフォルダに合わせてリモートのフォルダも作成します。そのため、この名前の翻訳ルールの効果を逆転させる名前の翻訳ルールがローカルリポジトリにも必要になるかもしれません。名前の逆翻訳ルールを作りたくない場合は、リモートの設定に次のように記述することで、リモートフォルダの作成を無効にできます: {{ic|<nowiki>createfolders = False</nowiki>}}
* 2012年10月1日現在、gmail の SSL 証明書のフィンガープリントはいつも同じだとは限りません。このため {{ic|cert_fingerprint}} を使うよりも {{ic|sslcacertfile}} を使って SSL の確認をするほうが良いでしょう ([[#SSL フィンガープリントが一致しない]]を参照)。
}}

==== oama経由のOAuth2アクセストークン ====

[https://github.com/pdobsan/oama oama] ({{AUR|oama-bin}})は、IMAP/SMTPクライアントにOAuth2認証の更新機能と承認を提供するユーティリティです。

OfflineIMAPは、設定からPythonコードを呼び出すことができます。したがって、まず{{ic|[general]}}セクションで、以下の行を追加します。

{{hc|~/.offlineimaprc|2=
[general]
pythonfile = ~/.offlineimap.py
}}

Pythonファイルに以下のコードを追加して、''oama''を経由してOAuth2アクセストークンを取得します:

{{hc|~/.offlineimap.py|2=
import subprocess

def get_token(email_address):
return subprocess.run(["oama", "access", email_address], capture_output=True, text=True).stdout
}}

そして設定ファイルに戻り、Gmailアカウントのrepositoryセクションに以下を追加してください:

{{hc|~/.offlineimaprc|2=
auth_mechanisms = XOAUTH2
oauth2_client_id = ''YOUR_OAUTH2_CLIENT_ID''
oauth2_client_secret = ''YOUR_OAUTH2_CLIENT_SECRET''
oauth2_request_url = <nowiki>https://accounts.google.com/o/oauth2/token</nowiki>
oauth2_access_token_eval = get_token("''YOUR_EMAIL_ADDRESS_FOR_THIS_ACCOUNT''")
}}

=== パスワードの管理 ===

==== .netrc ====

以下の行を {{ic|~/.netrc}} に追加してください:

machine hostname.tld
login [your username]
password [your password]

ファイルに600や700のような適切な権限を与えることを忘れないでください。

$ chmod 600 ~/.netrc

{{Note|OfflineIMAPは、{{ic|.netrc}}ファイルに複数のアカウントが保存されている場合、パスワードを取得する方法を[https://github.com/OfflineIMAP/offlineimap/issues/295 知りません]。}}

==== GPG を使う ====

GNU Privacy Guard を使うことで暗号化ファイルにパスワードを保存することができます。このセクションの設定を行う前にまず [[GnuPG]] をセットアップしてください。[[GnuPG#gpg-agent|パスワードを入力しなくても]] GPG の秘密鍵をいつでも使えるようにしておく必要があります。

まずプレーンテキストファイルにメールアカウントのパスワードを入力してください。暗号化されていないパスワードがディスクに書き込まれないように、ファイルの作成は [[tmpfs]] 上の {{ic|700}} パーミッションの安全なディレクトリで行って下さい。それから、GnuPGで自身を受信者にしてファイルを[[GnuPG#暗号化と復号化|暗号化]]します:

必要なくなったプレーンテキストファイルは削除してください。暗号化したファイルは最終的に必要な場所 (例: {{ic|~/.offlineimappass.gpg}}) に移動してください。

次にパスワードを復号化する python 関数を作成します:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python
from subprocess import check_output

def get_pass():
return check_output("gpg -dq ~/.offlineimappass.gpg", shell=True).rstrip(b"\n")
}}

上記のファイルを {{ic|~/.offlineimaprc}} からロードして、定義した関数を指定してください:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository ''example'']
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass()
...
}}

==== pass を使う ====

[[pass]] は GPG ベースのシンプルなコマンドラインのパスワードマネージャです。

最初にメールアカウントのパスワードを作成:

$ pass insert Mail/''account''

次にパスワードを復号化する python 関数を作成:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python
from subprocess import check_output

def get_pass(account):
return check_output("pass Mail/" + account, shell=True).splitlines()[0]
}}

上記はマルチアカウントセットアップの例です。前述の ''pass'' の引数はカスタマイズできます。

{{ic|~/.offlineimaprc}} からファイルをロードして、定義した関数を指定:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("Gmail")
...
}}

==== Gnome Keyring ====

リモートリポジトリの設定では、remoteusereval/remotepassevalフィールドを、ユーザー名/パスワードに評価するカスタムPythonコードに設定できます。このコードは、'pythonfile' 設定フィールドで示されたpythonスクリプト上で定義された関数への呼び出しにすることができます。以下のサブセクションに従って{{ic|~/.offlineimap.py}}を作成し、設定で使用します。

{{bc|<nowiki>
[general]
pythonfile = ~/.offlineimap.py

[Repository examplerepo]
type = IMAP
remotehost = mail.example.com
remoteusereval = get_username("examplerepo")
remotepasseval = get_password("examplerepo")
</nowiki>}}

===== gkgetsecret.py =====

{{Style|これは単一のサブセクションであるため、上記の導入と統合する必要があります。}}

{{Pkg|gnome-keyring}}、{{AUR|python2}}、{{AUR|python2-gobject}}、{{Pkg|libsecret}}がインストールされていることを確認して下さい。そして、{{ic|~/.offlineimap.py}}を次の内容で作成します: [https://pastebin.com/wzVfSac8 gkgetsecret.py]。さらに、上記のように{{ic|~/.offlineimaprc}}に{{ic|1=pythonfile = ~/.offlineimap.py}}を設定します。

{{Pkg|seahorse}}を使ってパスワードを作成した場合、その説明からパスワードを取得できます。例えば、''Password for me@myworkemail.com'' という説明つきのgnome-keyringに保存された ''work'' レポジトリのパスワードは、{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remotepasseval = get_pw_from_desc("Password for me@myworkemail.com")

同様にユーザー名も保存したい設定の場合、 ''secret-tool'' でパスワードを生成する方が、ユーザー名やリポジトリ名などの属性を設定するのに使えるのでよいでしょう。以下のコマンドでパスワードを作成することを検討して下さい。
$ secret-tool store --label "Password for Work Email" username me@myworkemail.com repo Work

このアカウントのユーザー名とパスワードは{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remoteusereval = get_val_from_attrs("username", "repo", "Work")
remotepasseval = get_pw_from_attrs("repo", "Work")

==== python-keyring ====

どのキーリングでも使える一般的な解決策があります。{{Pkg|python-keyring}}をインストールし、~/.offlineimaprcを以下のように変更して下さい。

{{bc|<nowiki>
[general]
pythonfile = /home/user/offlineimap.py
...
[Repository RemoteEmail]
remoteuser = username@host.net
remotepasseval = keyring.get_password("host","username")
...
</nowiki>}}

そして、 ~/offlineimap.py のどこかに {{ic|import keyring}} を追加して下さい.

あとはパスワードを設定するだけです。次のようなpythonスクリプトか、

{{bc|$ python
>>> import keyring
>>> keyring.set_password("host","username", "MYPASSWORD")}}

あるいはpython-keyringパッケージで提供されているkeyringコマンドを使えます。

$ keyring --help
$ keyring set host username
Password for 'username' in 'host':
$ keyring get host username
password

これで、平文として保存したり毎回入力したりする必要なく、(kwallet/gnome-)キーリングからパスワードを取り出せるようになります。

==== Emacs EasyPG ====

http://www.emacswiki.org/emacs/OfflineIMAP#toc2 を見てください。

==== KeePassXCとFreedesktop.orgのsecret-service ====

{{Pkg|libsecret}}をインストールし、KeepassXCの設定でFreedesktop.org secret-service統合を有効化、''Database Settings > Secret Service Integration''でエントリを公開し、''Edit Entry > Advanced''設定で{{ic|Title}}追加属性に{{ic|account@name.org}}を追加します。これで、{{ic|secret-tool lookup Title account@name.org}}コマンドでパスワードがコンソールに表示されるはずです。次に、pythonスクリプトを作成します:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import os
from subprocess import check_output

def get_pass(account):
return check_output("secret-tool lookup Title " + account, shell=True).splitlines()[0].decode("UTF-8")
}}

{{Pkg|python-secretstorage}}に依存する同等のスクリプトは以下の通りです:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import secretstorage
from contextlib import closing
def get_pass(title):
with closing(secretstorage.dbus_init()) as conn:
assert(secretstorage.check_service_availability(conn))
collection = secretstorage.get_default_collection(conn)
if collection.is_locked():
collection.unlock()
matches = collection.search_items({"Title": title})
entry = next(matches)
if entry.is_locked():
entry.unlock()
return(entry.get_secret())
}}

{{ic|~/.offlineimaprc}}からこのファイルをロードし、定義された関数を指定します:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.script.py
...
[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("account@name.org")
...
}}

== トラブルシューティング ==

=== UI の上書きと自動更新の設定 ===

トラブルシューティングのために、より詳細なUI、バックグラウンド同期なし、場合によってはデバッグレベルでofflineimapを起動すると便利な場合があります:
$ offlineimap [ -o ] [ -d <debug_type> ] [ -u <ui> ]
;-o
:自動更新、キープアライブ等を無効にします。

;-d <debug_type>
:''<debug_type>''は{{Ic|imap}}、{{Ic|maildir}}、{{Ic|thread}}のいずれかです。imapとmaildirのデバッグが圧倒的に最も便利です。

;-u <ui>
:''<ui>''は{{Ic|CURSES.BLINKENLIGHTS}}、{{Ic|TTY.TTYUI}}、{{Ic|NONINTERACTIVE.BASIC}}、{{Ic|NONINTERACTIVE.QUIET}}、{{Ic|MACHINE.MACHINEUI}}のいずれかです。デバッグ目的ではTTY.TTYUIで十分です。

{{Note|新しいバージョンでは以下を<ui>に使います: {{Ic|blinkenlights}}、{{Ic|ttyui}}、{{Ic|basic}}、{{Ic|quiet}}、{{Ic|machineui}}}}

=== フォルダが作成できない ===

[https://alioth-lists.debian.net/pipermail/offlineimap-project/2011-September/010200.html こちら]にあるように、バージョン6.5.3でofflineimapはリモートリポジトリにフォルダを作成できるようになりました。

これにより、リモートリポジトリで{{Ic|nametrans}}を使用すると以下のようなエラーが発生する可能性があります:
ERROR: Creating folder bar on repository foo-remote
Folder 'bar'[foo-remote] could not be created. Server responded: ('NO', ['[ALREADYEXISTS] Duplicate folder name bar (Failure)'])

解決策は、ローカルリポジトリに逆{{Ic|nametrans}}ラムダを提供することです。例:

{{hc|~/.offlineimaprc|<nowiki>
[Repository foo-local]
nametrans = lambda foldername: foldername.replace('bar', 'BAR')

[Repository foo-remote]
nametrans = lambda foldername: foldername.replace('BAR', 'bar')
</nowiki>}}

* 正しい逆マッピングを行うには、{{Ic|offlineimap --info}}の出力が役に立つでしょう。
* マッピングを更新したら、影響を受けるアカウントの{{Ic|$HOME/.offlineimap/}}下のフォルダを全て削除する必要があるかもしれません。

=== SSL フィンガープリントが一致しない ===

ERROR: Server SSL fingerprint 'keykeykey' for hostname 'example.com' does not match configured fingerprint. Please verify and set 'cert_fingerprint' accordingly if not set yet.

これを解決するには、{{ic|~/.offlineimaprc}} ({{ic|1=ssl = yes}}と同じセクション)に以下のいずれかを追加します。
* リモートサーバーの証明書のフィンガープリントを{{ic|cert_fingerprint}}に追加します。これは、リモートサーバーの証明書が与えられたフィンガープリントに一致するかチェックします。
cert_fingerprint = keykeykey
* もしくは、システムのCA証明書ファイルを{{ic|sslcacertfile}}に追加します。{{Pkg|ca-certificates}}のインストールが必要です。これは、リモートのSSL証明書チェーンを、そのファイルの認証局に対して検証します。
{{bc|1=sslcacertfile = /etc/ssl/certs/ca-certificates.crt}}

=== Copying message, connection closed ===

ERROR: Copying message -2 [acc: email] connection closed
Folder sent [acc: email]: ERROR: while syncing sent [account email] connection closed

上記の問題はローカルとサーバーで同じメッセージが作成されていることが原因です。メールのプロバイダが自動的にローカルクライアントと同じフォルダに送信したメールを保存した場合に発生します。この問題が起こったときはローカルクライアントで送信済みメッセージの保存を無効化してください。

== 参照 ==

* [http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project OfflineIMAP 公式メーリングリスト]
* [http://pbrisbin.com/posts/mutt_gmail_offlineimap/ Mutt + Gmail + Offlineimap] - brisbinによるシンプルなgmail/muttの設定の概要。cronでofflineimapの同期を保持させています。

OfflineIMAP

2025-06-03T11:12:21Z

Sanlun: 英語版の最新版の内容に更新

[[Category:メール取得エージェント]]
[[Category:OpenPGP]]
[[en:OfflineIMAP]]
{{Related articles start}}
{{Related|isync}}
{{Related|notmuch}}
{{Related|msmtp}}
{{Related articles end}}

[https://github.com/OfflineIMAP/offlineimap3 OfflineIMAP] は IMAP サーバーからメールを同期する Python ユーティリティです。POP3 プロトコルや mbox は使えないため、通常 [[Mutt]] などの MUA と組み合わされて使われます。

== インストール ==

{{pkg|offlineimap}} をインストールしてください。

== 設定 ==

Offlineimap には2つのデフォルト設定ファイルが付属しており、どちらも {{ic|/usr/share/offlineimap/}} にあります。{{ic|offlineimap.conf}} には全ての設定が含まれておりコメントが付与されています。一方、{{ic|offlineimap.conf.minimal}} にはコメントが付いておらず多少の設定しか含まれていません (参照: [[#最小]])。

デフォルト設定ファイルのどちらかを {{ic|~/.offlineimaprc}} または {{ic|$XDG_CONFIG_HOME/offlineimap/config}} にコピーしてください。

{{note|同じ行内に、オプションや値の後ろにコメントを書くのは無効な構文なので、コメントは別の独立した行に書いて下さい。}}

=== 最小 ===

{{ic|offlineimap.conf.minimal}} のコメントが付いたバージョンは以下になります:

{{hc|~/.offlineimaprc|<nowiki>
[general]
# 同期するアカウントのリスト。コンマで区切る。
accounts = main

[Account main]
# ローカルリポジトリの識別子。例: IMAP経由で同期されるmaildir。
localrepository = main-local
# リモートリポジトリの識別子。すなわち実際のIMAPで、通常はローカルではありません。
remoterepository = main-remote

[Repository main-local]
# OfflineImapは、Maildir、GmailMaildir、およびIMAPをローカルリポジトリとしてサポートしています。
type = Maildir
# メールを配置する場所
localfolders = ~/mail

[Repository main-remote]
# リモートレポジトリはIMAPまたはGmailであり、後者は事前に設定されたIMAPです。
type = IMAP
remotehost = host.domain.tld
remoteuser = username
# OfflineImapのバージョンが6.5.4より高い場合、SSL接続に必要です。
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
</nowiki>}}

=== フォルダの同期の選択 ===

特定のフォルダだけを同期したい場合、{{ic|~/.offlineimaprc}} でアカウントの '''remote''' セクションに [http://offlineimap.org/doc/nametrans.html#folderfilter folderfilter] を使います。例えば、以下の設定では {{ic|Inbox}} と {{ic|Sent}} フォルダだけが同期されます:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
# InboxとSentフォルダーのみ同期します:
folderfilter = lambda foldername: foldername in ["Inbox", "Sent"]
...
}}

他のオプションについては、[http://offlineimap.org/doc/nametrans.html#folderfilter 公式ドキュメント] を見て下さい。

=== カスタムポート ===

IMAPサーバーの中には、デフォルトの993ポートではなく、カスタムポートの接続を要求してくるものがあります。そのようにするには、{{ic|~/.offlineimaprc}}の '''remote''' セクションに ''remoteport'' オプションを追加します:

{{hc|~/.offlineimaprc|2=
[Repository main-remote]
remoteport=''1234''
}}

== 使用方法 ==

offlineimap を実行する前に、ローカルリポジトリに割り当てる親ディレクトリを作成してください:
$ mkdir ~/Maildir

そして、プログラムを実行してください:

$ offlineimap

メールアカウントが同期されます。何か問題が発生した場合、エラーメッセージをよく見て下さい。OfflineIMAP は基本的に問題について詳しい出力を表示します。最終的な製品からのトレースバックを取得するのに開発者が悩む必要がないようにするためです。

== ヒントとテクニック ==

=== バックグラウンドで offlineimap を実行 ===

{{Style|コメント付きの設定ファイルをドキュメントとして使うのではなく、テキストに記述する方が良いのでは？}}

大抵のメール転送エージェントはデフォルトで、プログラムを定期的に同期させることで[[デーモン]]としてツールを使うのが前提になっています。offlineimap では、バックグラウンドで作業を制御する設定はあまりありません。

紛らわしいことに、バックグラウンドの設定は設定ファイルのあらゆるところに散らばっています:

{{hc|~/.offlineimaprc|2=
# generalセクション
[general]
# 同時に同期するアカウントの数を制御します
maxsyncaccounts = 1

# アカウント識別子
[Account main]
# 同期の間隔(分)
autorefresh = 0.5
# IMAPフラグにのみ変更があった場合、quick-syncsは更新されません。
# autorefresh=0.5 と quick=10 を組み合わせると、
# タイプに関係なく、各完全更新の間に0.5分の間隔で
# 10回のクイック更新が行われます。
quick = 10

# リモートリポジトリ識別子
[Repository main-remote]
# 同期が完了すると接続を閉じる代わりに、offlineimapはサーバーに空のデータを送信して接続を維持します。
# この値を60に設定すると、同期（クイックと自動更新の両方）の間に1分間接続を維持しようとします。
# この設定は、autorefresh と holdconnectionopen の両方が設定されていない場合は無効です。
keepalive = 60
# OfflineIMAPは通常、autorefreshグローバルオプションが指定されている場合、更新の合間にIMAPサーバ接続を閉じます。
# 接続を維持したい場合は、この設定をtrueに設定してください。
# autorefreshが設定されていない場合、この設定は効果がありません。
holdconnectionopen = yes
}}

ログイン時にデーモンを自動的に起動するには、[[systemd/ユーザー]]サービスである{{ic|offlineimap.service}}を{{ic|--user}}フラグ付きで[[起動/有効化]]してください。

複数のアカウントを設定している場合は、maxsyncaccountsパラメータ[https://www.offlineimap.org/configuration/2016/01/29/why-i-m-not-using-maxconnctions.html]を増やすのではなく、{{ic|offlineimap@.service}}を使用することをお勧めします。{{ic|offlineimap@youraccountname.service}}を[[起動/有効化]]するだけです。

==== systemd timer ====

あるいは、systemd-user [[systemd/タイマー|タイマー]]を使って、{{ic|offlineimap-oneshot.timer}}を{{ic|--user}}フラグで起動/有効化することで、OfflineIMAPを完全に管理することもできます。

このタイマーはデフォルトで15分ごとにOfflineIMAPを実行します。これは、[[ドロップインファイル]]を作成することで変更することができます。例えば、以下では5分ごとにチェックするようにタイマーを修正しています:

{{hc|~/.config/systemd/user/offlineimap-oneshot.timer.d/timer.conf|2=
[Timer]
OnUnitInactiveSec=5m
}}

{{Accuracy|これは、OfflineIMAPのローカルデータベースに矛盾をもたらす可能性があります。}}

より堅牢な解決法としては、フリーズした場合にOfflineIMAPをkillするウォッチドッグを設定することができます。

{{hc|~/.config/systemd/user/offlineimap-oneshot.service.d/service.conf|2=
[Service]
WatchdogSec=300
}}

=== mutt 用に自動的にメールボックスを作成 ===

[Mutt]]は単にIMAP や Maildir のディレクトリを指し示したり、どのサブディレクトリがメールボックスであるかを推測することはできませんが、 offlineimap は同期するメールボックスを含む muttrc フラグメントを生成することができます。

{{hc|~/.offlineimaprc|<nowiki>
[mbnames]
enabled = yes
filename = ~/.mutt/mailboxes
header = "mailboxes "
peritem = "+%(accountname)s/%(foldername)s"
sep = " "
footer = "\n"
</nowiki>}}

そして以下の行を{{ic|~/.mutt/muttrc}}に追加します。

{{hc|~/.mutt/muttrc|<nowiki>
# IMAP: offlineimap
set folder = "~/Mail"
source ~/.mutt/mailboxes
set spoolfile = "+account/INBOX"
set record = "+account/Sent\ Items"
set postponed = "+account/Drafts"
</nowiki>}}

{{ic|account}}は{{ic|~/.offlineimaprc}}でIMAPアカウントにつけた名前です。

=== Gmail の設定 ===

このリモートリポジトリは Gmail をサポートするために特別に設定されており、フォルダ名を大文字から小文字に置き換えたり、その他の細かい追加を行います。この設定では「すべてのメール」フォルダーを同期しないことに注意して下さい。「すべてのメール」は通常不要であり、この同期をスキップすることにより帯域幅コストを抑えるためです:

{{hc|~/.offlineimaprc|<nowiki>
[Repository gmail-remote]
type = Gmail
remoteuser = user@gmail.com
remotepass = password
nametrans = lambda foldername: re.sub ('^\[gmail\]', 'bak',
re.sub ('sent_mail', 'sent',
re.sub ('starred', 'flagged',
re.sub (' ', '_', foldername.lower()))))
folderfilter = lambda foldername: foldername not in ['[Gmail]/All Mail']
# OfflineImap 6.5.4 で必要
sslcacertfile = /etc/ssl/certs/ca-certificates.crt
# https://github.com/OfflineIMAP/offlineimap/issues/573（バージョン7.0.12、7.2.1）の対処に必要
ssl_version = tls1_2
</nowiki>}}

{{Note|
* Gmailが別の言語に設定されている場合、フォルダ名も翻訳されているように見える場合があります。例: 「sent_mail」の代わりに「送信済みメール」
* バージョン6.3.5以降では、offlineimapはローカルのフォルダに合わせてリモートのフォルダも作成します。そのため、この名前の翻訳ルールの効果を逆転させる名前の翻訳ルールがローカルリポジトリにも必要になるかもしれません。名前の逆翻訳ルールを作りたくない場合は、リモートの設定に次のように記述することで、リモートフォルダの作成を無効にできます: {{ic|<nowiki>createfolders = False</nowiki>}}
* 2012年10月1日現在、gmail の SSL 証明書のフィンガープリントはいつも同じだとは限りません。このため {{ic|cert_fingerprint}} を使うよりも {{ic|sslcacertfile}} を使って SSL の確認をするほうが良いでしょう ([[#SSL フィンガープリントが一致しない]]を参照)。
}}

==== oama経由のOAuth2アクセストークン ====

[https://github.com/pdobsan/oama oama] ({{AUR|oama-bin}})は、IMAP/SMTPクライアントにOAuth2認証の更新機能と承認を提供するユーティリティです。

OfflineIMAPは、設定からPythonコードを呼び出すことができます。したがって、まず{{ic|[general]}}セクションで、以下の行を追加します。

{{hc|~/.offlineimaprc|2=
[general]
pythonfile = ~/.offlineimap.py
}}

Pythonファイルに以下のコードを追加して、''oama''を経由してOAuth2アクセストークンを取得します:

{{hc|~/.offlineimap.py|2=
import subprocess

def get_token(email_address):
return subprocess.run(["oama", "access", email_address], capture_output=True, text=True).stdout
}}

そして設定ファイルに戻り、Gmailアカウントのrepositoryセクションに以下を追加してください:

{{hc|~/.offlineimaprc|2=
auth_mechanisms = XOAUTH2
oauth2_client_id = ''YOUR_OAUTH2_CLIENT_ID''
oauth2_client_secret = ''YOUR_OAUTH2_CLIENT_SECRET''
oauth2_request_url = <nowiki>https://accounts.google.com/o/oauth2/token</nowiki>
oauth2_access_token_eval = get_token("''YOUR_EMAIL_ADDRESS_FOR_THIS_ACCOUNT''")
}}

=== パスワードの管理 ===

==== .netrc ====

以下の行を {{ic|~/.netrc}} に追加してください:

machine hostname.tld
login [your username]
password [your password]

ファイルに600や700のような適切な権限を与えることを忘れないでください。

$ chmod 600 ~/.netrc

{{Note|OfflineIMAPは、{{ic|.netrc}}ファイルに複数のアカウントが保存されている場合、パスワードを取得する方法を[https://github.com/OfflineIMAP/offlineimap/issues/295 知りません]。}}

==== GPG を使う ====

GNU Privacy Guard を使うことで暗号化ファイルにパスワードを保存することができます。このセクションの設定を行う前にまず [[GnuPG]] をセットアップしてください。[[GnuPG#gpg-agent|パスワードを入力しなくても]] GPG の秘密鍵をいつでも使えるようにしておく必要があります。

まずプレーンテキストファイルにメールアカウントのパスワードを入力してください。暗号化されていないパスワードがディスクに書き込まれないように、ファイルの作成は [[tmpfs]] 上の {{ic|700}} パーミッションの安全なディレクトリで行なって下さい。それから、公開鍵でファイルを暗号化します:

$ gpg --default-recipient-self -e ''/path/to/plain/password''

必要なくなったプレーンテキストファイルは削除してください。暗号化したファイルは最終的に必要な場所 (例: {{ic|~/.offlineimappass.gpg}}) に移動してください。

次にパスワードを復号化する python 関数を作成します:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python2
from subprocess import check_output

def get_pass():
return check_output("gpg -dq ~/.offlineimappass.gpg", shell=True).strip("\n")
}}

上記のファイルを {{ic|~/.offlineimaprc}} からロードして、定義した関数を指定してください:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository ''example'']
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass()
...
}}

==== pass を使う ====

[[pass]] は GPG ベースのシンプルなコマンドラインのパスワードマネージャです。

最初にメールアカウントのパスワードを作成:

$ pass insert Mail/''account''

次にパスワードを復号化する python 関数を作成:

{{hc|~/.offlineimap.py|2=
#! /usr/bin/env python2
from subprocess import check_output

def get_pass(account):
return check_output("pass Mail/" + account, shell=True).splitlines()[0]
}}

上記はマルチアカウントセットアップの例です。前述の ''pass'' の引数はカスタマイズできます。

{{ic|~/.offlineimaprc}} からファイルをロードして、定義した関数を指定:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.offlineimap.py
...

[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("Gmail")
...
}}

==== Gnome Keyring ====

リモートリポジトリの設定では、remoteusereval/remotepassevalフィールドを、ユーザー名/パスワードに評価するカスタムPythonコードに設定できます。このコードは、'pythonfile' 設定フィールドで示されたpythonスクリプト上で定義された関数への呼び出しにすることができます。以下のサブセクションに従って{{ic|~/.offlineimap.py}}を作成し、設定で使用します。

{{bc|<nowiki>
[general]
pythonfile = ~/.offlineimap.py

[Repository examplerepo]
type = IMAP
remotehost = mail.example.com
remoteusereval = get_username("examplerepo")
remotepasseval = get_password("examplerepo")
</nowiki>}}

===== gkgetsecret.py =====

{{Style|これは単一のサブセクションであるため、上記の導入と統合する必要があります。}}

{{Pkg|gnome-keyring}}、{{AUR|python2}}、{{AUR|python2-gobject}}、{{Pkg|libsecret}}がインストールされていることを確認して下さい。そして、{{ic|~/.offlineimap.py}}を次の内容で作成します: [https://pastebin.com/wzVfSac8 gkgetsecret.py]。さらに、上記のように{{ic|~/.offlineimaprc}}に{{ic|1=pythonfile = ~/.offlineimap.py}}を設定します。

{{Pkg|seahorse}}を使ってパスワードを作成した場合、その説明からパスワードを取得できます。例えば、''Password for me@myworkemail.com'' という説明つきのgnome-keyringに保存された ''work'' レポジトリのパスワードは、{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remotepasseval = get_pw_from_desc("Password for me@myworkemail.com")

同様にユーザー名も保存したい設定の場合、 ''secret-tool'' でパスワードを生成する方が、ユーザー名やリポジトリ名などの属性を設定するのに使えるのでよいでしょう。以下のコマンドでパスワードを作成することを検討して下さい。
$ secret-tool store --label "Password for Work Email" username me@myworkemail.com repo Work

このアカウントのユーザー名とパスワードは{{ic|~/.offlineimaprc}}に以下の行を追加することによって取得できます。

[Repository Work]
...
remoteusereval = get_val_from_attrs("username", "repo", "Work")
remotepasseval = get_pw_from_attrs("repo", "Work")

==== python-keyring ====

どのキーリングでも使える一般的な解決策があります。{{Pkg|python-keyring}}をインストールし、~/.offlineimaprcを以下のように変更して下さい。

{{bc|<nowiki>
[general]
pythonfile = /home/user/offlineimap.py
...
[Repository RemoteEmail]
remoteuser = username@host.net
remotepasseval = keyring.get_password("host","username")
...
</nowiki>}}

そして、 ~/offlineimap.py のどこかに {{ic|import keyring}} を追加して下さい.

あとはパスワードを設定するだけです。次のようなpythonスクリプトか、

{{bc|$ python
>>> import keyring
>>> keyring.set_password("host","username", "MYPASSWORD")}}

あるいはpython-keyringパッケージで提供されているkeyringコマンドを使えます。

$ keyring --help
$ keyring set host username
Password for 'username' in 'host':
$ keyring get host username
password

これで、平文として保存したり毎回入力したりする必要なく、(kwallet/gnome-)キーリングからパスワードを取り出せるようになります。

==== Emacs EasyPG ====

http://www.emacswiki.org/emacs/OfflineIMAP#toc2 を見てください。

==== KeePassXCとFreedesktop.orgのsecret-service ====

{{Pkg|libsecret}}をインストールし、KeepassXCの設定でFreedesktop.org secret-service統合を有効化、''Database Settings > Secret Service Integration''でエントリを公開し、''Edit Entry > Advanced''設定で{{ic|Title}}追加属性に{{ic|account@name.org}}を追加します。これで、{{ic|secret-tool lookup Title account@name.org}}コマンドでパスワードがコンソールに表示されるはずです。次に、pythonスクリプトを作成します:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import os
from subprocess import check_output

def get_pass(account):
return check_output("secret-tool lookup Title " + account, shell=True).splitlines()[0].decode("UTF-8")
}}

{{Pkg|python-secretstorage}}に依存する同等のスクリプトは以下の通りです:

{{hc| ~/.script.py|2=
#! /usr/bin/env python
import secretstorage
from contextlib import closing
def get_pass(title):
with closing(secretstorage.dbus_init()) as conn:
assert(secretstorage.check_service_availability(conn))
collection = secretstorage.get_default_collection(conn)
if collection.is_locked():
collection.unlock()
matches = collection.search_items({"Title": title})
entry = next(matches)
if entry.is_locked():
entry.unlock()
return(entry.get_secret())
}}

{{ic|~/.offlineimaprc}}からこのファイルをロードし、定義された関数を指定します:

{{hc|~/.offlineimaprc|2=
[general]
# 任意のロードするPythonコードのパス
pythonfile = ~/.script.py
...
[Repository Gmail]
# 暗号化されたパスワードを復号化して読み取る
remotepasseval = get_pass("account@name.org")
...
}}

== トラブルシューティング ==

=== UI の上書きと自動更新の設定 ===

トラブルシューティングのために、より詳細なUI、バックグラウンド同期なし、場合によってはデバッグレベルでofflineimapを起動すると便利な場合があります:
$ offlineimap [ -o ] [ -d <debug_type> ] [ -u <ui> ]
;-o
:自動更新、キープアライブ等を無効にします。

;-d <debug_type>
:''<debug_type>''は{{Ic|imap}}、{{Ic|maildir}}、{{Ic|thread}}のいずれかです。imapとmaildirのデバッグが圧倒的に最も便利です。

;-u <ui>
:''<ui>''は{{Ic|CURSES.BLINKENLIGHTS}}、{{Ic|TTY.TTYUI}}、{{Ic|NONINTERACTIVE.BASIC}}、{{Ic|NONINTERACTIVE.QUIET}}、{{Ic|MACHINE.MACHINEUI}}のいずれかです。デバッグ目的ではTTY.TTYUIで十分です。

{{Note|新しいバージョンでは以下を<ui>に使います: {{Ic|blinkenlights}}、{{Ic|ttyui}}、{{Ic|basic}}、{{Ic|quiet}}、{{Ic|machineui}}}}

=== フォルダが作成できない ===

[https://alioth-lists.debian.net/pipermail/offlineimap-project/2011-September/010200.html こちら]にあるように、バージョン6.5.3でofflineimapはリモートリポジトリにフォルダを作成できるようになりました。

これにより、リモートリポジトリで{{Ic|nametrans}}を使用すると以下のようなエラーが発生する可能性があります:
ERROR: Creating folder bar on repository foo-remote
Folder 'bar'[foo-remote] could not be created. Server responded: ('NO', ['[ALREADYEXISTS] Duplicate folder name bar (Failure)'])

解決策は、ローカルリポジトリに逆{{Ic|nametrans}}ラムダを提供することです。例:

{{hc|~/.offlineimaprc|<nowiki>
[Repository foo-local]
nametrans = lambda foldername: foldername.replace('bar', 'BAR')

[Repository foo-remote]
nametrans = lambda foldername: foldername.replace('BAR', 'bar')
</nowiki>}}

* 正しい逆マッピングを行うには、{{Ic|offlineimap --info}}の出力が役に立つでしょう。
* マッピングを更新したら、影響を受けるアカウントの{{Ic|$HOME/.offlineimap/}}下のフォルダを全て削除する必要があるかもしれません。

=== SSL フィンガープリントが一致しない ===

ERROR: Server SSL fingerprint 'keykeykey' for hostname 'example.com' does not match configured fingerprint. Please verify and set 'cert_fingerprint' accordingly if not set yet.

これを解決するには、{{ic|~/.offlineimaprc}} ({{ic|1=ssl = yes}}と同じセクション)に以下のいずれかを追加します。
* リモートサーバーの証明書のフィンガープリントを{{ic|cert_fingerprint}}に追加します。これは、リモートサーバーの証明書が与えられたフィンガープリントに一致するかチェックします。
cert_fingerprint = keykeykey
* もしくは、システムのCA証明書ファイルを{{ic|sslcacertfile}}に追加します。{{Pkg|ca-certificates}}のインストールが必要です。これは、リモートのSSL証明書チェーンを、そのファイルの認証局に対して検証します。
{{bc|1=sslcacertfile = /etc/ssl/certs/ca-certificates.crt}}

=== Copying message, connection closed ===

ERROR: Copying message -2 [acc: email] connection closed
Folder sent [acc: email]: ERROR: while syncing sent [account email] connection closed

上記の問題はローカルとサーバーで同じメッセージが作成されていることが原因です。メールのプロバイダが自動的にローカルクライアントと同じフォルダに送信したメールを保存した場合に発生します。この問題が起こったときはローカルクライアントで送信済みメッセージの保存を無効化してください。

== 参照 ==

* [http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project OfflineIMAP 公式メーリングリスト]
* [http://pbrisbin.com/posts/mutt_gmail_offlineimap/ Mutt + Gmail + Offlineimap] - brisbinによるシンプルなgmail/muttの設定の概要。cronでofflineimapの同期を保持させています。

Spotify

2025-05-28T13:09:55Z

Sanlun: サードパーティクライアントを英語版より補充

[[Category:音楽]]
[[Category:ストリーミング]]
[[en:Spotify]]
[[es:Spotify]]
[[Wikipedia:ja:Spotify|Spotify]] は、フリーミアム型のビジネスモデルを採用したデジタル音楽ストリーミングサービスです。この記事は主に、Spotify が積極的にサポートしていない、半公式でプロプライエタリな '''Spotify for Linux''' クライアントについて書かれています [https://www.spotify.com/us/download/linux/] その他に、[https://open.spotify.com/ オンラインプレイヤー] や多くのオープンソース [[#サードパーティのクライアント|サードパーティのクライアント]] について紹介。

== インストール ==

{{Pkg|spotify-launcher}} を [[インストール]] します。このパッケージは、ホームディレクトリ内のユーザーごとのインストールを管理し、Spotify が [[pacman]] とは独立して自身を更新できるようにします (他のオペレーティングシステムで Spotify が自己更新する方法と似ています。)

[[pacman]] を使用して Spotify の更新を管理したい場合は、代わりに [https://www.spotify.com/us/download/linux/Spotify for Linux] を再パッケージ化する {{AUR|spotify}} を使用してください。ローカルファイルを追加して再生する必要がある場合は、{{Pkg|zenity}} と {{Pkg|ffmpeg4.4}} を追加でインストールする必要があります。

=== サードパーティクライアント ===

==== プレミアム会員 ====

{{Note|ここにリストされているすべてのクライアントは、Spotify からのストリーミングにプレミアムアカウントが '''必要''' です。}}

* {{App|Librespot|オープンソースの Spotify クライアントライブラリ。公式のクローズドソースの ''libspotify'' を使わなくても Spotify のサービス (ストリーミング) をアプリケーションから使えるようになります。|https://github.com/plietar/librespot|{{AUR|librespot-git}}}}
* {{App|[https://www.mopidy.com/ Mopidy]|[[Music Player Daemon]] のプラグインベースの実装。拡張を使うことで Spotify をストリーミング可能。|https://github.com/mopidy|{{Pkg|mopidy}} + {{AUR|mopidy-spotify}}}}
* {{App|ncspot|クロスプラットフォームの ncurses は、ncmpc などにインスパイアされた Rust で書かれた Spotify クライアント。|https://github.com/hrkfdn/ncspot|{{Pkg|ncspot}}}}
* {{App|Psst|Rust を使用し GUI で作成された高速でマルチプラットフォームの Spotify クライアント。|https://github.com/jpochyla/psst|{{AUR|psst-git}}}}
* {{App|Spicetify|Spotify クライアントをカスタマイズするための強力なコマンドラインツール。テーマ、拡張機能などが含まれます。|https://spicetify.app/|{{AUR|spicetify-cli}}}}
* {{App|Spot|Gtk/Gnome デスクトップ用の Rust ネイティブな Spotify クライアント。|https://github.com/xou816/spot|{{AUR|spot-client}}}}
* {{App|Spotifyd|UNIX デーモンとして実行されるオープンソースの Spotify クライアント。Spotifyd は公式クライアントと同じように音楽をストリーミングし、軽量でより多くのプラットフォームをサポートします。Spotifyd は Spotify Connect プロトコルもサポートしており、公式クライアントからコントロールできるデバイスとして表示されます。|https://github.com/Spotifyd/spotifyd|{{Pkg|spotifyd}}}}
* {{App|spotify-qt|C++ で書かれ Qt を使った軽量な Spotify クライアント。|https://github.com/kraxarn/spotify-qt|{{AUR|spotify-qt}}}}
* {{App|spotify-player|spotify-tuiの新しく、機能豊富な代替。|https://github.com/aome510/spotify-player|{{Pkg|spotify-player}}}}
* {{App|spotify-tui|Rust で書かれたターミナル用の Spotify クライアント。2021年11月17日から更新されていません。|https://github.com/Rigellute/spotify-tui|{{AUR|spotify-tui}}}}
* {{App|Tizonia|Linux 向けのコマンドラインクラウド音楽プレーヤーで、Spotify、Google Play Music、YouTube、SoundCloud、Plex サーバ、Chromecast デバイスをサポート。|http://tizonia.org/docs/spotify/|{{AUR|tizonia-all}}}}

==== 無料会員 ====
* {{App|Spotube|プレミアムアカウントもElectronも必要としないオープンソースなSpotify-Youtubeクライアント。Spotifyからデータを取得し、YouTubeからオーディオを再生します。|https://spotube.krtirtho.dev/|{{AUR|spotube}}}}

== ヒントとテクニック ==

=== ストレージサイズを制限する ===

Spotify はキャッシュ用のストレージサイズを自動的に管理しますが、[[ファイルシステム]] がいっぱいにならないようにサイズ制限を強制したい場合があります。

{{ic|/home/''user''/.config/spotify/prefs}} に [[ヘルプ:読み方#追加, 追記, 作成, 編集|Append]] {{ic|storage.size}} (MB 単位で) を追加します、たとえば 3072MB のストレージサイズ:

{{hc|~/.config/spotify/prefs|2=
storage.size=3072
}}

=== グローバルなメディアホットキー ===

{{Tip|大抵は[[デスクトップ環境]]に初めから設定されているキーボードショートカットで Spotify クライアントを使うことができます。例えば [[Cinnamon]] ではデフォルトでプレイヤーを制御できるようにバインドが設定されており (Preferences -> Keyboard -> Shortcuts -> Sound and Media)、お好きなキーを押すことで簡単にショートカットを変えることができます。}}

Spotify は {{ic|XF86AudioPlay}} などのメディアキーをサポートしています。ただし何も設定をしていなかった場合 Spotify の中でしか動作しません。[[xbindkeys]] などを使用してグローバルのメディアキーの押下を取得してから、以下のどれか方法を使うことで Spotify に転送することができます。xbindkeys を使っている場合、インストールやキーの設定を行った後に Spotify を再起動しないと、キーイベントが正しく取得されません。

==== MPRIS ====

Spotify クライアントは [https://specifications.freedesktop.org/mpris-spec/latest/ MPRIS2] D-Bus インターフェイスを実装しており外部からコントロールすることができます。

==== pactl (pulseaudio) ====

MPRIS プロトコルコマンドにはボリュームコントロールが含まれていません。これは、音量変更要求を無視する Spotify 自体の中で壊れています。しかし、pulseaudio の入力シンクを経由して音量を制御することは可能です。

$ pactl set-sink-input-volume "$current_sink_num" +1% #volume up by 1%
$ pactl set-sink-input-volume "$current_sink_num" -1% #volume down by 1%
$ pactl set-sink-input-mute "$current_sink_num" toggle #mute toggler

"$current_sink_num"のシンク番号は、コマンドの出力で確認できます。
{{hc|head=$ pactl list sink-inputs|2=
Sink Input #'''3''' << here
Driver: protocol-native.c
[...]
application.name = "Spotify"}}

ボリュームを変更するためのスクリプトを作成し、[[デスクトップ環境]] 構成または次のセクションで説明する xdotool を介してキーボードショートカットなどにバインドできます、ここではいくつかの例を示します。

Bash:
#!/bin/bash
LANGUAGE="en_US"
app_name="Spotify"
current_sink_num=''
sink_num_check=''
app_name_check=''
pactl list sink-inputs |while read line; do \
sink_num_check=$(echo "$line" |sed -rn 's/^Sink Input #(.*)/\1/p')
if [ "$sink_num_check" != "" ]; then
current_sink_num="$sink_num_check"
else
app_name_check=$(echo "$line" \
|sed -rn 's/application.name = "([^"]*)"/\1/p')
if [ "$app_name_check" = "$app_name" ]; then
pactl set-sink-input-volume "$current_sink_num" +1%
fi
fi
done

このスクリプトは、ユーザー [https://unix.stackexchange.com/users/52126/miko%c5%82ak Mikołak] が [https://unix.stackexchange.com/questions/208784/command-line-per-application-volume-maybe-amixer-or-pactl/209047#209047 この投稿] で行った作業に基づいています

残念ながら、このスクリプトは最速のソリューションではありません。キーボードのホットキーを使用して複数回実行すると、遅延が発生する可能性があります。

より高速な (10倍程度) Python コード (少なくとも Python 3.7 をインストールする必要があります):

#!/usr/bin/env python3
#Author: Marcin Kocur, attribution license: https://creativecommons.org/licenses/by/4.0/
import subprocess
import os
x=0
y=0
env = os.environ
env['LANG'] = 'en_US'
app = '"Spotify"'
pactl = subprocess.check_output(['pactl', 'list', 'sink-inputs'], env=env).decode().strip().split()
if app in pactl:
for e in pactl:
x += 1
if e == app:
break
for i in pactl[0 : x -1 ]:
y += 1
if i == 'Sink' and pactl[y] == 'Input' and '#' in pactl[y + 1]:
sink_id = pactl[y+1]
if i == 'Volume:' and '%' in pactl[y + 3]:
volume = pactl[y + 3]
sink_id = sink_id[1: ]
volume = volume[ : -1 ]
if int(volume) < 100:
subprocess.run(['pactl', 'set-sink-input-volume', sink_id, '+1%'])

.py ファイルで保存します。最後の行が実行部分ですので、コマンドを調整して音量を下げたり、ミュートを切り替えたりできます。

=== トラック通知を無効化 ===

バージョン0.9.10以降、トラック変更通知はデフォルトで有効になりました。それらは非常に煩わしい場合があります。それらを無効にするには、以下を追加:

{{hc|~/.config/spotify/Users/''spotify login''-user/prefs|2=
ui.track_notifications_enabled=false
}}

{{ic|1=--ui.track_notifications_enabled=false}} オプションを使用して spotify を起動することでも可能です。

=== トラック通知を表示 ===

{{Pkg|playerctl}} には {{pkg|python-gobject}} と [[dunst]] のような通知デーモンと一緒に使用するライブラリが付属しており、トラックが変更されたときにアーティストとタイトルを通知で表示することができます。

#!/usr/bin/env python3

from gi.repository import Playerctl, GLib
from subprocess import Popen

player = Playerctl.Player()

def on_track_change(player, e):
track_info = '{artist} - {title}'.format(artist=player.get_artist(), title=player.get_title())
Popen(['notify-send', track_info])

player.on('metadata', on_track_change)

GLib.MainLoop().run()

=== 何度も再生されるラジオトラックをスキップ ===

{{Pkg|playerctl}} ライブラリの他の使い道としてラジオで何度も再生されるトラックをスキップすることができます。ラジオ局で聞きたくない曲を低く評価する必要はもうありません。

#!/usr/bin/env python3

from gi.repository import Playerctl, GLib

player = Playerctl.Player()

played_out = ['Zu Fuss', 'Walk And Talk', 'Neuland']

def on_track_change(player, e):
if player.get_title() in played_out:
player.next()

player.on('metadata', on_track_change)

GLib.MainLoop().run()

=== コマーシャルをミュート ===

{{Warning|コマーシャルのミュートは Spotify ではサポートされていないため、一時的に禁止される可能性があります [https://www.theverge.com/2018/3/5/17080920/spotify-cracking-down-piating-premium-free-account]}}

==== spotblock ====

[https://github.com/mahkoh/spotblock spotblock] ({{AUR|spotblock-git}}) は systemd デーモンとして動作するリソース消費の少ない広告ブロッカーです。

==== Spotify-AdKiller ====

{{AUR|spotify-adkiller-git}} は、Spotify 広告をブロックするもう 1 つの代替手段です。

==== spotblock-rs ====

{{AUR|spotblock-rs}} は、Spotify の広告をミュートする高速かつ軽量のプログラムです。[[PipeWire]] でも機能します。

==== Hosts ファイル ====

hosts ファイルに以下の行を追加することでも Spotify の広告をブロックできます:

{{hc|/etc/hosts|<nowiki>
# Block spotify ads
127.0.0.1 media-match.com
127.0.0.1 adclick.g.doublecklick.net
127.0.0.1 www.googleadservices.com
127.0.0.1 open.spotify.com
127.0.0.1 pagead2.googlesyndication.com
127.0.0.1 desktop.spotify.com
127.0.0.1 googleads.g.doubleclick.net
127.0.0.1 pubads.g.doubleclick.net
127.0.0.1 audio2.spotify.com
127.0.0.1 www.omaze.com
127.0.0.1 omaze.com
127.0.0.1 bounceexchange.com
# 127.0.0.1 spclient.wg.spotify.com
127.0.0.1 securepubads.g.doubleclick.net
127.0.0.1 8.126.154.104.bc.googleusercontent.com
127.0.0.1 104.154.126.8
</nowiki>}}

{{Note|''spclient.wg.spotify.com'' は、最近再生された曲だけでなく、ラジオや毎日のミックスもブロックしているようです}}

=== リモートコントロール ===

==== SSH でコマンドを送信 ====

サーバー上に ssh がセットアップされている場合、以下のコマンドでクライアントからリモートの Spotify インスタンスに制御コマンドを送信できます:

$ ssh user@host ''yourcommand''

''yourcommand'' は、サーバーにインストールした [https://code.google.com/p/spotifycmd/ spotifycmd] や上述の Linux 版の dbus スクリプトなどに置き換えてください。

==== SSH で Spotify ウィンドウを取得する ====

サーバーをリモートで制御するために TeamViewer や VNC などでデスクトップ全体を取得するのでなければ、サーバーからクライアントに Spotify ウィンドウのみを取得することもできます。

サーバー側に sshd を設定して、サーバーとクライアントの両方に x11vnc をインストールしてください。クライアント側には tigervnc をインストールしてください。以下のスクリプトを使うことでデスクトップ全体を取得したり、Spotify ウィンドウだけを取得できます。MPD の GUI クライアントと同じように使うことができます。

{{bc|<nowiki>
#!/bin/bash
# vncget.sh

if [[ $1 == all ]];then
ssh -f -t -L 5900:localhost:5900 user@host "x11vnc -q -display :0 -auth .Xauthority"
else
ssh -f -t -L 5900:localhost:5900 user@host ".bin/vncgetspotify.sh"
fi

for i in {1..4}; do
sleep 2
if vncviewer localhost:0; then break; fi
done
</nowiki>}}

{{bc|<nowiki>
#!/bin/bash
# vncgetspotify.sh

export DISPLAY=:0

id=$(wmctrl -lx | awk '/spotify.exe.Wine/ {print $1}')
[[ -z $id ]] && id=$(wmctrl -lx | awk '/spotify.Spotify/ {print $1}')

x11vnc -sid $id -display :0 -auth .Xauthority
</nowiki>}}

2番目のスクリプトをサーバーの {{ic|~/.bin/vncgetspotify.sh}} にコピーして、1番目のスクリプトをクライアントのどこかに保存してください。

最後に、Spotify ウィンドウを取得するには、クライアント側で以下を実行:

$ sh vncget.sh

デスクトップ全体を取得する場合:

$ sh vncget.sh all

===HiDPI モード===
最新の Spotify ビルドも DPI に対応していないため、ターミナルコマンドでインターフェイスをスケールする量を指定します:
$ spotify --force-device-scale-factor=''X''

X はインターフェイスをスケールする量に置き換えて下さい。例: 2。

デスクトップファイルを使用する場合、パッケージを更新したときにファイルが上書きされないように、ローカルのアプリケーションフォルダにデスクトップファイルをコピーしてください:
$ cp /usr/share/applications/spotify.desktop ~/.local/share/applications/

{{ic|~/.local/share/applications/spotify.desktop}} を編集して {{ic|--force-device-scale-factor}} オプションを追加:

{{hc|spotify.desktop|2=
[Desktop Entry]
Name=Spotify
GenericName=Music Player
Comment=Spotify streaming music client
Icon=spotify-client
Exec=spotify '''--force-device-scale-factor=2''' %U
TryExec=spotify
Terminal=false
Type=Application
Categories=Audio;Music;Player;AudioVideo
MimeType=x-scheme-handler/spotify
}}

変更を適用するにはデスクトップマネージャを再起動する必要があります。

=== Wayland 下で実行 ===

Xwayland で Spotify を実行すると、特に画面サイズと向きが混在している場合に、いくつかの異常が発生する可能性があります。いくつかのフラグを渡すと、Spotify を Wayland モードで実行できます: {{ic|1=--enable-features=UseOzonePlatform --ozone-platform=wayland}}

デスクトップから起動するときに Wayland モードで起動するために、これらの変更を {{ic|spotify.desktop}} ファイルに追加できます。
{{Note|{{AUR|spotify}} を使用する場合は、代わりに {{ic|~/.config/spotify-flags.conf}} に 1 行に 1 つのフラグを置くことができます。}}

詳細については、前のセクション [[Spotify#HiDPI モード|HiDPI モード]] を参照してください。

== トラブルシューティング ==

=== デスクトップ環境のアラート (ビープ) によって Spotify がミュートになってしまう ===

PulseAudio の設定ファイルで "module-role-cork" をコメントアウトしてください。

テキストエディタで {{ic|/etc/pulse/default.pa}} を開いて以下の行をコメントアウトしてください:

load-module module-role-cork

もしくは以下のコマンドを実行してアンロードしてください:

$ pactl unload-module module-role-cork

=== 検索を使うとインターフェイスが点滅してクラッシュする ===

Spotify は古いバージョンの Chromium Embedded Framework を使っており検索を使おうとするとバグによってクラッシュします。以下のコマンドラインオプションを使うことで回避できます:

--force-device-scale-factor=1.0000001

=== DWM で Spotify Linux を使用した時に画像が点滅したり正しく表示されない ===
フローティングウィンドウで spotify を起動してください。

以下のルールを {{ic|config.h}} の rules 配列に追加してください:
{ "Spotify", NULL, NULL, 2, True, -1 },

上記の設定でウィンドウモードと関係なく spotify タグが "2" のフローティングウィンドウとして起動されます。新しい設定を適用するために dwm を再コンパイル・インストールしてください。

=== 検索やブラウザ、ラジオが動作しない ===

ブラウジングなどのタブで何も表示されなかったり、検索フィールドが機能しなかったりラジオページが表示されない場合 (起動したときにフリーズして入力に反応しなくなる)、ロケールの設定が原因かもしれません ([http://community.spotify.com/t5/Help-Desktop-Linux-Mac-and/Bug-Desktop-Linux-0-9-0-133-gd18ed589-Having-mixed-locale-breaks/td-p/418270 バグレポート] を参照)。

Spotify を起動する前に {{ic|LC_NUMERIC}} 環境変数を {{ic|en_US.utf8}} に設定してみてください。

=== GUI スレッドのデッドロック ===

Awesome などのタイル型ウィンドウマネージャでは、新しい曲やプレイリストをダブルクリックしたときにデッドロックが発生することがあります。{{ic|~/.config/spotify/Users/[1-9]*-user/prefs}} ファイルを編集して以下の行を追加してください:

ui.track_notifications_enabled=false

そして Spotify を再起動します。

{{Note|
* 問題の原因は複数存在し、上記の修正では特定のバージョンの Spotify クライアントと Awesome でしか問題が解決されません。Debian や Ubuntu ユーザーは Spotify 0.9.17.1.g9b85d436 と Awesome 3.4.15 で別の原因があると報告しています。
* Spotify 1.0.17.75-2 現在、{{ic|1=ui.track_notifications_enabled=false}} は無視されます。また、一部のユーザーは Awesome 3.5.6 からデッドロックが発生しなくなったと報告しています。デッドロックの原因はおそらく Awesome から呼び出されるスクリプトが Spotify の D-Bus プロパティに依存しているためかもしれません。詳しくは [https://github.com/acrisci/playerctl/issues/20] を参照。
}}

=== プロキシを使ったときにアルバム画像が表示されない、四角が表示される ===

spotify を終了して、spotify の設定 {{ic|~/.config/spotify/prefs}} を開いて下さい。

@https を @http に変更してください:

network.proxy.addr="your-proxy.com:80<strong>@http</strong>"
network.proxy.mode=2

[http://community.spotify.com/t5/Help-Desktop-Linux-Mac-and/Mac-Windows-0-9-0-128-Apps-can-t-connect-anywhere-behind-proxy/m-p/448704#M52332] を参照。

{{Note|1.0.17 現在、上記のように https を http に置き換えると全く接続できなくなることがあります。その場合、GUI では 'no proxy' に設定してから {{Pkg|proxychains-ng}} で全ての TCP 接続を強制的にプロキシを通すようにする方法があります。}}

=== Spotify でローカルネットワーク上の他のデバイスが検出されない ===

ファイアウォールを使っている場合、UDP と TCP のポート 57621 を開いて下さい。[[iptables]] の[[シンプルなステートフルファイアウォール]]を使用している場合、以下で設定できます:

iptables -A TCP -p tcp --dport 57621 -j ACCEPT -m comment --comment spotify
iptables -A UDP -p udp --dport 57621 -j ACCEPT -m comment --comment spotify

ローカルネットワークの送信元と宛先を制限することもできます。

Spotify Connect を使用してワイヤレススピーカーやオーディオビデオレコーダで音楽を再生する場合、ファイアウォールを設定して Spotify の mDNS ルックアップが通るようにする必要があります。ランダムな非特権ポートが使われるため [https://community.spotify.com/t5/Desktop-Linux-Windows-Web-Player/Spotify-Connect-and-iptables-netfilter/td-p/1235049]、ファイアウォールのルールは面倒なものになります。送信元ポート 1900 または 5353 を以下のように設定してください:

iptables -A UDP -p udp --sport 1900 --dport 1025:65535 -j ACCEPT -m comment --comment spotify
iptables -A UDP -p udp --sport 5353 --dport 1025:65535 -j ACCEPT -m comment --comment spotify

=== ダークテーマを使っている場合に検索バーのテキストが読めない ===

検索バーのテキストは白色に決められているため、Qt のダークテーマを使っている場合見えなくなります。色を上書きすることで解決できます。

まず (ホームフォルダなど) 読み書きができる場所に css ファイルを作成してください。名前は何でもかまいません (例: ''spotify-override.css'')。

作成した css ファイルを開いて以下を追加します:

QLineEdit { color: #000 }

ファイルを保存して終了してください。次に、Spotify のランチャーの末尾に以下を追加します (css ファイルのパスは実際のパスに置き換えて下さい):

-stylesheet=/home/user/spotify-overide.css

起動パスは以下のようになります:

/usr/share/spotify/spotify-client/spotify -stylesheet=/home/user/spotify-override.css

=== ローカルファイルを再生できない ===

ローカルファイルを再生しようとするとセグメンテーション違反や以下のようなエラーメッセージが発生する場合:

This song is not available. If you have the file on your computer you can import it.

依存パッケージが欠けているのが原因です。PulseAudio を使っている場合、{{aur|ffmpeg-compat-54}} をインストールすることで解決します。インストール時に PGP の検証エラーが起こる場合は適切な PGP 鍵をインポートしてください:

$ gpg --keyserver pgp.mit.edu --recv-keys FCF986EA15E6E293A5644F10B4322F04D67658D8

=== ウィンドウマネージャのルールが反映されない ===

特定のワークスペースで Spotify を起動したり、起動時に最大化するなどのルールをウィンドウマネージャで設定しても Spotify には反映されません。Spotify が ICCCM の仕様に違反しており、ウィンドウを作成する前に ''WM_CLASS'' プロパティを設定しないためです。[https://github.com/dasJ/spotifywm spotifywm] を使用することで解決できます。

=== GUI の境界線がなくなり、cinnamon パネル上の画面全体を占有する ===

ウィンドウの境界が消えてしまうという問題があって、アプリがフルスクリーンになっても、ウィンドウをドラッグしたり、シナモンのサイズを変更したりできない場合は、デフォルトでテキストファイル {{ic|/home/yourusername/.config/Spotify/Users/yourusername-user/prefs}} にある設定が原因かもしれません。

app.window.position.width=1366
app.window.position.height=768

おそらく、両方の解像度が "メイン" モニタの解像度以上の値に一致する場合、これは二つのモニタから一つのモニタだけに移ったときに起こる可能性があります。解決策として、 Spotify を閉じ、 {{ic|prefs}} ファイルを編集して上記の両方の設定を削除し、保存してから再度 Spotify を実行してください。

=== Wayland 環境で設定が開けない ===

Wayland を使用している場合、"設定" ボタンをクリックしても何も起こりません。代わりにキーボードを使用すると機能します(矢印と enter)

こちらも参照して下さい。[https://community.spotify.com/t5/Desktop-Linux/Settings-don-t-open-on-Linux/td-p/1478736]

=== 起動時にクラッシュする ===
起動時にアプリケーションがクラッシュし、次のエラーメッセージが表示された場合

[NNN:FATAL:gpu_data_manager_impl_private.cc(439)] GPU process isn't usable. Goodbye

{{ic|-no-zygote}} フラグを指定して {{ic|spotify}} を実行してみてください。

=== ローカルフォルダを追加すると Spotify がクラッシュする ===
Local Files オプション内の 'ソースを追加する' ボタンが Spotify をクラッシュさせた時。使用可能な回避策はこちらを参照 [https://www.reddit.com/r/archlinux/comments/knyfpo/how_to_play_local_files_with_spotify/ this reddit post] または、 [[Flatpak]] バージョンをインストールすることもできます。

=== /usr/lib/libcurl-gnutls.so.4 error ===

エラーが発生した場合:

spotify: /usr/lib/libcurl-gnutls.so.4: no version information available (required by spotify)

{{ic|~/.cache/spotify}} を削除します。

==参照==
*[https://github.com/acrisci/playerctl playerctl] — メディアプレーヤーを操作するためのコマンドラインユーティリティ・ライブラリ
*[[SpotCommander]] — Spotify のウェブベースのリモートコントロール
*[https://www.spotify.com/jp/download/linux/ Spotify for Linux] — Spotify の Linux クライアントのホームページ

WeChat

2025-03-24T03:27:18Z

Sanlun: 誤字の修正

[[Category:インターネットアプリケーション]]
[[en:WeChat]]
[[zh-hans:WeChat]]
{{Related articles start}}
{{Related|Wine}}
{{Related|Deepin-wine}}
{{Related articles end}}
世界中で 10 億人以上をつなぐ WeChat は、iOS、Android、Windows、MacOS、Linux で利用可能な無料のメッセージングおよび通話アプリです。

現在、WeChat は公式にいくつかのの Linux ディストリビューションに正式に対応しており(下記)、興味があれば他のディストリビューションでの互換状況をテストすることができます。

ネイティブ版のインストールの他に、この記事では異なる要求に応じた様々な方法での WeChat のインストールについて紹介します。

== ネイティブ Linux バージョン ==

{{note|現時点で最も推奨される方法です。}}

2024年3月、Tencent はクロスプラットフォームな WeChat (Universal) をリリースしました。Windows、Mac、Linux 版において機能と更新ペースの一致を段階的に実現することを目的としています。Tencent は公式に rpm、deb、appimage 形式でのパッケージを提供していますが、現在はまだリポジトリが実装されていないため、deb、rpm のユーザーはパッケージマネージャによる自動更新を利用できません。

WeChat は {{AUR|wechat-bin}}にパッケージ化されており、また WeChat にいくつか修正を加えた {{AUR|wechat}}パッケージとしても提供されています。後者にはプロセス管理、サンドボックス(オプション)、インプットメソッド、HiDPI の修正といった機能が含まれます。また [[Flatpak]] を利用して Flathubから {{ic|com.tencent.WeChat}} をインストールすることもできます。

{{AUR|wechat-universal-bwrap}} は基本的なサンドボックス化パッケージを提供します。これは元々今は存在しない {{AUR|wechat-uos-qt}} に基づいており、{{AUR|wechat-bin}} に依存しません。[https://github.com/Kraftland/portable portable]ではなく[[bubblewrap]]サンドボックスを利用しており、D-Busフィルタリングなどの機能を持たず、'''サンドボックス脱出のリスクがあります'''。

=== サンドボックス ===

{{AUR|wechat}} はオプションで[https://github.com/Kraftland/portable portable]サンドボックスを有効化できます。タスクバーアイコンを右クリックしてサンドボックス設定の変更、サンドボックスへのファイル送信、WeChat の完全終了が行えます。サンドボックスに送信されたファイルは永続ではなく、アプリケーションを再起動すると削除されます。

{{AUR|wechat}} のサンドボックスの正常動作には[[XDG デスクトップポータル]]が必要です。通常、デスクトップ環境(DE)を使用する際には特別な処理は必要ありませんが、ウィンドウマネージャのユーザーはドキュメントに従って自分で実装を選択する必要がある場合があります。

{{AUR|wechat-universal-bwrap}}は[[bubblewrap]]サンドボックスを使用し、{{ic|~/Documents/WeChat_Data/home}}をホームディレクトリとします。{{ic|~/.config/wechat-universal/binds.list}}を編集することで、更にコンテナに公開するファイルやディレクトリを一行一件ずつ設定することができます。WeChat ファイルのメインパスを{{ic|~/Documents/WeChat_Data}}以外のパスに変更するには、{{ic|WECHAT_DATA_DIR}}環境変数を設定して下さい。

=== インプットメソッドと HiDPI ===
{{AUR|wechat}} は自動で環境変数を設定してこれらの問題を回避します。ユーザーは引き続き{{ic|XMODIFIERS}}変数を正しく設定する必要があります。

=== 絵文字の表示 ===
{{AUR|ttf-twemoji}}をインストールし、{{AUR|wechat}}を1.0.0.241-27 以上のバージョンにアップデートして下さい。

== 仮想マシン ==

[[VMware]] や [[VirtualBox]] などの仮想マシンに Windows システムをインストールして、WeChat を使用することができます。

== Wine ==

{{note|現在、Wine ベースの WeChat のミニプログラム機能は利用できず、特定のサイズ以上の画像を送信することができません。詳細は [https://github.com/countstarlight/deepin-wine-wechat-arch/issues/42 こちら] を参照してください。}}

=== インストール ===

互換性レイヤー [[Wine]] を使用して Linux 内で WeChat を実行できます。

さらに、{{AUR|deepin-wine-wechat}}（パッチなし）も提供されており、これは Arch 用に設定された Wine コンテナです。WeChat のバージョンは最新の公式バージョンです。

==== archlinuxcn リポジトリから ====

使用中に WeChat のシャドウウィンドウが他のウィンドウの上に表示される場合は、[[archlinuxcn]] リポジトリの ''wine-for-wechat'' を使用してみることができます。この Wine バージョンは、WeChat のシャドウウィンドウ用の [https://github.com/archlinuxcn/repo/blob/master/archlinuxcn/wine-for-wechat/wine-wechat.patch パッチ]を使用しています。

さらに、''wine-wechat-setup'' を使用して WeChat をインストール、実行、設定することを推奨します。WeChat インストーラーは手動でダウンロードする必要があります。

==== Deepin-wine WeChat ====

{{AUR|com.qq.weixin.deepin}} パッケージをインストールするか、Spark Store から {{AUR|com.qq.weixin.spark}} をインストールします。Weixin Work のための他の deepin wine 関連パッケージとして {{AUR|com.qq.weixin.work.deepin-x11}} があります。詳細は [[Deepin-wine]] を参照してください。

==== コンテナで実行 ====

[https://github.com/huan/docker-wechat docker-wechat] は [[Docker]] コンテナ内で WeChat wine アプリケーションを実行します。

=== 設定 ===

==== HiDpi 設定 ====

高 dpi スクリーンでフォントが非常に小さい場合、wineのdpi設定を行います：

# winecfg を開く。例として {{AUR|deepin-wine-wechat}} を使用し、{{ic|WINEPREFIX}} と {{ic|deepin-wine6-stable}} を適宜変更します：{{bc|1=$ WINEPREFIX=~/.deepinwine/Deepin-WeChat/ deepin-wine6-stable winecfg}}
# Graphics タブをクリックし、''画面解像度'' を実際の dpi に変更します。
# WeChat を起動し、''システムスケールに適応'' (設定-->通用設定-->适配系统缩放比例) を有効にします。

== UOS用のElectronバージョン ==

{{AUR|wechat-uos}} は UOS 用の公式 electron を提供します。

{{Note|元々の UOS パッケージは UOS プロフェッショナルでのみ実行されます。この環境を模倣するために、このパッケージは {{ic|os-release}} および {{ic|lsb-release}} を [[bubblewrap]] を通じて変更します。
このパッケージは機能が少なく、基本的には Web 版 WeChat の流用です。ネイティブ版を使用することを推奨します。}}

WeChat

2025-03-24T03:26:05Z

Sanlun: 中国語版に基づきLinux版の記述を拡充

[[Category:インターネットアプリケーション]]
[[en:WeChat]]
[[zh-hans:WeChat]]
{{Related articles start}}
{{Related|Wine}}
{{Related|Deepin-wine}}
{{Related articles end}}
世界中で 10 億人以上をつなぐ WeChat は、iOS、Android、Windows、MacOS、Linux で利用可能な無料のメッセージングおよび通話アプリです。

現在、WeChat は公式にいくつかのの Linux ディストリビューションに正式に対応しており(下記)、興味があれば他のディストリビューションでの互換状況をテストすることができます。

ネイティブ版のインストールの他に、この記事では異なる要求に応じた様々な方法での WeChat のインストールについて紹介します。

== ネイティブ Linux バージョン ==

{{note|現時点で最も推奨される方法です。}}

2024年3月、Tencent はクロスプラットフォームな WeChat (Universal) をリリースしました。Windows、Mac、Linux 版において機能と更新ペースの一致を段階的に実現することを目的としています。Tencent は公式に rpm、deb、appimage 形式でのパッケージを提供していますが、現在はまだリポジトリが実装されていないため、dep、rpm のユーザーはパッケージマネージャによる自動更新を利用できません。

WeChat は {{AUR|wechat-bin}}にパッケージ化されており、また WeChat にいくつか修正を加えた {{AUR|wechat}}パッケージとしても提供されています。後者にはプロセス管理、サンドボックス(オプション)、インプットメソッド、HiDPI の修正といった機能が含まれます。また [[Flatpak]] を利用して Flathubから {{ic|com.tencent.WeChat}} をインストールすることもできます。

{{AUR|wechat-universal-bwrap}} は基本的なサンドボックス化パッケージを提供します。これは元々今は存在しない {{AUR|wechat-uos-qt}} に基づいており、{{AUR|wechat-bin}} に依存しません。[https://github.com/Kraftland/portable portable]ではなく[[bubblewrap]]サンドボックスを利用しており、D-Busフィルタリングなどの機能を持たず、'''サンドボックス脱出のリスクがあります'''。

=== サンドボックス ===

{{AUR|wechat}} はオプションで[https://github.com/Kraftland/portable portable]サンドボックスを有効化できます。タスクバーアイコンを右クリックしてサンドボックス設定の変更、サンドボックスへのファイル送信、WeChat の完全終了が行えます。サンドボックスに送信されたファイルは永続ではなく、アプリケーションを再起動すると削除されます。

{{AUR|wechat}} のサンドボックスの正常動作には[[XDG デスクトップポータル]]が必要です。通常、デスクトップ環境(DE)を使用する際には特別な処理は必要ありませんが、ウィンドウマネージャのユーザーはドキュメントに従って自分で実装を選択する必要がある場合があります。

{{AUR|wechat-universal-bwrap}}は[[bubblewrap]]サンドボックスを使用し、{{ic|~/Documents/WeChat_Data/home}}をホームディレクトリとします。{{ic|~/.config/wechat-universal/binds.list}}を編集することで、更にコンテナに公開するファイルやディレクトリを一行一件ずつ設定することができます。WeChat ファイルのメインパスを{{ic|~/Documents/WeChat_Data}}以外のパスに変更するには、{{ic|WECHAT_DATA_DIR}}環境変数を設定して下さい。

=== インプットメソッドと HiDPI ===
{{AUR|wechat}} は自動で環境変数を設定してこれらの問題を回避します。ユーザーは引き続き{{ic|XMODIFIERS}}変数を正しく設定する必要があります。

=== 絵文字の表示 ===
{{AUR|ttf-twemoji}}をインストールし、{{AUR|wechat}}を1.0.0.241-27 以上のバージョンにアップデートして下さい。

== 仮想マシン ==

[[VMware]] や [[VirtualBox]] などの仮想マシンに Windows システムをインストールして、WeChat を使用することができます。

== Wine ==

{{note|現在、Wine ベースの WeChat のミニプログラム機能は利用できず、特定のサイズ以上の画像を送信することができません。詳細は [https://github.com/countstarlight/deepin-wine-wechat-arch/issues/42 こちら] を参照してください。}}

=== インストール ===

互換性レイヤー [[Wine]] を使用して Linux 内で WeChat を実行できます。

さらに、{{AUR|deepin-wine-wechat}}（パッチなし）も提供されており、これは Arch 用に設定された Wine コンテナです。WeChat のバージョンは最新の公式バージョンです。

==== archlinuxcn リポジトリから ====

使用中に WeChat のシャドウウィンドウが他のウィンドウの上に表示される場合は、[[archlinuxcn]] リポジトリの ''wine-for-wechat'' を使用してみることができます。この Wine バージョンは、WeChat のシャドウウィンドウ用の [https://github.com/archlinuxcn/repo/blob/master/archlinuxcn/wine-for-wechat/wine-wechat.patch パッチ]を使用しています。

さらに、''wine-wechat-setup'' を使用して WeChat をインストール、実行、設定することを推奨します。WeChat インストーラーは手動でダウンロードする必要があります。

==== Deepin-wine WeChat ====

{{AUR|com.qq.weixin.deepin}} パッケージをインストールするか、Spark Store から {{AUR|com.qq.weixin.spark}} をインストールします。Weixin Work のための他の deepin wine 関連パッケージとして {{AUR|com.qq.weixin.work.deepin-x11}} があります。詳細は [[Deepin-wine]] を参照してください。

==== コンテナで実行 ====

[https://github.com/huan/docker-wechat docker-wechat] は [[Docker]] コンテナ内で WeChat wine アプリケーションを実行します。

=== 設定 ===

==== HiDpi 設定 ====

高 dpi スクリーンでフォントが非常に小さい場合、wineのdpi設定を行います：

# winecfg を開く。例として {{AUR|deepin-wine-wechat}} を使用し、{{ic|WINEPREFIX}} と {{ic|deepin-wine6-stable}} を適宜変更します：{{bc|1=$ WINEPREFIX=~/.deepinwine/Deepin-WeChat/ deepin-wine6-stable winecfg}}
# Graphics タブをクリックし、''画面解像度'' を実際の dpi に変更します。
# WeChat を起動し、''システムスケールに適応'' (設定-->通用設定-->适配系统缩放比例) を有効にします。

== UOS用のElectronバージョン ==

{{AUR|wechat-uos}} は UOS 用の公式 electron を提供します。

{{Note|元々の UOS パッケージは UOS プロフェッショナルでのみ実行されます。この環境を模倣するために、このパッケージは {{ic|os-release}} および {{ic|lsb-release}} を [[bubblewrap]] を通じて変更します。
このパッケージは機能が少なく、基本的には Web 版 WeChat の流用です。ネイティブ版を使用することを推奨します。}}